SpringBoot整合WebService的實(shí)現(xiàn)示例

更新時(shí)間：2021年11月30日 08:33:06 作者：NicholasGUB

本文主要介紹了SpringBoot整合WebService，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

面向服務(wù)架構(gòu)（SOA）是一個(gè)組件模型，它將應(yīng)用程序的不同功能單元（稱(chēng)為服務(wù)）進(jìn)行拆分，并通過(guò)這些服務(wù)之間定義良好的接口和協(xié)議聯(lián)系起來(lái)。接口是采用中立的方式進(jìn)行定義的，它應(yīng)該獨(dú)立于實(shí)現(xiàn)服務(wù)的硬件平臺(tái)、操作系統(tǒng)和編程語(yǔ)言。這使得構(gòu)建在各種各樣的系統(tǒng)中的服務(wù)可以以一種統(tǒng)一和通用的方式進(jìn)行交互。

在這里插入圖片描述

WebService主要用于異構(gòu)平臺(tái)之間的整合與調(diào)用，例如請(qǐng)求者使用的是Java語(yǔ)言開(kāi)發(fā)，而提供者是Golang語(yǔ)言開(kāi)發(fā)。使用XML進(jìn)行接口的描述（SOAP協(xié)議）。

SpringBoot搭建WebService程序

在springboot-webservice項(xiàng)目中新建3個(gè)模塊，webservice-server、webservice-client、webservice-common。

在這里插入圖片描述

webservice-common項(xiàng)目引入項(xiàng)目依賴(lài)，webservice-server和webservice-client項(xiàng)目引入webservice-common項(xiàng)目。

在這里插入圖片描述

<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>

一、定義規(guī)范接口

WebService服務(wù)端以遠(yuǎn)程接口為主，在Java實(shí)現(xiàn)的WebService技術(shù)中，使用CXF開(kāi)發(fā)框架可以直接將接口發(fā)布成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方法標(biāo)注
    String echo(@WebParam String message);
}

二、搭建WebService服務(wù)端

webservice-server模塊定義MessageService的實(shí)現(xiàn)子類(lèi)。

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") // 接口名稱(chēng)
@Service // 注冊(cè)到Spring容器
public class MessageServiceImpl implements MessageService {
    @Override
    public String echo(String message) {
        return "[echo]: " + message;
    }
}

基于攔截器實(shí)現(xiàn)安全配置。

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"; // 用戶(hù)名
    private static final String USER_PASSWORD = "123456"; //密碼
    private final SAAJInInterceptor interceptor = new SAAJInInterceptor(); // 創(chuàng)建攔截器

    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) { // 沒(méi)有消息
            this.interceptor.handleMessage(message); // 走默認(rèn)流程
            soapMessage = message.getContent(SOAPMessage.class); // 再次獲取消息
        }
        SOAPHeader header = null; // SOAP頭信息
        try {
            header = soapMessage.getSOAPHeader();
        } catch (SOAPException e) {
            e.printStackTrace();
        }
        if (header == null) { // 沒(méi)有頭信息
            throw new Fault(new IllegalAccessException("找不到header信息"));
        }
        // 解析XML文檔（SOAP是XML結(jié)構(gòu)的）
        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(); // 獲取用戶(hù)名
        String password = passwordList.item(0).getTextContent().trim(); // 獲取密碼

        if (Objects.equals(USER_NAME, username) && Objects.equals(USER_PASSWORD, password)) {
            log.info("用戶(hù)訪(fǎng)問(wèn)成功");
        } else {
            SOAPException soapException = new SOAPException("用戶(hù)認(rèn)證失敗");
            log.error("用戶(hù)認(rèn)證失敗");
            throw new Fault(soapException);
        }
    }
}

由于當(dāng)前的webservice是基于CXF開(kāi)發(fā)的，所以需要定義CXF配置類(lèi)。

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/*"); // 設(shè)置webservice訪(fǎng)問(wèn)父路徑
    }

    @Bean
    public Endpoint getMessageEndpoint() {
        EndpointImpl endpoint = new EndpointImpl(bus, messageService);
        endpoint.publish("/MessageService");
        endpoint.getInInterceptors().add(webServiceAuthInterceptor); // 添加攔截器
        return endpoint;
    }
}

新建SpringBoot啟動(dòng)類(lèi)，啟動(dòng)程序。

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);
    }
}

瀏覽器訪(fǎng)問(wèn)：http://localhost:8080/services 發(fā)現(xiàn)webservice發(fā)布成功。

在這里插入圖片描述

WSDL文檔也正常出現(xiàn)。

在這里插入圖片描述

三、搭建WebService客戶(hù)端

CXF組件下的WebService調(diào)用服務(wù)使用如下流程：

在這里插入圖片描述

webservice-client模塊創(chuàng)建客戶(hù)端登錄攔截器，設(shè)置認(rèn)證信息。

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(); // 創(chuàng)建xml文檔
        Element authElement = document.createElement("authority"); // 認(rèn)證數(shù)據(jù)節(jié)點(diǎn)
        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有兩種調(diào)用方式，代理調(diào)用和動(dòng)態(tài)程序調(diào)用。使用代理調(diào)用：

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服務(wù)地址

    public static void main(String[] args) {
        JaxWsProxyFactoryBean jaxWsProxyFactoryBean = new JaxWsProxyFactoryBean();
        jaxWsProxyFactoryBean.setAddress(ADDRESS);
        jaxWsProxyFactoryBean.setServiceClass(MessageService.class);
        jaxWsProxyFactoryBean.getOutInterceptors().add(
                new ClientLoginInterceptor("admin","123456") // 設(shè)置用戶(hù)名，密碼
        );
        MessageService messageService = (MessageService)jaxWsProxyFactoryBean.create();
        String echo = messageService.echo("[webservice proxy invoke]");
        System.out.println("echo = " + echo);
    }

}

執(zhí)行程序，接口調(diào)用成功。

加粗樣式

動(dòng)態(tài)調(diào)用：

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服務(wù)地址

    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);
    }
}

到此這篇關(guān)于SpringBoot整合WebService的實(shí)現(xiàn)示例的文章就介紹到這了,更多相關(guān)SpringBoot整合WebService內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: