多平台统一管理软件接口，如何实现多平台统一管理软件接口
511
2023-01-15
spring boot 开发soap webservice的实现代码
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接口，想给别人用，我们要怎么办
部署接口到服务器
编写接口文档，写清楚接口是通过什么方法调的，输入参数是什么，输出参数是什么，错误时返回什么。
那问题来了，我们能不能只把接口部署到服务器上，然后接口不单能提供具体的服务，而且还能自动生成一份标准的接口文档，把接口信息都记录在该文档里，如果能做到，是不是能做到"接口即文档"的目的。
那么一个接口的信息包括哪些呢？
接口地址
接口调用方法
接口输入参数
接口输出参数
接口出错返回信息
....
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)
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 = "
"
"
"\n" +
"
"
"
"
" \n" +
" \n" +
" \n" +
"\n" +
"
"
"
"
" \n" +
" \n" +
" \n" +
"\n" +
"
"
"
"
" \n" +
" \n" +
"\n" +
"\n" +
" \n" +
"
"
" \n" +
" \n" +
"
"
" \n" +
" \n" +
"
"
"
" \n" +
"
" \n" +
" \n" +
" \n" +
"
"
"
"
"
"
" \n" +
"
"
" \n" +
" \n" +
" \n" +
"
"
"
" \n" +
" \n" +
"";
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.setContentType("text/xml");
resp.getOutputStream().write(WSDL_XML.getBytes());
}
}
是不是很简单，是的，为了简单，我直接将wsdl文件用变量存储，我们还需要配置下web.xml
web.xml
xmlns:xsi="http://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">
xmlns:xsi="http://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">
这样我们访问http://localhost:8080/ws/employee就能返回一个wsdl文件，也就是接口描述文件。在wsdl文件里，我们定义接口地址为http://localhost:8080/ws/employee-detail，接下来我们就要实现这个接口。
3. 业务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 = "
"
"
"
"
"
"
" \n" +
" \n" +
" \n" +
"";
resp.getOutputStream().write(response.getBytes());
}
}
这里不做任何业务处理，不做xml转bean，不做bean转xml，就是这么暴力，直接返回xml，但他仍是一个soap服务，支持所有soap工具调用。
将servlet配置到web.xml里
web.xml
xmlns:xsi="http://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">
xmlns:xsi="http://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">
/ws/employee-detail这个地址必须和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
targetNamespace="http://definesys.com/xml/employee" elementFormDefault="qualified"> <nMpPJltBBB;xs:element name="Employee" type="tns:Employee"/>
targetNamespace="http://definesys.com/xml/employee" elementFormDefault="qualified">
<nMpPJltBBB;xs:element name="Employee" type="tns:Employee"/>
4. 生成java类型文件
我们需要根据xsd文件生成java类型文件，这就要借助maven插件jaxb2，打开终端运行命令mvn jaxb2:xjc，如果运行正常，就会在目录com.definesys.tutorial.ws.type下生成一堆java文件，此时文件结构如下：
.
├── 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. 创建配置文件
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://definesys.com/xml/employee");
wsdl.setSchema(schema);
return wsdl;
}
@Bean
public XsdSchema employeeSchema() {
return new SimpleXsdSchema(new ClassPathResource("employee.xsd"));
}
}
6. 创建业务服务
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://definesys.com/xml/employee";
@PayloadRoot(namespace = NAMESPACE_URI, localPart = "EmployeeDetailRequest")
@ResponsePayload
public EmployeeDetailResponse getEmployee(@RequestPayload EmployeeDetailRequest request) {
EmployeeDetailResponse response = new EmployeeDetailResponse();
//这里只作为演示,真正开发中需要编写业务逻辑代码
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是根据请求报文来指定调用的函数，RestController是根据请求路径来确定。@PayloadRoot就是关键，如本次请求报文如下：
xmlns:emp="http://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
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();
//这里只作为演示,真正开发中需要编写业务逻辑代码
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://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);
}
}
测试
$ 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"
}
}
这样就实现了soap和rest同时提供的目的。
本文代码已提交至gitlab欢迎star
相关参考文档
https://spring.io/guides/gs/producing-web-service/
https://github.com/wls1036/tutorial-springboot-soap
https://github.com/wls1036/pure-ws-servlet
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
相关文章
发表评论
暂时没有评论，来抢沙发吧~