介紹
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功能很簡單，就是通過一個(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文件。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
<?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片段可以看出
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
...<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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
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()); }} |
是不是很簡單，是的，為了簡單，我直接將wsdl文件用變量存儲(chǔ)，我們還需要配置下web.xml
web.xml
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
<?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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
<?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. 測試
使用soapui測試我們的webservice，通過地址http://localhost:8081/ws-servlet/ws/employee導(dǎo)入wsdl文件，測試接口，返回我們?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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
<!--依賴--><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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
<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)如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
.├── 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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
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@configurationpublic 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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
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 */@endpointpublic 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)文如下：
|
1
2
3
4
5
6
7
8
|
<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. 測試
使用soapui進(jìn)行測試，通過地址http://localhost:8080/ws/employee.wsdl導(dǎo)入wsdl文件進(jìn)行測試。
輸入報(bào)文
|
1
2
3
4
5
6
7
8
|
<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)文
|
1
2
3
4
5
6
7
8
9
10
11
12
|
<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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
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 */@servicepublic 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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
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 */@endpointpublic 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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
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); }} |
測試
|
1
2
3
4
5
6
7
8
|
$ 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
以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持服務(wù)器之家。
原文鏈接：https://segmentfault.com/a/1190000017777211
