文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringBoot整合WebService的实现示例

2024-04-02 19:55

关注

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 {
    @Override
    public 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()); // 添加拦截器
    }


    @Override
    public 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;

    @Autowired
    public 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访问父路径
    }

    @Bean
    public 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;
    }

    @Override
    public 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内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯