spring boot开发soap webservice

6
回复
114
查看
[复制链接]

5

主题

5

帖子

36

安币

初级码农

Rank: 1

发表于 2019-6-20 10:04:32 | 显示全部楼层 |阅读模式
介绍
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.xmlweb.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团队技术人员编写,转载请标明出处







325

主题

960

帖子

714

安币

手工艺人

发表于 2019-6-20 14:39:18 | 显示全部楼层
每次我都积极回帖的,想要安币~

9

主题

9559

帖子

1780

安币

Android大神

Rank: 6Rank: 6

发表于 2019-6-20 14:56:01 | 显示全部楼层
安卓巴士是个不错的网站,我来顶个贴~

465

主题

9906

帖子

812

安币

代码手工艺人

Rank: 4

发表于 2019-6-20 15:05:12 | 显示全部楼层
不错不错,楼主辛苦了。。。

4

主题

9649

帖子

795

安币

代码手工艺人

Rank: 4

发表于 2019-6-20 15:11:26 | 显示全部楼层
感谢分享,安卓巴士有你更精彩:lol

400

主题

1064

帖子

337

安币

手工艺人

发表于 2019-6-20 15:16:59 | 显示全部楼层
支持,感谢,祝巴士越来越好~

9

主题

9405

帖子

1813

安币

Android大神

Rank: 6Rank: 6

QQ达人

发表于 2019-6-20 15:24:55 | 显示全部楼层
帮帮顶顶!!
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

领先的中文移动开发者社区
18620764416
7*24全天服务
意见反馈:1294855032@qq.com

扫一扫关注我们

Powered by Discuz! X3.2© 2001-2019 Comsenz Inc.( 粤ICP备15117877号 )