SpringBoot整合WebService
WebService是一种传统的SOA技术架构,它不依赖于任何的编程语言,也不依赖于任何的技术平台,可以直接基于HTTP协议实现网络应用间的数据交互。
面向服务架构(SOA)是一个组件模型,它将应用程序的不同功能单元(称为服务)进行拆分,并通过这些服务之间定义良好的接口和协议联系起来。接口是采用中立的方式进行定义的,它应该独立于实现服务的硬件平台、操作系统和编程语言。这使得构建在各种各样的系统中的服务可以以一种统一和通用的方式进行交互。
WebService主要用于异构平台之间的整合与调用,例如请求者使用的是Java语言开发,而提供者是Golang语言开发。使用XML进行接口的描述(SOAP协议)。
SpringBoot搭建WebService程序
在springboot-webservice项目中新建3个模块,webservice-server、webservice-client、webservice-common。
webservice-common项目引入项目依赖,webservice-server和webservice-client项目引入webservice-common项目。
<dependency><groupId>com.sun.xml.ws</groupId><artifactId>jaxws-ri</artifactId><version>2.3.5</version><type>pom</type>
</dependency><dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId><version>7.0.1.Final</version>
</dependency><dependency><groupId>org.apache.cxf</groupId><artifactId>cxf-spring-boot-starter-jaxws</artifactId><version>3.4.3</version>
</dependency><dependency><groupId>org.apache.cxf</groupId><artifactId>cxf-rt-transports-http</artifactId><version>3.4.3</version>
</dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.6.0</version>
</dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web-services</artifactId><version>2.6.0</version>
</dependency>
一、定义规范接口
WebService服务端以远程接口为主,在Java实现的WebService技术中,使用CXF开发框架可以直接将接口发布成WebService。
webservice-common模块在com.it.service包下新建MessageService接口。
package com.it.service;import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;@WebService(name = "MessageService", targetNamespace = "http://service.it.com/")
public interface MessageService {@WebMethod // webservice方法标注String echo(@WebParam String message);
}
二、搭建WebService服务端
webservice-server模块定义MessageService的实现子类。
package com.it.service.impl;import com.it.service.MessageService;
import org.springframework.stereotype.Service;import javax.jws.WebService;@WebService(serviceName = "MessageService",targetNamespace = "http://service.it.com/", // 接口命名空间endpointInterface = "com.it.service.MessageService") // 接口名称
@Service // 注册到Spring容器
public class MessageServiceImpl implements MessageService {@Overridepublic String echo(String message) {return "[echo]: " + message;}
}
基于拦截器实现安全配置。
package com.it.interceptor;import lombok.extern.slf4j.Slf4j;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.binding.soap.saaj.SAAJInInterceptor;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.springframework.stereotype.Component;
import org.w3c.dom.NodeList;import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPHeader;
import javax.xml.soap.SOAPMessage;
import java.util.Objects;@Slf4j
@Component
public class WebServiceAuthInterceptor extends AbstractPhaseInterceptor<SoapMessage> {private static final String USER_NAME = "admin"; // 用户名private static final String USER_PASSWORD = "123456"; //密码private final SAAJInInterceptor interceptor = new SAAJInInterceptor(); // 创建拦截器public WebServiceAuthInterceptor() {super(Phase.PRE_PROTOCOL);super.getAfter().add(SAAJInInterceptor.class.getName()); // 添加拦截器}@Overridepublic void handleMessage(SoapMessage message) throws Fault {// 获取指定信息SOAPMessage soapMessage = message.getContent(SOAPMessage.class);if (soapMessage == null) { // 没有消息this.interceptor.handleMessage(message); // 走默认流程soapMessage = message.getContent(SOAPMessage.class); // 再次获取消息}SOAPHeader header = null; // SOAP头信息try {header = soapMessage.getSOAPHeader();} catch (SOAPException e) {e.printStackTrace();}if (header == null) { // 没有头信息throw new Fault(new IllegalAccessException("找不到header信息"));}// 解析XML文档(SOAP是XML结构的)NodeList usernameList = header.getElementsByTagName("username");NodeList passwordList = header.getElementsByTagName("password");if (usernameList.getLength() < 1) {throw new Fault(new IllegalAccessException("找不到header信息"));}if (passwordList.getLength() < 1) {throw new Fault(new IllegalAccessException("找不到header信息"));}String username = usernameList.item(0).getTextContent().trim(); // 获取用户名String password = passwordList.item(0).getTextContent().trim(); // 获取密码if (Objects.equals(USER_NAME, username) && Objects.equals(USER_PASSWORD, password)) {log.info("用户访问成功");} else {SOAPException soapException = new SOAPException("用户认证失败");log.error("用户认证失败");throw new Fault(soapException);}}
}
由于当前的webservice是基于CXF开发的,所以需要定义CXF配置类。
package com.it.config;import com.it.interceptor.WebServiceAuthInterceptor;
import com.it.service.MessageService;
import org.apache.cxf.Bus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.transport.servlet.CXFServlet;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import javax.xml.ws.Endpoint;@Configuration
public class CXFConfig {private final Bus bus;private final MessageService messageService;private final WebServiceAuthInterceptor webServiceAuthInterceptor;@Autowiredpublic CXFConfig(Bus bus, MessageService messageService, WebServiceAuthInterceptor webServiceAuthInterceptor) {this.bus = bus;this.messageService = messageService;this.webServiceAuthInterceptor = webServiceAuthInterceptor;}public ServletRegistrationBean getServletRegistrationBean() {return new ServletRegistrationBean(new CXFServlet(), "/services/*"); // 设置webservice访问父路径}@Beanpublic Endpoint getMessageEndpoint() {EndpointImpl endpoint = new EndpointImpl(bus, messageService);endpoint.publish("/MessageService");endpoint.getInInterceptors().add(webServiceAuthInterceptor); // 添加拦截器return endpoint;}
}
新建SpringBoot启动类,启动程序。
package com.it;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class StartWebServiceServer {public static void main(String[] args) {SpringApplication.run(StartWebServiceServer.class, args);}
}
浏览器访问:http://localhost:8080/services 发现webservice发布成功。
WSDL文档也正常出现。
三、搭建WebService客户端
CXF组件下的WebService调用服务使用如下流程:
webservice-client模块创建客户端登录拦截器,设置认证信息。
package com.it.interceptor;import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.helpers.DOMUtils;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.w3c.dom.Document;
import org.w3c.dom.Element;import javax.xml.namespace.QName;
import java.util.List;public class ClientLoginInterceptor extends AbstractPhaseInterceptor<SoapMessage> {private final String username;private final String password;public ClientLoginInterceptor(String username, String password) {super(Phase.PRE_PROTOCOL);this.username = username;this.password = password;}@Overridepublic void handleMessage(SoapMessage message) throws Fault {List<Header> headers = message.getHeaders(); // 获取全部头信息Document document = DOMUtils.createDocument(); // 创建xml文档Element authElement = document.createElement("authority"); // 认证数据节点Element usernameElement = document.createElement("username");Element passwordElement = document.createElement("password");usernameElement.setTextContent(username);passwordElement.setTextContent(password);authElement.appendChild(usernameElement);authElement.appendChild(passwordElement);headers.add(0, new Header(new QName("authority"), authElement));}
}
CXF有两种调用方式,代理调用和动态程序调用。使用代理调用:
package com.it.client;import com.it.interceptor.ClientLoginInterceptor;
import com.it.service.MessageService;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;public class CXFProxyClient {private static final String ADDRESS = "http://localhost:8080/services/MessageService?wsdl"; // WebService服务地址public static void main(String[] args) {JaxWsProxyFactoryBean jaxWsProxyFactoryBean = new JaxWsProxyFactoryBean();jaxWsProxyFactoryBean.setAddress(ADDRESS);jaxWsProxyFactoryBean.setServiceClass(MessageService.class);jaxWsProxyFactoryBean.getOutInterceptors().add(new ClientLoginInterceptor("admin","123456") // 设置用户名,密码);MessageService messageService = (MessageService)jaxWsProxyFactoryBean.create();String echo = messageService.echo("[webservice proxy invoke]");System.out.println("echo = " + echo);}}
执行程序,接口调用成功。
动态调用:
package com.it.client;import com.it.interceptor.ClientLoginInterceptor;
import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;public class CXFDynamicClient {private static final String ADDRESS = "http://localhost:8080/services/MessageService?wsdl"; // WebService服务地址public static void main(String[] args) throws Exception {JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();Client client = dcf.createClient(ADDRESS);client.getOutInterceptors().add(new ClientLoginInterceptor("admin","123456"));String message = "dynamic";Object[] result = client.invoke("echo", message);System.out.println(result);}
}
SpringBoot整合WebService相关推荐
- SpringBoot整合WebService(服务端+客户端)
SpringBoot整合WebService(服务端+客户端) 文章目录 SpringBoot整合WebService(服务端+客户端) 一.服务端 1.项目结构 2.创建好SpringBoot项目后 ...
- .net webservice studio调用方法传参_springboot整合WebService简单版
一.什么是webservice 这里给大家分享一下我们的专栏<Java 进阶集中营>,每天都会给大家分享一个最新的java技术内容,有优秀的技术讯息,也欢迎分享在我的专栏里. JAVA 进 ...
- 【七】springboot整合redis(超详细)
springboot篇章整体栏目: [一]springboot整合swagger(超详细 [二]springboot整合swagger(自定义)(超详细) [三]springboot整合token(超 ...
- IDEA中进行SpringBoot整合spring-ws开发webservice接口后期要修改xsd文件流程
场景 SpringBoot整合spring-ws开发webservice接口(全流程详细教程) 参照: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/articl ...
- 基于Springboot整合RestTemplate调用Webservice接口
1.基于Springboot整合RestTemplate调用Webservice接口,如果感觉使用webservice客户端调用服务器端不会,或者不方便 的时候,可以尝试使用RestTemplate来 ...
- idea启动webservice_idea使用springboot的webservice基于cxf
SpringBoot整合CXF实例: 服务端构建 org.apache.cxf cxf-spring-boot-starter-jaxws 3.2.5 /*** 作者信息实体 *@authoroKon ...
- RabbitMq详解+SpringBoot整合RabbitMq快速入门
1概述: 1.1.什么是MQ 消息队列(Message Queue,简称MQ),从字面意思上看,本质是个队列,FIFO先入先出,只不过队列中存放的内容是message而已. 其主要用途:不同进程Pro ...
- 很详细的SpringBoot整合UEditor教程
很详细的SpringBoot整合UEditor教程 2017年04月10日 20:27:21 小宝2333 阅读数:21529 版权声明:本文为博主原创文章,未经博主允许不得转载. https://b ...
- SpringBoot整合JWT实现API身份校验
上一个项目采用的是session存储uid的方式来确认API调用方的合法身份,这次的app则打算采用token的方式进行身份校验,此二者的优缺点有很多博客进行了论述,这里就不谈了. 本文中的代码以及部 ...
最新文章
- fabricjs 高级篇(自定义类型)
- Azure中centos7设置时间为上海时间
- Classification分类halcon算子,持续更新
- mysql net 指令_MySQL命令
- maven tomcat插件_Maven技术01
- 设计模式学习之---Facade(外观)模式
- AR VR或将彻底变革广告营销行业
- [SAP ABAP开发技术总结]ABAP调优——代码优化
- 苹果8p吃鸡服务器没有响应,今天绝地求生更新之后进不去了,一进开始界面就游戏未响应:为什么绝地求生更新完进不去...
- 重载下标操作符,检查内存越界
- sizeof(std::string) 的大小
- 人工智能机器学习Java也可以
- glide 压缩图拍呢_Glide-图片的压缩
- 盘点MAC下用过的五笔输入法
- java中reject方法作用_Promise.all中对于reject的处理方法
- 实践论和矛盾论是任何人必修的一课
- led的伏安特性曲线 matlab实现_灯泡伏安特性仿真实验的实现算法
- PCB设计中的Mark点
- 统计学基本知识(四)
- 剖析微信等即时通讯常用组件(一)