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 也可以是 restwebservice，在 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，接下来我们就要实现这个接口。

1. 业务 servlet

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

将 servlet 配置到 web.xml 里

web.xml

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

1. 测试 

使用 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 插件进行初始化，个人推荐后面这种。

1. 添加依赖 

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


插件 jaxb2 能够实现 java 和 xml 之间互转，下面是几个参数的说明 
    schemaDirectory：xsd 文件目录    
    schemaFiles：指定 schemaDirectory 下的 xsd 文件，多个用逗号隔开，必须指定  schemaDirectory    
    outputDirectory：生成 java 文件保存目录    
    packageName：生成 java 文件包路径    
    clearOutputDir：重新生成前是否需要清空目录 
   

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

employee.xsd

1. 生成 java 类型文件 

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

1. 创建配置文件 

WebserviceConfig.java

1. 创建业务服务 

EmployeeSoapController.java


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

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

1. 测试 

使用 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 团队技术人员编写，转载请标明出处