springboot2.1.1集成webService

最近在做接口時，需求是提供restful api和webService兩種方式共享數據。對於webService方式，大多數同學還是很陌生的，我在做的過程中也踩了一些坑，現記錄下來，分享給大家。

pom.xml

<dependency> 
     <groupId>org.apache.cxf</groupId> 
     <artifactId>cxf-spring-boot-starter-jaxws</artifactId>         
     <version>3.2.9</version> 
</dependency>

 

springboot是2.1.1版本

項目結構：服務端和客戶端

服務端代碼：

import org.apache.cxf.Bus;
import org.apache.cxf.bus.spring.SpringBus;
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 com.qm.boot.web.webService.server.Interceptor.AuthInterceptor;
import com.qm.boot.web.webService.server.service.DataCenterService;

import javax.xml.ws.Endpoint;

@Configuration
public class CxfConfig {
    
    @Autowired
    private DataCenterService DataCenterServiceImpl;
    /**
     * 為了不被springSecurity攔截，自定義暴露的路徑
     * 默認為/services/**
     */
    @Bean
    public ServletRegistrationBean<CXFServlet> myServlet(){
        ServletRegistrationBean<CXFServlet> registrationBean =new ServletRegistrationBean<CXFServlet>(new CXFServlet(),"/webService/*");
        return registrationBean;
    }

    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus() {
        return new SpringBus();
    }

    //終端路徑
    @Bean
    public Endpoint endpoint() {
        EndpointImpl endpoint = new EndpointImpl(springBus(), DataCenterServiceImpl);
        endpoint.getInInterceptors().add(new AuthInterceptor());//添加校驗攔截器
        endpoint.publish("/dataShare");
        return endpoint;
    }
}

import org.apache.cxf.binding.soap.SoapHeader;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.headers.Header;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import javax.xml.soap.SOAPException;
import java.util.List;
/**
 * 自定義攔截器
 */
public class AuthInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
    Logger logger = LoggerFactory.getLogger(this.getClass());
    private static final String USERNAME="root";
    private static final String PASSWORD="admin";

    public AuthInterceptor() {
        //定義在哪個階段進行攔截
        super(Phase.PRE_PROTOCOL);
    }

    @Override
    public void handleMessage(SoapMessage soapMessage) throws Fault {
        List<Header> headers = null;
        String username=null;
        String password=null;
        try {
           headers = soapMessage.getHeaders();
        } catch (Exception e) {
            logger.error("getSOAPHeader error: {}",e.getMessage(),e);
        }

        if (headers == null) {
            throw new Fault(new IllegalArgumentException("找不到Header，無法驗證用戶信息"));
        }
        //獲取用戶名,密碼
        for (Header header : headers) {
            SoapHeader soapHeader = (SoapHeader) header;
            Element e = (Element) soapHeader.getObject();
            NodeList usernameNode = e.getElementsByTagName("username");
            NodeList pwdNode = e.getElementsByTagName("password");
             username=usernameNode.item(0).getTextContent();
             password=pwdNode.item(0).getTextContent();
            if( StringUtils.isEmpty(username)||StringUtils.isEmpty(password)){
                throw new Fault(new IllegalArgumentException("用戶信息為空"));
            }
        }
        //校驗用戶名密碼
        if(!(username.equals(USERNAME) && password.equals(PASSWORD))){
            SOAPException soapExc = new SOAPException("用戶認證信息錯誤");
            logger.debug("用戶認證信息錯誤");
            throw new Fault(soapExc);
        }

    }

}

import java.io.UnsupportedEncodingException;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;

@WebService
public interface DataCenterService {
    @WebMethod
    public String dataShare(@WebParam(name = "code")String code,@WebParam(name = "type")String type,@WebParam(name = "count")Integer count, @WebParam(name = "currentPage")Integer currentPage,@WebParam(name = "startTime")String startTime,@WebParam(name = "userName")String userName, @WebParam(name = "sign")String sign)throws UnsupportedEncodingException;
}

import java.io.UnsupportedEncodingException;

import javax.jws.WebService;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.alibaba.fastjson.JSON;
import com.qm.boot.web.api.component.DataShareComponent;
import com.qm.boot.web.webService.server.service.DataCenterService;

/**
 * targetNamespace:按照endpointInterface反寫，很關鍵
 */
@Service
@WebService(name = "dataShare" ,targetNamespace ="http://service.server.webService.web.boot.qm.com/" ,endpointInterface = "com.qm.boot.web.webService.server.service.DataCenterService")
public class DataCenterServiceImpl implements DataCenterService {
    @Autowired
    private DataShareComponent dataShareComponent;
    
    @Override
    public String dataShare(String code, String type, Integer count, Integer currentPage, String startTime, String userName, String sign) throws UnsupportedEncodingException {
        return JSON.toJSONString(dataShareComponent.dataShare(code, type, count, currentPage, startTime, userName, sign));
    }
}

 

 客戶端代碼:

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 LoginInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
    private String username="root";
    private String password="admin";
    public LoginInterceptor(String username, String password) {
        //設置在發送請求前階段進行攔截
        super(Phase.PREPARE_SEND);
        this.username=username;
        this.password=password;
    }

    @Override
    public void handleMessage(SoapMessage soapMessage) throws Fault {
        List<Header> headers = soapMessage.getHeaders();
        Document doc = DOMUtils.createDocument();
        Element auth = doc.createElementNS("http://service.server.webService.web.boot.qm.com/","SecurityHeader");
        Element UserName = doc.createElement("username");
        Element UserPass = doc.createElement("password");

        UserName.setTextContent(username);
        UserPass.setTextContent(password);

        auth.appendChild(UserName);
        auth.appendChild(UserPass);

        headers.add(0, new Header(new QName("SecurityHeader"),auth));
    }
}

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.qm.boot.web.webService.client.interceptor.LoginInterceptor;

import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
//客戶端測試demo
public class CxfClient {
    //webService接口地址
    private static String address = "http://localhost:8080/services/test?wsdl";
    
    
    public static void main(String[] args) {
        run();
    }
    
      /**
     * 動態調用方式
     */
    public static void run() {
      
        JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();  // 創建動態客戶端
        Client client = dcf.createClient(address);
        
        client.getOutInterceptors().add(new LoginInterceptor("root","admin"));// 需要密碼的情況需要加上用戶名和密碼
        Object[] objects = new Object[0];
        try {
             // invoke("方法名",參數1,參數2,參數3....);
             objects = client.invoke("dataShare", "1","1",100,1,"","1","lXIh6PzSVPIyG6qMD");
            System.out.println("返回數據:" +  JSONObject.parse(JSON.toJSONString(objects[0])));
        } catch (Exception e) {
            System.out.println(e.getMessage());
            //e.printStackTrace();
        }
    }
}

如果項目集成了springSecurity，切記一定要排除對webService地址的攔截，不然客戶端會請求失敗

啟動項目后，訪問webService地址，可以看到發布成功如下：

 

 客戶端調用成功：