SpringBoot整合WebService

转x33g5p2x  于2021-12-06 转载在 Spring  
字(9.1k)|赞(0)|评价(0)|浏览(364)

WebService是一种传统的SOA技术架构，它不依赖于任何的编程语言，也不依赖于任何的技术平台，可以直接基于HTTP协议实现网络应用间的数据交互。

WebService主要用于异构平台之间的整合与调用，例如请求者使用的是Java语言开发，而提供者是Golang语言开发。使用XML进行接口的描述（SOAP协议）。

SpringBoot搭建WebService程序

在springboot-webservice项目中新建3个模块，webservice-server、webservice-client、webservice-common。

webservice-common项目引入项目依赖，webservice-server和webservice-client项目引入webservice-common项目。

  1. <dependency>
  2.     <groupId>com.sun.xml.ws</groupId>
  3.     <artifactId>jaxws-ri</artifactId>
  4.     <version>2.3.5</version>
  5.     <type>pom</type>
  6. </dependency>
  8. <dependency>
  9.     <groupId>org.hibernate.validator</groupId>
  10.     <artifactId>hibernate-validator</artifactId>
  11.     <version>7.0.1.Final</version>
  12. </dependency>
  14. <dependency>
  15.     <groupId>org.apache.cxf</groupId>
  16.     <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
  17.     <version>3.4.3</version>
  18. </dependency>
  20. <dependency>
  21.     <groupId>org.apache.cxf</groupId>
  22.     <artifactId>cxf-rt-transports-http</artifactId>
  23.     <version>3.4.3</version>
  24. </dependency>
  26. <dependency>
  27.     <groupId>org.springframework.boot</groupId>
  28.     <artifactId>spring-boot-starter-web</artifactId>
  29.     <version>2.6.0</version>
  30. </dependency>
  32. <dependency>
  33.     <groupId>org.springframework.boot</groupId>
  34.     <artifactId>spring-boot-starter-web-services</artifactId>
  35.     <version>2.6.0</version>
  36. </dependency>

一、定义规范接口

WebService服务端以远程接口为主，在Java实现的WebService技术中，使用CXF开发框架可以直接将接口发布成WebService。

webservice-common模块在com.it.service包下新建MessageService接口。

  1. package com.it.service;
  3. import javax.jws.WebMethod;
  4. import javax.jws.WebParam;
  5. import javax.jws.WebService;
  7. @WebService(name = "MessageService", targetNamespace = "http://service.it.com/")
  8. public interface MessageService {
  9.     @WebMethod // webservice方法标注
  10.     String echo(@WebParam String message);
  11. }

二、搭建WebService服务端

webservice-server模块定义MessageService的实现子类。

  1. package com.it.service.impl;
  3. import com.it.service.MessageService;
  4. import org.springframework.stereotype.Service;
  6. import javax.jws.WebService;
  8. @WebService(serviceName = "MessageService",
  9.         targetNamespace = "http://service.it.com/", // 接口命名空间
  10.         endpointInterface = "com.it.service.MessageService") // 接口名称
  11. @Service // 注册到Spring容器
  12. public class MessageServiceImpl implements MessageService {
  13.     @Override
  14.     public String echo(String message) {
  15.         return "[echo]: " + message;
  16.     }
  17. }

基于拦截器实现安全配置。

  1. package com.it.interceptor;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.apache.cxf.binding.soap.SoapMessage;
  5. import org.apache.cxf.binding.soap.saaj.SAAJInInterceptor;
  6. import org.apache.cxf.interceptor.Fault;
  7. import org.apache.cxf.phase.AbstractPhaseInterceptor;
  8. import org.apache.cxf.phase.Phase;
  9. import org.springframework.stereotype.Component;
  10. import org.w3c.dom.NodeList;
  12. import javax.xml.soap.SOAPException;
  13. import javax.xml.soap.SOAPHeader;
  14. import javax.xml.soap.SOAPMessage;
  15. import java.util.Objects;
  17. @Slf4j
  18. @Component
  19. public class WebServiceAuthInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
  21.     private static final String USER_NAME = "admin"; // 用户名
  22.     private static final String USER_PASSWORD = "123456"; //密码
  23.     private final SAAJInInterceptor interceptor = new SAAJInInterceptor(); // 创建拦截器
  25.     public WebServiceAuthInterceptor() {
  26.         super(Phase.PRE_PROTOCOL);
  27.         super.getAfter().add(SAAJInInterceptor.class.getName()); // 添加拦截器
  28.     }
  30.     @Override
  31.     public void handleMessage(SoapMessage message) throws Fault {
  32.         // 获取指定信息
  33.         SOAPMessage soapMessage = message.getContent(SOAPMessage.class);
  34.         if (soapMessage == null) { // 没有消息
  35.             this.interceptor.handleMessage(message); // 走默认流程
  36.             soapMessage = message.getContent(SOAPMessage.class); // 再次获取消息
  37.         }
  38.         SOAPHeader header = null; // SOAP头信息
  39.         try {
  40.             header = soapMessage.getSOAPHeader();
  41.         } catch (SOAPException e) {
  42.             e.printStackTrace();
  43.         }
  44.         if (header == null) { // 没有头信息
  45.             throw new Fault(new IllegalAccessException("找不到header信息"));
  46.         }
  47.         // 解析XML文档（SOAP是XML结构的）
  48.         NodeList usernameList = header.getElementsByTagName("username");
  49.         NodeList passwordList = header.getElementsByTagName("password");
  50.         if (usernameList.getLength() < 1) {
  51.             throw new Fault(new IllegalAccessException("找不到header信息"));
  52.         }
  53.         if (passwordList.getLength() < 1) {
  54.             throw new Fault(new IllegalAccessException("找不到header信息"));
  55.         }
  56.         String username = usernameList.item(0).getTextContent().trim(); // 获取用户名
  57.         String password = passwordList.item(0).getTextContent().trim(); // 获取密码
  59.         if (Objects.equals(USER_NAME, username) && Objects.equals(USER_PASSWORD, password)) {
  60.             log.info("用户访问成功");
  61.         } else {
  62.             SOAPException soapException = new SOAPException("用户认证失败");
  63.             log.error("用户认证失败");
  64.             throw new Fault(soapException);
  65.         }
  66.     }
  67. }

由于当前的webservice是基于CXF开发的，所以需要定义CXF配置类。

  1. package com.it.config;
  3. import com.it.interceptor.WebServiceAuthInterceptor;
  4. import com.it.service.MessageService;
  5. import org.apache.cxf.Bus;
  6. import org.apache.cxf.jaxws.EndpointImpl;
  7. import org.apache.cxf.transport.servlet.CXFServlet;
  8. import org.springframework.beans.factory.annotation.Autowired;
  9. import org.springframework.boot.web.servlet.ServletRegistrationBean;
  10. import org.springframework.context.annotation.Bean;
  11. import org.springframework.context.annotation.Configuration;
  13. import javax.xml.ws.Endpoint;
  15. @Configuration
  16. public class CXFConfig {
  18.     private final Bus bus;
  19.     private final MessageService messageService;
  20.     private final WebServiceAuthInterceptor webServiceAuthInterceptor;
  22.     @Autowired
  23.     public CXFConfig(Bus bus, MessageService messageService, WebServiceAuthInterceptor webServiceAuthInterceptor) {
  24.         this.bus = bus;
  25.         this.messageService = messageService;
  26.         this.webServiceAuthInterceptor = webServiceAuthInterceptor;
  27.     }
  29.     public ServletRegistrationBean getServletRegistrationBean() {
  30.         return new ServletRegistrationBean(new CXFServlet(), "/services/*"); // 设置webservice访问父路径
  31.     }
  33.     @Bean
  34.     public Endpoint getMessageEndpoint() {
  35.         EndpointImpl endpoint = new EndpointImpl(bus, messageService);
  36.         endpoint.publish("/MessageService");
  37.         endpoint.getInInterceptors().add(webServiceAuthInterceptor); // 添加拦截器
  38.         return endpoint;
  39.     }
  40. }

新建SpringBoot启动类，启动程序。

  1. package com.it;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class StartWebServiceServer {
  8.     public static void main(String[] args) {
  9.         SpringApplication.run(StartWebServiceServer.class, args);
  10.     }
  11. }

浏览器访问：http://localhost:8080/services 发现webservice发布成功。

WSDL文档也正常出现。

三、搭建WebService客户端

CXF组件下的WebService调用服务使用如下流程：

webservice-client模块创建客户端登录拦截器，设置认证信息。

  1. package com.it.interceptor;
  3. import org.apache.cxf.binding.soap.SoapMessage;
  4. import org.apache.cxf.headers.Header;
  5. import org.apache.cxf.helpers.DOMUtils;
  6. import org.apache.cxf.interceptor.Fault;
  7. import org.apache.cxf.phase.AbstractPhaseInterceptor;
  8. import org.apache.cxf.phase.Phase;
  9. import org.w3c.dom.Document;
  10. import org.w3c.dom.Element;
  12. import javax.xml.namespace.QName;
  13. import java.util.List;
  15. public class ClientLoginInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
  17.     private final String username;
  18.     private final String password;
  20.     public ClientLoginInterceptor(String username, String password) {
  21.         super(Phase.PRE_PROTOCOL);
  22.         this.username = username;
  23.         this.password = password;
  24.     }
  26.     @Override
  27.     public void handleMessage(SoapMessage message) throws Fault {
  28.         List<Header> headers = message.getHeaders(); // 获取全部头信息
  29.         Document document = DOMUtils.createDocument(); // 创建xml文档
  30.         Element authElement = document.createElement("authority"); // 认证数据节点
  31.         Element usernameElement = document.createElement("username");
  32.         Element passwordElement = document.createElement("password");
  33.         usernameElement.setTextContent(username);
  34.         passwordElement.setTextContent(password);
  35.         authElement.appendChild(usernameElement);
  36.         authElement.appendChild(passwordElement);
  37.         headers.add(0, new Header(new QName("authority"), authElement));
  38.     }
  39. }

CXF有两种调用方式，代理调用和动态程序调用。使用代理调用：

  1. package com.it.client;
  3. import com.it.interceptor.ClientLoginInterceptor;
  4. import com.it.service.MessageService;
  5. import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
  7. public class CXFProxyClient {
  8.     private static final String ADDRESS = "http://localhost:8080/services/MessageService?wsdl"; // WebService服务地址
  10.     public static void main(String[] args) {
  11.         JaxWsProxyFactoryBean jaxWsProxyFactoryBean = new JaxWsProxyFactoryBean();
  12.         jaxWsProxyFactoryBean.setAddress(ADDRESS);
  13.         jaxWsProxyFactoryBean.setServiceClass(MessageService.class);
  14.         jaxWsProxyFactoryBean.getOutInterceptors().add(
  15.                 new ClientLoginInterceptor("admin","123456") // 设置用户名，密码
  16.         );
  17.         MessageService messageService = (MessageService)jaxWsProxyFactoryBean.create();
  18.         String echo = messageService.echo("[webservice proxy invoke]");
  19.         System.out.println("echo = " + echo);
  20.     }
  22. }

执行程序，接口调用成功。

动态调用：

  1. package com.it.client;
  3. import com.it.interceptor.ClientLoginInterceptor;
  4. import org.apache.cxf.endpoint.Client;
  5. import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
  7. public class CXFDynamicClient {
  8.     private static final String ADDRESS = "http://localhost:8080/services/MessageService?wsdl"; // WebService服务地址
  10.     public static void main(String[] args) throws Exception {
  11.         JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
  12.         Client client = dcf.createClient(ADDRESS);
  13.         client.getOutInterceptors().add(new ClientLoginInterceptor("admin","123456"));
  14.         String message = "dynamic";
  15.         Object[] result = client.invoke("echo", message);
  16.         System.out.println(result);
  17.     }
  18. }

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://blog.csdn.net/Nicholas_GUB/article/details/121587582

内容来源于网络，如有侵权，请联系作者删除！

Javaspringbootwebservice

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com