Spring Boot文档阅读笔记-构建SOAP的web Service服务

落日映苍穹つ 2022-11-28 13:45 121阅读 0赞

这里使用的Maven，Java 8来操作的。

Maven相关代码为：

<dependencies>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>wsdl4j</groupId>
                <artifactId>wsdl4j</artifactId>
                <version>1.6.1</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.ws</groupId>
                <artifactId>spring-ws-core</artifactId>
                <version>3.0.8.RELEASE</version>
            </dependency>
    
        </dependencies>

buid里面要添加一个插件：

<build>
            <plugins>
    
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
    
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>jaxb2-maven-plugin</artifactId>
                    <version>2.5.0</version>
                    <executions>
                        <execution>
                            <id>xjc</id>
                            <goals>
                                <goal>xjc</goal>
                            </goals>
                        </execution>
                    </executions>
                    <configuration>
                        <sources>
                            <source>${project.basedir}/src/main/resources/countries.xsd</source>
                        </sources>
                    </configuration>
                </plugin>
    
            </plugins>
        </build>

这里要创建一个xml，通过这个xml生成对应的Object

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70][]

这里countries.xsd为：

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://it1995.com/example/demo"
               targetNamespace="http://it1995.com/example/demo" elementFormDefault="qualified">
    
        <xs:element name="getCountryRequest">
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="name" type="xs:string"/>
                </xs:sequence>
            </xs:complexType>
        </xs:element>
    
        <xs:element name="getCountryResponse">
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="country" type="tns:country"/>
                </xs:sequence>
            </xs:complexType>
        </xs:element>
    
        <xs:complexType name="country">
            <xs:sequence>
                <xs:element name="name" type="xs:string"/>
                <xs:element name="population" type="xs:int"/>
                <xs:element name="capital" type="xs:string"/>
                <xs:element name="currency" type="tns:currency"/>
            </xs:sequence>
        </xs:complexType>
    
        <xs:simpleType name="currency">
            <xs:restriction base="xs:string">
                <xs:enumeration value="GBP"/>
                <xs:enumeration value="EUR"/>
                <xs:enumeration value="PLN"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:schema>

其中target/jaxb/com/it1995/example/demo是这样生成的：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 1][]

其中这个文件路径是xsd文件xmlns:tns，targetNamespace

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 2][]

xmlns:tns和targetNamespace生成对应的包。

下面是关于各个文件的分析：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 3][]

CountryRepository.java：存储城市的数据，为webService提供数据。

CountryEndpoint.java：创建服务端，需要使用到POJO类及少量的Spring WS注解处理SOAP的请求。

其中：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 4][]

其中NAMESPACE\_URL为XML里面的xmlns:tns，targetNamespace。其中里面涉及几个注解：

@Endpoint：将此类注册为Spring WS的候选类，用于接收SOAP消息；

@PayloadRoot：这个也是Spring WS的注解作用在方法上其中namespace填写xml的namespace，而localpart填写xml中作用的方法；

@RequestPayload：方法中参数的注解，将SOAP传过来的数据映射到参数中；

@ResponsePayload：返回响应数据。

WebServiceConfig.java：配置Spring WS相关的配置Bean

@EnableWs
    @Configuration
    public class WebServiceConfig extends WsConfigurerAdapter {
    
        @Bean
        public ServletRegistrationBean messageDispatcherServlet(ApplicationContext applicationContext) {
    
            MessageDispatcherServlet servlet = new MessageDispatcherServlet();
            servlet.setApplicationContext(applicationContext);
            servlet.setTransformWsdlLocations(true);
            return new ServletRegistrationBean(servlet, "/ws/*");
        }
    
        @Bean(name = "countries")
        public DefaultWsdl11Definition defaultWsdl11Definition(XsdSchema countriesSchema) {
    
            DefaultWsdl11Definition wsdl11Definition = new DefaultWsdl11Definition();
            wsdl11Definition.setPortTypeName("CountriesPort");
            wsdl11Definition.setLocationUri("/ws");
            wsdl11Definition.setTargetNamespace("http://it1995.com/example/demo");
            wsdl11Definition.setSchema(countriesSchema);
            return wsdl11Definition;
        }
    
        @Bean
        public XsdSchema countriesSchema() {
    
            return new SimpleXsdSchema(new ClassPathResource("countries.xsd"));
        }
    }

Spring WS有自己的servlet用于处理SOAP消息。上面的MessageDispatcherServlet十分重要，他将ApplicatoinContext注入到了MessageDispatcherServlet。并且这个Bean并不会影响Spring 的默认Bean。

程序运行截图如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 5][]

源码打包下载地址：

[https://github.com/fengfanchen/Java/tree/master/SOAPWebProduction][https_github.com_fengfanchen_Java_tree_master_SOAPWebProduction]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70]: /images/20221124/222fad6479a8469aa7b7cfb5ecf5afbf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 1]: /images/20221124/efdb67f1432c4cdc9ab75a9b878d88f2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 2]: /images/20221124/fa8f397d98bf4253b7db73d24e5cb811.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 3]: /images/20221124/dc788a9c4f2d4444be2629cf3033fa08.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 4]: /images/20221124/c191e9762b194fac89c846c898b0ac92.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70 5]: /images/20221124/e62ac2f96a58438db6c01cd5cbe3a3c6.png
[https_github.com_fengfanchen_Java_tree_master_SOAPWebProduction]: https://github.com/fengfanchen/Java/tree/master/SOAPWebProduction