spring boot 開發(fā)soap webservice的實(shí)現(xiàn)代碼
更新時(shí)間：2019年01月06日 09:32:14 作者：wls1036
這篇文章主要介紹了spring boot 開發(fā)soap webservice的實(shí)現(xiàn)代碼，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧
介紹
spring boot web模塊提供了RestController實(shí)現(xiàn)restful，第一次看到這個(gè)名字的時(shí)候以為還有SoapController，很可惜沒有，對(duì)于soap webservice提供了另外一個(gè)模塊spring-boot-starter-web-services支持。本文介紹如何在spring boot中開發(fā)soap webservice接口，以及接口如何同時(shí)支持soap和restful兩種協(xié)議。
soap webservice
Web service是一個(gè)平臺(tái)獨(dú)立的，低耦合的，自包含的、基于可編程的web的應(yīng)用程序，既可以是soap webservice也可以是rest webservice，在rest還沒出來之前，我們說webservice一般是指基于soap協(xié)議進(jìn)行通信的web應(yīng)用程序。
在開始之前，我覺得有必要了解下soap webservice，具體的概念網(wǎng)上可以找到很多資料，但網(wǎng)上資料概念性較強(qiáng)，而且soap協(xié)議使用的是xml進(jìn)行通信，相信xml里面一個(gè)namespace就能嚇跑一大堆人，所以這里不討論具體的soap協(xié)議細(xì)節(jié)，我想通過一個(gè)例子來說明什么是soap webservice，通過該例子，你能了解soap webservice其運(yùn)作原理，當(dāng)然如果你覺得你對(duì)這個(gè)已經(jīng)很了解了，大可跳過本章節(jié)，本章節(jié)跟后面的內(nèi)容沒有任何關(guān)系。
假設(shè)我們開發(fā)了一個(gè)web接口，想給別人用，我們要怎么辦
- 部署接口到服務(wù)器
- 編寫接口文檔，寫清楚接口是通過什么方法調(diào)的，輸入?yún)?shù)是什么，輸出參數(shù)是什么，錯(cuò)誤時(shí)返回什么。
那問題來了，我們能不能只把接口部署到服務(wù)器上，然后接口不單能提供具體的服務(wù)，而且還能自動(dòng)生成一份標(biāo)準(zhǔn)的接口文檔，把接口信息都記錄在該文檔里，如果能做到，是不是能做到"接口即文檔"的目的。
那么一個(gè)接口的信息包括哪些呢？
- 接口地址
- 接口調(diào)用方法
- 接口輸入?yún)?shù)
- 接口輸出參數(shù)
- 接口出錯(cuò)返回信息
- ....
soap webservice里wsdl文件就是接口描述信息。核心的信息就是以上幾個(gè)。
第二個(gè)問題，由于Web service是一個(gè)平臺(tái)獨(dú)立，也就是說，使用接口的人不知道這個(gè)service是用什么技術(shù)開發(fā)的，可能是php可能是java等，但接口的參數(shù)和返回的數(shù)據(jù)都是一樣的，要達(dá)到這種目的，就需要兩個(gè)東西，一個(gè)是跟平臺(tái)無關(guān)的數(shù)據(jù)格式，soap使用的是xml，一個(gè)是通信協(xié)議，也就是soap協(xié)議。
下面就介紹如何不使用任何框架，僅通過servlet實(shí)現(xiàn)一個(gè)webservice。該webservice功能很簡(jiǎn)單，就是通過一個(gè)人的姓名查詢這個(gè)人的詳細(xì)信息。
ps：servlet是java web的基礎(chǔ)，理解servlet對(duì)理解整個(gè)java web非常重要，沒寫過servlet就開始用各種框架寫接口就是在胡鬧。
1. wsdl文件
準(zhǔn)備以下wsdl文件，不要管這個(gè)文件是怎么來的，是怎么生成的，我們這次只講原理，不談細(xì)節(jié)，總之，你根據(jù)需求寫出了這個(gè)wsdl文件。
<?xml version="1.0" encoding="UTF-8" standalone="no"?><wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:sch="http://www.definesys.com/xml/employee" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://www.definesys.com/xml/employee" targetNamespace="http://www.definesys.com/xml/employee">
<wsdl:types>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://www.definesys.com/xml/employee">
<xs:element name="EmployeeDetailRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="EmployeeDetailResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="Employee" type="tns:Employee"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="Employee">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="email" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
</wsdl:types>
<wsdl:message name="EmployeeDetailRequest">
<wsdl:part element="tns:EmployeeDetailRequest" name="EmployeeDetailRequest">
</wsdl:part>
</wsdl:message>
<wsdl:message name="EmployeeDetailResponse">
<wsdl:part element="tns:EmployeeDetailResponse" name="EmployeeDetailResponse">
</wsdl:part>
</wsdl:message>
<wsdl:portType name="Employee">
<wsdl:operation name="EmployeeDetail">
<wsdl:input message="tns:EmployeeDetailRequest" name="EmployeeDetailRequest">
</wsdl:input>
<wsdl:output message="tns:EmployeeDetailResponse" name="EmployeeDetailResponse">
</wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="EmployeeSoap11" type="tns:Employee">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="EmployeeDetail">
<soap:operation soapAction=""/>
<wsdl:input name="EmployeeDetailRequest">
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output name="EmployeeDetailResponse">
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="EmployeeService">
<wsdl:port binding="tns:EmployeeSoap11" name="EmployeeSoap11">
<soap:address location="http://localhost:8081/ws-servlet/ws/employee-detail"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
soap:address location里面端口號(hào)需要修改為servlet運(yùn)行的端口號(hào)。
從以下xml片段可以看出
...
<wsdl:binding name="EmployeeSoap11" type="tns:Employee">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="EmployeeDetail">
<soap:operation soapAction=""/>
<wsdl:input name="EmployeeDetailRequest">
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output name="EmployeeDetailResponse">
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="EmployeeService">
<wsdl:port binding="tns:EmployeeSoap11" name="EmployeeSoap11">
<soap:address location="http://localhost:8081/ws-servlet/ws/employee-detail"/>
</wsdl:port>
</wsdl:service>
- 接口名稱是EmployeeDetail(wsdl:operation)
- 接口輸入?yún)?shù)是EmployeeDetailRequest(wsdl:input)
- 接口輸出參數(shù)是EmployeeDetailResponse(wsdl:output)
- 接口地址是http://localhost:8081/ws-servlet/ws/employee-detail(soap:address)
2. 獲取wsdl文件servlet
package com.definesys.demo.servlet;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午1:45
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
public class WsdlServlet extends HttpServlet {
public static final String WSDL_XML = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><wsdl:definitions xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:sch=\"http://www.definesys.com/xml/employee\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tns=\"http://www.definesys.com/xml/employee\" targetNamespace=\"http://www.definesys.com/xml/employee\">\n" +
" <wsdl:types>\n" +
" <xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\" elementFormDefault=\"qualified\" targetNamespace=\"http://www.definesys.com/xml/employee\">\n" +
"\n" +
" <xs:element name=\"EmployeeDetailRequest\">\n" +
" <xs:complexType>\n" +
" <xs:sequence>\n" +
" <xs:element name=\"name\" type=\"xs:string\"/>\n" +
" </xs:sequence>\n" +
" </xs:complexType>\n" +
" </xs:element>\n" +
"\n" +
" <xs:element name=\"EmployeeDetailResponse\">\n" +
" <xs:complexType>\n" +
" <xs:sequence>\n" +
" <xs:element name=\"Employee\" type=\"tns:Employee\"/>\n" +
" </xs:sequence>\n" +
" </xs:complexType>\n" +
" </xs:element>\n" +
"\n" +
" <xs:complexType name=\"Employee\">\n" +
" <xs:sequence>\n" +
" <xs:element name=\"name\" type=\"xs:string\"/>\n" +
" <xs:element name=\"email\" type=\"xs:string\"/>\n" +
" </xs:sequence>\n" +
" </xs:complexType>\n" +
"\n" +
"</xs:schema>\n" +
" </wsdl:types>\n" +
" <wsdl:message name=\"EmployeeDetailRequest\">\n" +
" <wsdl:part element=\"tns:EmployeeDetailRequest\" name=\"EmployeeDetailRequest\">\n" +
" </wsdl:part>\n" +
" </wsdl:message>\n" +
" <wsdl:message name=\"EmployeeDetailResponse\">\n" +
" <wsdl:part element=\"tns:EmployeeDetailResponse\" name=\"EmployeeDetailResponse\">\n" +
" </wsdl:part>\n" +
" </wsdl:message>\n" +
" <wsdl:portType name=\"Employee\">\n" +
" <wsdl:operation name=\"EmployeeDetail\">\n" +
" <wsdl:input message=\"tns:EmployeeDetailRequest\" name=\"EmployeeDetailRequest\">\n" +
" </wsdl:input>\n" +
" <wsdl:output message=\"tns:EmployeeDetailResponse\" name=\"EmployeeDetailResponse\">\n" +
" </wsdl:output>\n" +
" </wsdl:operation>\n" +
" </wsdl:portType>\n" +
" <wsdl:binding name=\"EmployeeSoap11\" type=\"tns:Employee\">\n" +
" <soap:binding style=\"document\" transport=\"http://schemas.xmlsoap.org/soap/http\"/>\n" +
" <wsdl:operation name=\"EmployeeDetail\">\n" +
" <soap:operation soapAction=\"\"/>\n" +
" <wsdl:input name=\"EmployeeDetailRequest\">\n" +
" <soap:body use=\"literal\"/>\n" +
" </wsdl:input>\n" +
" <wsdl:output name=\"EmployeeDetailResponse\">\n" +
" <soap:body use=\"literal\"/>\n" +
" </wsdl:output>\n" +
" </wsdl:operation>\n" +
" </wsdl:binding>\n" +
" <wsdl:service name=\"EmployeeService\">\n" +
" <wsdl:port binding=\"tns:EmployeeSoap11\" name=\"EmployeeSoap11\">\n" +
" <soap:address location=\"http://localhost:8081/ws-servlet/ws/employee-detail\"/>\n" +
" </wsdl:port>\n" +
" </wsdl:service>\n" +
"</wsdl:definitions>";
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.setContentType("text/xml");
resp.getOutputStream().write(WSDL_XML.getBytes());
}
}
是不是很簡(jiǎn)單，是的，為了簡(jiǎn)單，我直接將wsdl文件用變量存儲(chǔ)，我們還需要配置下web.xml
web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<servlet>
<servlet-name>wsdl</servlet-name>
<servlet-class>com.definesys.demo.servlet.WsdlServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>wsdl</servlet-name>
<url-pattern>/ws/employee</url-pattern>
</servlet-mapping>
</web-app>
這樣我們?cè)L問http://localhost:8080/ws/employee就能返回一個(gè)wsdl文件，也就是接口描述文件。在wsdl文件里，我們定義接口地址為http://localhost:8080/ws/employee-detail，接下來我們就要實(shí)現(xiàn)這個(gè)接口。
3. 業(yè)務(wù)servlet
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午2:56
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
public class EmployeeServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
String response = "<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\">\n" +
" <SOAP-ENV:Header/>\n" +
" <SOAP-ENV:Body>\n" +
" <ns2:EmployeeDetailResponse xmlns:ns2=\"http://www.definesys.com/xml/employee\">\n" +
" <ns2:Employee>\n" +
" <ns2:name>jianfeng</ns2:name>\n" +
" <ns2:email>jianfeng.zheng@definesys.com</ns2:email>\n" +
" </ns2:Employee>\n" +
" </ns2:EmployeeDetailResponse>\n" +
" </SOAP-ENV:Body>\n" +
"</SOAP-ENV:Envelope>";
resp.getOutputStream().write(response.getBytes());
}
}
這里不做任何業(yè)務(wù)處理，不做xml轉(zhuǎn)bean，不做bean轉(zhuǎn)xml，就是這么暴力，直接返回xml，但他仍是一個(gè)soap服務(wù)，支持所有soap工具調(diào)用。
將servlet配置到web.xml里
web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<servlet>
<servlet-name>wsdl</servlet-name>
<servlet-class>com.definesys.demo.servlet.WsdlServlet</servlet-class>
</servlet>
<servlet>
<servlet-name>employee</servlet-name>
<servlet-class>com.definesys.demo.servlet.EmployeeServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>wsdl</servlet-name>
<url-pattern>/ws/employee</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>employee</servlet-name>
<url-pattern>/ws/employee-detail</url-pattern>
</servlet-mapping>
</web-app>
/ws/employee-detail這個(gè)地址必須和wsdl文件里定義的保持一致，不然服務(wù)無法被找到。
4. 測(cè)試
使用soapui測(cè)試我們的webservice，通過地址http://localhost:8081/ws-servlet/ws/employee導(dǎo)入wsdl文件，測(cè)試接口，返回我們?cè)跇I(yè)務(wù)servlet里面寫死的內(nèi)容。恭喜你，你已經(jīng)不依賴任何第三方包完成了一個(gè)soap webservice。
當(dāng)然這個(gè)只是一個(gè)玩具，但框架就是在上面的基礎(chǔ)上進(jìn)行擴(kuò)展，增加wsdl文件自動(dòng)生成，xml轉(zhuǎn)java，java轉(zhuǎn)xml，xml校驗(yàn)，錯(cuò)誤處理等功能，如果你有時(shí)間，你也可以寫一個(gè)soap webservice框架。
代碼已經(jīng)上傳至github，歡迎star，開始進(jìn)入正題，偏的有點(diǎn)遠(yuǎn)。
spring boot開發(fā)soap webservice
1. 創(chuàng)建spring boot工程
你可以通過spring initializr初始化spring boot工程，也可以通過inte idea的spring initializr插件進(jìn)行初始化，個(gè)人推薦后面這種。
2. 添加依賴
添加soap webservice相關(guān)依賴包和插件，
pom.xml
<!--依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web-services</artifactId>
</dependency>
<dependency>
<groupId>wsdl4j</groupId>
<artifactId>wsdl4j</artifactId>
</dependency>
...
<!--插件-->
<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>
<!--<schemaFiles>employee.xsd</schemaFiles>-->
<outputDirectory>${project.basedir}/src/main/java</outputDirectory>
<packageName>com.definesys.tutorial.ws.type</packageName>
<clearOutputDir>false</clearOutputDir>
</configuration>
</plugin>
插件jaxb2能夠?qū)崿F(xiàn)java和xml之間互轉(zhuǎn)，下面是幾個(gè)參數(shù)的說明
- schemaDirectory：xsd文件目錄
- schemaFiles：指定schemaDirectory下的xsd文件，多個(gè)用逗號(hào)隔開，必須指定schemaDirectory
- outputDirectory：生成java文件保存目錄
- packageName：生成java文件包路徑
- clearOutputDir：重新生成前是否需要清空目錄
3. 編寫xsd文件
假設(shè)我們的需求是通過員工工號(hào)查詢員工詳細(xì)信息，根據(jù)需求編寫以下xsd文件，并保存在/src/main/resources/目錄下。
employee.xsd
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.definesys.com/xml/employee"
targetNamespace="http://www.definesys.com/xml/employee" elementFormDefault="qualified">
<xs:element name="EmployeeDetailRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="EmployeeDetailResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="Employee" type="tns:Employee"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="Employee">
<xs:sequence>
<xs:element name="code" type="xs:string"/>
<xs:element name="name" type="xs:string"/>
<xs:element name="email" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
4. 生成java類型文件
我們需要根據(jù)xsd文件生成java類型文件，這就要借助maven插件jaxb2，打開終端運(yùn)行命令mvn jaxb2:xjc，如果運(yùn)行正常，就會(huì)在目錄com.definesys.tutorial.ws.type下生成一堆java文件，此時(shí)文件結(jié)構(gòu)如下：
. ├── java │ └── com │ └── definesys │ └── tutorial │ └── ws │ ├── SpringbootWsApplication.java │ └── type │ ├── Employee.java │ ├── EmployeeDetailRequest.java │ ├── EmployeeDetailResponse.java │ ├── ObjectFactory.java │ └── package-info.java └── resources ├── application.properties ├── employee.xsd ├── static └── templates
5. 創(chuàng)建配置文件
WebserviceConfig.java
package com.definesys.tutorial.ws;
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.ws.wsdl.wsdl11.Wsdl11Definition;
import org.springframework.xml.xsd.SimpleXsdSchema;
import org.springframework.xml.xsd.XsdSchema;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午4:46
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
@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 = "employee")
public Wsdl11Definition defaultWsdl11Definition(XsdSchema schema) {
DefaultWsdl11Definition wsdl = new DefaultWsdl11Definition();
wsdl.setPortTypeName("EmployeePort");
wsdl.setLocationUri("/ws/employee-detail");
wsdl.setTargetNamespace("http://www.definesys.com/xml/employee");
wsdl.setSchema(schema);
return wsdl;
}
@Bean
public XsdSchema employeeSchema() {
return new SimpleXsdSchema(new ClassPathResource("employee.xsd"));
}
}
6. 創(chuàng)建業(yè)務(wù)服務(wù)
EmployeeSoapController.java
package com.definesys.tutorial.ws;
import com.definesys.tutorial.ws.type.Employee;
import com.definesys.tutorial.ws.type.EmployeeDetailRequest;
import com.definesys.tutorial.ws.type.EmployeeDetailResponse;
import org.springframework.ws.server.endpoint.annotation.PayloadRoot;
import org.springframework.ws.server.endpoint.annotation.RequestPayload;
import org.springframework.ws.server.endpoint.annotation.ResponsePayload;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午4:49
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
@Endpoint
public class EmployeeSoapController {
private static final String NAMESPACE_URI = "http://www.definesys.com/xml/employee";
@PayloadRoot(namespace = NAMESPACE_URI, localPart = "EmployeeDetailRequest")
@ResponsePayload
public EmployeeDetailResponse getEmployee(@RequestPayload EmployeeDetailRequest request) {
EmployeeDetailResponse response = new EmployeeDetailResponse();
//這里只作為演示,真正開發(fā)中需要編寫業(yè)務(wù)邏輯代碼
Employee employee = new Employee();
employee.setName("jianfeng");
employee.setEmail("jianfeng.zheng@definesys.com");
employee.setCode(request.getCode());
response.setEmployee(employee);
return response;
}
}
與RestController不一樣的是，spring boot soap是根據(jù)請(qǐng)求報(bào)文來指定調(diào)用的函數(shù)，RestController是根據(jù)請(qǐng)求路徑來確定。@PayloadRoot就是關(guān)鍵，如本次請(qǐng)求報(bào)文如下：
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:emp="http://www.definesys.com/xml/employee">
<soapenv:Header/>
<soapenv:Body>
<emp:EmployeeDetailRequest>
<emp:code>?</emp:code>
</emp:EmployeeDetailRequest>
</soapenv:Body>
</soapenv:Envelope>
xmlns:emp="http://www.definesys.com/xml/employee"就是@PayloadRoot.namespace，emp:EmployeeDetailRequest對(duì)應(yīng)@PayloadRoot.localPart。理解了這個(gè)其他都很好理解。
7. 測(cè)試
使用soapui進(jìn)行測(cè)試，通過地址http://localhost:8080/ws/employee.wsdl導(dǎo)入wsdl文件進(jìn)行測(cè)試。
輸入報(bào)文
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:emp="http://www.definesys.com/xml/employee">
<soapenv:Header/>
<soapenv:Body>
<emp:EmployeeDetailRequest>
<emp:code>004</emp:code>
</emp:EmployeeDetailRequest>
</soapenv:Body>
</soapenv:Envelope>
輸出報(bào)文
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:EmployeeDetailResponse xmlns:ns2="http://www.definesys.com/xml/employee">
<ns2:Employee>
<ns2:code>004</ns2:code>
<ns2:name>jianfeng</ns2:name>
<ns2:email>jianfeng.zheng@definesys.com</ns2:email>
</ns2:Employee>
</ns2:EmployeeDetailResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
同時(shí)提供soap和restful兩種服務(wù)
soap一般在企業(yè)內(nèi)部用的比較多，做系統(tǒng)間的集成，restful一般用于移動(dòng)應(yīng)用和h5應(yīng)用，如果在企業(yè)應(yīng)用開發(fā)里能夠同時(shí)提供兩種協(xié)議的支持，將極大提高接口的復(fù)用。其實(shí)也沒有想象中的那么復(fù)雜，在本例中，只需把業(yè)務(wù)邏輯部分用service實(shí)現(xiàn)再創(chuàng)建一個(gè)RestController即可，通過設(shè)計(jì)模式即可解決，不需要引入新的技術(shù)。
EmployeeService.java
package com.definesys.tutorial.ws;
import com.definesys.tutorial.ws.type.Employee;
import com.definesys.tutorial.ws.type.EmployeeDetailRequest;
import com.definesys.tutorial.ws.type.EmployeeDetailResponse;
import org.springframework.stereotype.Service;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午5:42
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
@Service
public class EmployeeService {
public EmployeeDetailResponse getEmployee(EmployeeDetailRequest request) {
EmployeeDetailResponse response = new EmployeeDetailResponse();
//這里只作為演示,真正開發(fā)中需要編寫業(yè)務(wù)邏輯代碼
Employee employee = new Employee();
employee.setName("jianfeng");
employee.setEmail("jianfeng.zheng@definesys.com");
employee.setCode(request.getCode());
response.setEmployee(employee);
return response;
}
}
EmployeeSoapController.java
package com.definesys.tutorial.ws;
import com.definesys.tutorial.ws.type.Employee;
import com.definesys.tutorial.ws.type.EmployeeDetailRequest;
import com.definesys.tutorial.ws.type.EmployeeDetailResponse;
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;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午4:49
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
@Endpoint
public class EmployeeSoapController {
@Autowired
private EmployeeService service;
private static final String NAMESPACE_URI = "http://www.definesys.com/xml/employee";
@PayloadRoot(namespace = NAMESPACE_URI, localPart = "EmployeeDetailRequest")
@ResponsePayload
public EmployeeDetailResponse getEmployee(@RequestPayload EmployeeDetailRequest request) {
return service.getEmployee(request);
}
}
EmployeeRestController.java
package com.definesys.tutorial.ws;
import com.definesys.tutorial.ws.type.EmployeeDetailRequest;
import com.definesys.tutorial.ws.type.EmployeeDetailResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
* @Copyright: Shanghai Definesys Company.All rights reserved.
* @Description:
* @author: jianfeng.zheng
* @since: 2019/1/5 下午5:43
* @history: 1.2019/1/5 created by jianfeng.zheng
*/
@RestController
@RequestMapping(value = "/rest")
public class EmployeeRestController {
@Autowired
private EmployeeService service;
@RequestMapping(value = "/employee-detail", method = RequestMethod.POST)
public EmployeeDetailResponse getEmployeeDetail(@RequestBody EmployeeDetailRequest request) {
return service.getEmployee(request);
}
}
測(cè)試
$ curl http://localhost:8080/rest/employee-detail -X POST -d '{"code":"004"}' -H "Content-Type: application/json"
{
"employee": {
"code": "004",
"name": "jianfeng",
"email": "jianfeng.zheng@definesys.com"
}
}
這樣就實(shí)現(xiàn)了soap和rest同時(shí)提供的目的。
本文代碼已提交至gitlab歡迎star
相關(guān)參考文檔
https://spring.io/guides/gs/producing-web-service/
https://github.com/wls1036/tutorial-springboot-soap
https://github.com/wls1036/pure-ws-servlet
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
Java中的private、protected、public和default的區(qū)別(詳解)
下面小編就為大家?guī)硪黄狫ava中的private、protected、public和default的區(qū)別(詳解)。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2016-11-11
淺談Java分布式架構(gòu)下如何實(shí)現(xiàn)分布式鎖
這篇文章主要介紹了淺談Java分布式架構(gòu)下如何實(shí)現(xiàn)分布式鎖，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
Java 實(shí)現(xiàn)文件批量重命名親測(cè)可用（精簡(jiǎn)版）
本文給大家分享一段自己寫的java代碼實(shí)現(xiàn)文件批量重命名，親測(cè)試過沒有任何問題，大家可以放心使用2016-11-11
教你在Spring Boot微服務(wù)中集成gRPC通訊的方法
這篇文章主要介紹了教你在Spring Boot微服務(wù)中集成gRPC通訊的方法,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-09-09
在本篇內(nèi)容里小編給大家分享的是關(guān)于java往php傳數(shù)據(jù)操作方法和技巧，需要的朋友們可以跟著學(xué)習(xí)下。2018-12-12
SpringBoot集成POI實(shí)現(xiàn)Excel導(dǎo)入導(dǎo)出的示例詳解
Apache?POI?是用Java編寫的免費(fèi)開源的跨平臺(tái)的?Java?API，Apache?POI提供API給Java程序?qū)icrosoft?Office格式檔案讀和寫的功能。本文主要介紹通過SpringBoot集成POI工具實(shí)現(xiàn)Excel的導(dǎo)入和導(dǎo)出功能，需要的可以參考一下2022-07-07
Java使用DateUtils對(duì)日期進(jìn)行數(shù)學(xué)運(yùn)算經(jīng)典應(yīng)用示例【附DateUtils相關(guān)包文件下載】
這篇文章主要介紹了Java使用DateUtils對(duì)日期進(jìn)行數(shù)學(xué)運(yùn)算的方法,可實(shí)現(xiàn)針對(duì)日期時(shí)間的各種常見運(yùn)算功能,并附帶DateUtils的相關(guān)包文件供讀者下載使用,需要的朋友可以參考下2017-11-11
今天小編就為大家分享一篇Java DOM4J方式生成XML的方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-07-07
這篇文章主要介紹了Java Number類原理解析,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11
多年以來一直使用的是IDE來寫java項(xiàng)目,導(dǎo)致很多的最基礎(chǔ)的東西都漸漸模糊了,最近遇到一個(gè)問題就是如果命令行來運(yùn)行一個(gè)java項(xiàng)目,這里總結(jié)下,這篇文章主要給大家介紹了關(guān)于如何使用cmd命令行窗口運(yùn)行java文件的相關(guān)資料,需要的朋友可以參考下2023-10-10