spring boot开发soap webservice

介绍

spring boot web模块提供了RestController实现restful，第一次看到这个名字的时候觉得还有SoapController，很惋惜没有，对于soap webservice提供了另一个模块spring-boot-starter-web-services支持。本文介绍如何在spring boot中开发soap webservice接口，以及接口如何同时支持soap和restful两种协议。

 soap webservice 

Web service是一个平台独立的，低耦合的，自包含的、基于可编程的web的应用程序，既能够是soap webservice也能够是rest webservice，在rest还没出来以前，咱们说webservice通常是指基于soap协议进行通讯的web应用程序。 

 在开始以前，我以为有必要了解下soap webservice，具体的概念网上能够找到不少资料，但网上资料概念性较强，并且soap协议使用的是xml进行通讯，相信xml里面一个namespace就能吓跑一大堆人，因此这里不讨论具体的soap协议细节，我想经过一个例子来讲明什么是soap webservice，经过该例子，你能了解soap webservice其运做原理，固然若是你以为你对这个已经很了解了，大可跳过本章节，本章节跟后面的内容没有任何关系。

 假设咱们开发了一个web接口，想给别人用，咱们要怎么办 

    1.部署接口到服务器 

    2.编写接口文档，写清楚接口是经过什么方法调的，输入参数是什么，输出参数是什么，错误时返回什么。 

那问题来了，咱们能不能只把接口部署到服务器上，而后接口不单能提供具体的服务，并且还能自动生成一份标准的接口文档，把接口信息都记录在该文档里，若是能作到，是否是能作到"接口即文档"的目的。  

那么一个接口的信息包括哪些呢？  

    1.接口地址 

    2.接口调用方法 

    3.接口输入参数 

    4.接口输出参数 

    5.接口出错返回信息 

    6..... 

soap webservice里wsdl文件就是接口描述信息。核心的信息就是以上几个。

第二个问题，因为Web service是一个平台独立，也就是说，使用接口的人不知道这个service是用什么技术开发的，多是php多是java等，但接口的参数和返回的数据都是同样的，要达到这种目的，就须要两个东西，一个是跟平台无关的数据格式，soap使用的是xml，一个是通讯协议，也就是soap协议。 

下面就介绍如何不使用任何框架，仅经过servlet实现一个webservice。该webservice功能很简单，就是经过一我的的姓名查询这我的的详细信息。  

ps：servlet是java web的基础，理解servlet对理解整个java web很是重要，没写过servlet就开始用各类框架写接口就是在胡闹。  

1. wsdl文件 

准备如下wsdl文件，不要管这个文件是怎么来的，是怎么生成的，咱们此次只讲原理，不谈细节，总之，你根据需求写出了这个wsdl文件。

soap:address location里面端口号须要修改成servlet运行的端口号。 

 从如下xml片断能够看出

    接口名称是EmployeeDetail(wsdl:operation) 

    接口输入参数是EmployeeDetailRequest(wsdl:input) 

    接口输出参数是EmployeeDetailResponse(wsdl:output) 

    接口地址是http://localhost:8081/ws-servlet/ws/employee-detail(soap:address)

是否是很简单，是的，为了简单，我直接将wsdl文件用变量存储，咱们还须要配置下web.xml web.xml

这样咱们访问http://localhost:8080/ws/employee就能返回一个wsdl文件，也就是接口描述文件。在wsdl文件里，咱们定义接口地址为http://localhost:8080/ws/employee-detail，接下来咱们就要实现这个接口。 

 3. 业务servlet

这里不作任何业务处理，不作xml转bean，不作bean转xml，就是这么暴力，直接返回xml，但他还是一个soap服务，支持全部soap工具调用。 

将servlet配置到web.xml里 web.xml

这个地址必须和wsdl文件里定义的保持一致，否则服务没法被找到。 

4. 测试 

使用soapui测试咱们的webservice，经过地址http://localhost:8081/ws-servlet/ws/employee导入wsdl文件，测试接口，返回咱们在业务servlet里面写死的内容。恭喜你，你已经不依赖任何第三方包完成了一个soap webservice。 

固然这个只是一个玩具，但框架就是在上面的基础上进行扩展，增长wsdl文件自动生成，xml转java，java转xml，xml校验，错误处理等功能，若是你有时间，你也能够写一个soap webservice框架。 

 代码已经上传至github，欢迎star，开始进入正题，偏的有点远。 

 spring boot开发soap webservice 

1. 建立spring boot工程 

你能够经过spring initializr初始化spring boot工程，也能够经过inte idea的spring initializr插件进行初始化，我的推荐后面这种。 

 2. 添加依赖 

添加soap webservice相关依赖包和插件， 

 pom.xml

插件jaxb2可以实现java和xml之间互转，下面是几个参数的说明 

    schemaDirectory：xsd文件目录 

    schemaFiles：指定schemaDirectory下的xsd文件，多个用逗号隔开，必须指定  schemaDirectory 

    outputDirectory：生成java文件保存目录 

    packageName：生成java文件包路径 

    clearOutputDir：从新生成前是否须要清空目录 

3. 编写xsd文件 

假设咱们的需求是经过员工工号查询员工详细信息，根据需求编写如下xsd文件，并保存在/src/main/resources/目录下。 

 employee.xsd

4. 生成java类型文件 

咱们须要根据xsd文件生成java类型文件，这就要借助maven插件jaxb2，打开终端运行命令mvn jaxb2:xjc，若是运行正常，就会在目录com.definesys.tutorial.ws.type下生成一堆java文件，此时文件结构以下：

5. 建立配置文件 

WebserviceConfig.java

6. 建立业务服务 

EmployeeSoapController.java

与RestController不同的是，spring boot soap是根据请求报文来指定调用的函数，RestController是根据请求路径来肯定。@PayloadRoot就是关键，如本次请求报文以下：

xmlns:emp="http://www.definesys.com/xml/employee"就是@PayloadRoot.namespace，emp:EmployeeDetailRequest对应@PayloadRoot.localPart。理解了这个其余都很好理解。

7. 测试 

使用soapui进行测试，经过地址http://localhost:8080/ws/employee.wsdl导入wsdl文件进行测试。 

输入报文

输出报文

同时提供soap和restful两种服务 

soap通常在企业内部用的比较多，作系统间的集成，restful通常用于移动应用和h5应用，若是在企业应用开发里可以同时提供两种协议的支持，将极大提升接口的复用。其实也没有想象中的那么复杂，在本例中，只需把业务逻辑部分用service实现再建立一个RestController便可，经过设计模式便可解决，不须要引入新的技术。 

 EmployeeService.java

EmployeeSoapController.java

EmployeeRestController.java

测试

这样就实现了soap和rest同时提供的目的。

本人创业团队产品MadPecker，主要作BUG管理、测试管理、应用分发

网址:www.madpecker.com，有须要的朋友欢迎试用、体验！

本文为MadPecker团队技术人员编写，转载请标明出处