本指南将引导您完成使用Spring创建基于SOAP的Web服务服务器的过程。

你会建立什么

您将使用基于WSDL的SOAP Web服务构建一个服务器来公开来自欧洲各个国家的数据。

为了简化示例，您将使用英国，西班牙和波兰的硬编码数据。

你需要什么

如何完成本指南

像大多数Spring 入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用工作代码。

要从头开始 ，请继续使用Gradle构建 。

要跳过基础知识 ，请执行以下操作：

完成后 ，您可以根据中的代码检查结果gs-soap-service/complete 。

用Gradle构建

用Gradle构建

首先，您设置一个基本的构建脚本。在使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含使用Gradle和Maven所需的代码。如果您都不熟悉，请参阅使用Gradle 构建Java项目或使用Maven构建Java项目 。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

创建一个Gradle构建文件

以下是最初的Gradle构建文件 。

build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.1.6.RELEASE")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-producing-web-service'
    version =  '0.1.0'
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
}

Spring Boot gradle插件提供了许多方便的功能：

  • 它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。

  • 它搜索public static void main()标记为可运行类的方法。

  • 它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项 。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

用Maven构建

用Maven构建

首先，您设置一个基本的构建脚本。使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含了使用Maven所需的代码。如果您不熟悉Maven，请参阅使用Maven 构建Java项目 。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.springframework</groupId>
    <artifactId>gs-producting-web-service</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Spring Boot Maven插件提供了许多方便的功能：

  • 它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。

  • 它搜索public static void main()标记为可运行类的方法。

  • 它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项 。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

使用您的IDE进行构建

使用您的IDE进行构建

添加Spring-WS依赖项

您创建的项目需要包括spring-ws-core作为构建文件以及wsdl4j中的依赖项。

对于行家：

Unresolved directive in <stdin> - include::complete/pom.xml[tags=springws]

对于gradle：

Unresolved directive in <stdin> - include::complete/build.gradle[tags=dependencies]

创建一个XML模式来定义域

Web服务域是在XML模式文件（XSD）中定义的，Spring-WS将自动将其导出为WSDL。

使用操作返回一个国家的名称 ， 人口 ， 资本和货币来创建一个XSD文件：

src/main/resources/countries.xsd

Unresolved directive in <stdin> - include::complete/src/main/resources/countries.xsd[]

根据XML模式生成域类

下一步是从XSD文件生成Java类。正确的方法是在构建期间使用Maven或Gradle插件自动执行此操作。

Maven的插件配置：

Unresolved directive in <stdin> - include::complete/pom.xml[tags=xsd]

生成的类放在target/generated-sources/jaxb/目录。

要使用gradle进行相同的操作，首先需要在构建文件中配置JAXB：

Unresolved directive in <stdin> - include::complete/build.gradle[tags=jaxb]
上面的构建文件有tag和end评论。这样可以更轻松地将其提取到本指南中，以进行更详细的说明。您自己的构建文件中不需要这些注释。

下一步是添加任务genJaxb gradle用于生成Java类：

Unresolved directive in <stdin> - include::complete/build.gradle[tags=xsd]

由于gradle还没有JAXB插件，因此它涉及到ant任务，这使其比maven更加复杂。

在这两种情况下，JAXB域对象生成过程都已连接到构建工具的生命周期中，因此没有多余的步骤可运行。

创建国家资料库

为了向Web服务提供数据，请创建国家/地区存储库。在本指南中，您将创建一个包含硬编码数据的虚拟国家/地区存储库实现。

Unresolved directive in <stdin> - include::complete/src/main/java/hello/CountryRepository.java[]

创建国家服务端点

要创建服务端点，只需要一个带有一些Spring WS批注的POJO即可处理传入的SOAP请求。

Unresolved directive in <stdin> - include::complete/src/main/java/hello/CountryEndpoint.java[]

@Endpoint向Spring WS注册该类，作为处理传入SOAP消息的潜在候选者。

@PayloadRoot然后由WS使用WS来基于消息的名称空间和localPart选择处理程序方法。

@RequestPayload表示传入的消息将被映射到方法的request参数。

的@ResponsePayload注释使Spring WS将返回的值映射到响应有效负载。

在所有这些代码块中， io.spring.guides除非您已运行任务以基于WSDL生成域类，否则这些类将在您的IDE中报告编译时错误。

配置Web服务Bean

使用与Spring WS相关的bean配置创建一个新类：

Unresolved directive in <stdin> - include::complete/src/main/java/hello/WebServiceConfig.java[]

请务必注意，您需要为MessageDispatcherServlet和DefaultWsdl11Definition 。Bean名称确定URL，Web服务和生成的WSDL文件可在该URL下使用。在这种情况下，WSDL将在http://:/ws/countries.wsdl 。

此配置还使用WSDL位置servlet转换servlet.setTransformWsdlLocations(true) 。如果您访问http：// localhost：8080 / ws / countries.wsdl ，则soap:address将有正确的地址。如果您改为从分配给计算机的面向公众的IP地址访问WSDL，则会看到该地址。

使应用程序可执行

尽管可以将该服务打包为传统的WAR文件以部署到外部应用程序服务器，但是下面演示的更简单的方法创建了一个独立的应用程序。您将所有内容打包在一个可运行的JAR文件中，由一个好的旧Java驱动main()方法。在此过程中，您将使用Spring的支持将Tomcat Servlet容器作为HTTP运行时嵌入，而不是部署到外部实例。

src/main/java/hello/Application.java

Unresolved directive in <stdin> - include::complete/src/main/java/hello/Application.java[]

@SpringBootApplication是一个方便注释，它添加了以下所有内容：

  • @Configuration ：将类标记为应用程序上下文的Bean定义的源。

  • @EnableAutoConfiguration ：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。例如，如果spring-webmvc在类路径上，此注释将应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet 。

  • @ComponentScan ：告诉Spring在其中寻找其他组件，配置和服务hello包，让它找到控制器。

的main()方法使用Spring Boot的SpringApplication.run()启动应用程序的方法。您是否注意到没有一行XML？没有web.xml文件。该Web应用程序是100％纯Java，因此您无需处理任何管道或基础结构。

构建可执行的JAR

您可以使用Gradle或Maven从命令行运行该应用程序。您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。构建可执行的jar使得在整个开发生命周期中，跨不同环境等等的情况下，可以轻松地将服务作为应用程序进行发布，版本化和部署。

如果您使用Gradle，则可以使用./gradlew bootRun 。或者，您可以通过使用以下命令构建JAR文件： ./gradlew build然后运行JAR文件，如下所示：

java -jar build/libs/gs-soap-service-0.1.0.jar

如果使用Maven，则可以通过使用以下命令运行应用程序./mvnw spring-boot:run 。或者，您可以使用以下命令构建JAR文件： ./mvnw clean package然后运行JAR文件，如下所示：

java -jar target/gs-soap-service-0.1.0.jar
此处描述的步骤将创建可运行的JAR。您还可以构建经典的WAR文件 。

显示日志记录输出。该服务应在几秒钟内启动并运行。

测试应用

现在该应用程序正在运行，您可以对其进行测试。建立档案request.xml包含以下SOAP请求：

Unresolved directive in <stdin> - include::complete/request.xml[]

在测试SOAP接口时，有一些选择。您可以使用SoapUI之类的工具，也可以使用命令行工具（如果位于* nix / Mac系统上），如下所示。

$ curl --header "content-type: text/xml" -d @request.xml http://localhost:8080/ws

结果，您应该看到以下响应：

<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:getCountryResponse xmlns:ns2="http://spring.io/guides/gs-producing-web-service">
      <ns2:country>
        <ns2:name>Spain</ns2:name>
        <ns2:population>46704314</ns2:population>
        <ns2:capital>Madrid</ns2:capital>
        <ns2:currency>EUR</ns2:currency>
      </ns2:country>
    </ns2:getCountryResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
可能的是，输出将是一个紧凑的XML文档，而不是上面显示的格式良好的文档。如果您的系统上安装了xmllib2，则可以curl -s | xmllint --format -看到格式很好的结果。

摘要

恭喜你！您已经使用Spring Web Services开发了基于SOAP的服务。

也可以看看

以下指南也可能会有所帮助：

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则 。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创作共用许可证发布 。