Spring Boot SOAP Webservice 案例

短命女 2023-06-07 10:52 15阅读 0赞

# 1. 技术栈 #

jdk1.8、idea、maven----开发环境  
springboot----应用框架  
wsdl4j----为我们的服务发布wsdl  
JAXB maven plugin — 代码生成  
postman—用于测试我们的服务

# 2. 具体操作 #

1.  pom.xml中加入依赖：

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

1.  创建SOAP模型以及生成java代码  
    简单起见，我们将请求和响应都保留在同一个xsd中。

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="https://www.howtodoinjava.com/xml/school" targetNamespace="https://www.howtodoinjava.com/xml/school" elementFormDefault="qualified">
    
        <xs:element name="StudentDetailsRequest">
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="name" type="xs:string"/>
                </xs:sequence>
            </xs:complexType>
        </xs:element>
    
        <xs:element name="StudentDetailsResponse">
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="Student" type="tns:Student"/>
                </xs:sequence>
            </xs:complexType>
        </xs:element>
    
        <xs:complexType name="Student">
            <xs:sequence>
                <xs:element name="name" type="xs:string"/>
                <xs:element name="standard" type="xs:int"/>
                <xs:element name="address" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    
    </xs:schema>

将上述student.xsd放在resources文件夹中

1.  添加JAXB maven插件，将XSD转换成java对象  
    使用jaxb2-maven-plugn生成java类，我们先需要在pom.xml的插件部分添加以下maven插件：

<plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>jaxb2-maven-plugin</artifactId>
        <version>1.6</version>
        <executions>
            <execution>
                <id>xjc</id>
                <goals>
                    <goal>xjc</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
            <schemaDirectory>${project.basedir}/src/main/resources/</schemaDirectory>
            <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
            <clearOutputDir>false</clearOutputDir>
        </configuration>
    </plugin>

该插件使用XJC工具作为代码生成引擎。XJC将XML文件编译为注释版的Java类。  
执行该maven插件，从XSD生成Java代码。

1.  创建SOAP Webservice Endpoint  
    StudentEndpoint类将处理所有的传入请求

package com.example.howtodoinjava.springbootsoapservice;
     
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.ws.server.endpoint.annotation.Endpoint;
    import org.springframework.ws.server.endpoint.annotation.PayloadRoot;
    import org.springframework.ws.server.endpoint.annotation.RequestPayload;
    import org.springframework.ws.server.endpoint.annotation.ResponsePayload;
    import com.howtodoinjava.xml.school.StudentDetailsRequest;
    import com.howtodoinjava.xml.school.StudentDetailsResponse;
     
    @Endpoint
    public class StudentEndpoint
    { 
        private static final String NAMESPACE_URI = "https://www.howtodoinjava.com/xml/school";
     
        private StudentRepository StudentRepository;
     
        @Autowired
        public StudentEndpoint(StudentRepository StudentRepository) { 
            this.StudentRepository = StudentRepository;
        }
     
        @PayloadRoot(namespace = NAMESPACE_URI, localPart = "StudentDetailsRequest")
        @ResponsePayload
        public StudentDetailsResponse getStudent(@RequestPayload StudentDetailsRequest request) { 
            StudentDetailsResponse response = new StudentDetailsResponse();
            response.setStudent(StudentRepository.findStudent(request.getName()));
     
            return response;
        }
    }

注解解释  
(1)、@Endpoint—向Spring WS注册该类，可以处理传入的SOAP消息；  
(2)、@PayloadRoot—Spring WS基于消息的namespace和localPart去选择处理方法。请在这个注解中指明namespace的url以及请求的localPart；  
(3)、@RequestPayload---- 传入的message将被映射成方法的请求参数；  
(4)、@ResponsePayload— 这个注解使得Spring WS映射返回值来响应payload。

1.  创建数据存储库

package com.example.howtodoinjava.springbootsoapservice;
     
    import java.util.HashMap;
    import java.util.Map;
    import javax.annotation.PostConstruct;
    import org.springframework.stereotype.Component;
    import org.springframework.util.Assert;
    import com.howtodoinjava.xml.school.Student;
     
    @Component
    public class StudentRepository { 
        private static final Map<String, Student> students = new HashMap<>();
     
        @PostConstruct
        public void initData() { 
             
            Student student = new Student();
            student.setName("Sajal");
            student.setStandard(5);
            student.setAddress("Pune");
            students.put(student.getName(), student);
             
            student = new Student();
            student.setName("Kajal");
            student.setStandard(5);
            student.setAddress("Chicago");
            students.put(student.getName(), student);
             
            student = new Student();
            student.setName("Lokesh");
            student.setStandard(6);
            student.setAddress("Delhi");
            students.put(student.getName(), student);
             
            student = new Student();
            student.setName("Sukesh");
            student.setStandard(7);
            student.setAddress("Noida");
            students.put(student.getName(), student);
        }
     
        public Student findStudent(String name) { 
            Assert.notNull(name, "The Student's name must not be null");
            return students.get(name);
        }
    }

注解说明：  
@PostConstruct----修饰的方法会在服务器加载Servle的时候运行，并且只会被服务器执行一次，可以起到初始化的作用。

1.  添加SOAP Webservice Configuration Beans

package com.example.howtodoinjava.springbootsoapservice;
     
    import org.springframework.boot.web.servlet.ServletRegistrationBean;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.io.ClassPathResource;
    import org.springframework.ws.config.annotation.EnableWs;
    import org.springframework.ws.config.annotation.WsConfigurerAdapter;
    import org.springframework.ws.transport.http.MessageDispatcherServlet;
    import org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition;
    import org.springframework.xml.xsd.SimpleXsdSchema;
    import org.springframework.xml.xsd.XsdSchema;
     
    @EnableWs
    @Configuration
    public class Config extends WsConfigurerAdapter
    { 
        @Bean
        public ServletRegistrationBean messageDispatcherServlet(ApplicationContext applicationContext)
        { 
            MessageDispatcherServlet servlet = new MessageDispatcherServlet();
            servlet.setApplicationContext(applicationContext);
            servlet.setTransformWsdlLocations(true);
            return new ServletRegistrationBean(servlet, "/service/*");
        }
     
        @Bean(name = "studentDetailsWsdl")
        public DefaultWsdl11Definition defaultWsdl11Definition(XsdSchema countriesSchema)
        { 
            DefaultWsdl11Definition wsdl11Definition = new DefaultWsdl11Definition();
            wsdl11Definition.setPortTypeName("StudentDetailsPort");
            wsdl11Definition.setLocationUri("/service/student-details");
            wsdl11Definition.setTargetNamespace("https://www.howtodoinjava.com/xml/school");
            wsdl11Definition.setSchema(countriesSchema);
            return wsdl11Definition;
        }
     
        @Bean
        public XsdSchema countriesSchema()
        { 
            return new SimpleXsdSchema(new ClassPathResource("school.xsd"));
        }
    }

说明：  
(1)、MessageDispatcherServlet — Spring WS使用它来处理SOAP请求。我们需要注入ApplicationContext给这个servlet，这样Spring WS可以找到其他bean。它也声明了请求的URL映射；  
(2)、DefaultWsdl11Definition — 使用xsdschema暴露一个标准的WSDL1.1。这个bean的名字"studentDetailsWsdl"将是暴露的wsdl的名字。我们可以通过http://localhost:8080/service/studentDetailsWsdl.wsdl 去访问

1.  启动测试  
    (1)、查看WSDL是否正常：  
    浏览器访问: http://localhost:8080/service/studentDetailsWsdl.wsdl  
    (2)、一旦成功生成了WSDL，我们就可以使用该WSDL在postman中进行测试：  
    a)、postman  
    请求方式:post  
    请求路径：http://localhost:8080/service/student-details  
    ***(注意此处设置Headers中Content-Type=“text/xml;charset=utf-8” ,否则报错)***  
    b)、请求体

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="https://www.howtodoinjava.com/xml/school">
       <soapenv:Header/>
       <soapenv:Body>
          <sch:StudentDetailsRequest>
             <sch:name>Sajal</sch:name>
          </sch:StudentDetailsRequest>
       </soapenv:Body>
    </soapenv:Envelope>

c)、响应

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
       <SOAP-ENV:Header/>
       <SOAP-ENV:Body>
          <ns2:StudentDetailsResponse xmlns:ns2="https://www.howtodoinjava.com/xml/school">
             <ns2:Student>
                <ns2:name>Sajal</ns2:name>
                <ns2:standard>5</ns2:standard>
                <ns2:address>Pune</ns2:address>
             </ns2:Student>
          </ns2:StudentDetailsResponse>
       </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>