一、Spring+CXF整合示例
WebService是一種跨編程語言、跨操作系統平台的遠程調用技術，它是指一個應用程序向外界暴露一個能通過Web調用的API接口，我們把調用這個WebService的應用程序稱作客戶端，把提供這個WebService的應用程序稱作服務端。
環境
win10+Spring5.1+cxf3.3.2
下載
- 官網下載：https://archive.apache.org/dist/cxf/
- 百度網盤：
鏈接：https://pan.baidu.com/s/1nsUweTFG_6CcZKaVBCQ7uQ
提取碼：4qp7
服務端
- 新建
web項目
- 放入依賴
將apache-cxf-3.3.2\lib中的jar包全部copy至項目WEB-INF\lib目錄下（偷個懶，這些jar包中包含了Spring所需的jar包）
- 在
web.xml中添加webService的配置攔截
<!--webService -->
<servlet>
<servlet-name>CXFService</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>CXFService</servlet-name>
<url-pattern>/webservice/*</url-pattern>
</servlet-mapping>
webservice服務接口
在項目src目錄下新建pms.inface.WebServiceInterface類
package pms.inface;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
@WebService(targetNamespace = "http://spring.webservice.server", name = "WebServiceInterface")
public interface WebServiceInterface {
@WebMethod
@WebResult(name = "result", targetNamespace = "http://spring.webservice.server")
public String sayBye(@WebParam(name = "word", targetNamespace = "http://spring.webservice.server") String word);
}
- 接口實現類
在項目src目錄下新建pms.impl.WebServiceImpl類
package pms.impl;
import javax.jws.WebService;
import pms.inface.WebServiceInterface;
@WebService
public class WebServiceImpl implements WebServiceInterface{
@Override
public String sayBye(String word) {
return word + "當和這個真實的世界迎面撞上時，你是否找到辦法和自己身上的慾望講和，又該如何理解這個鋪面而來的人生？";
}
}
webservice配置文件
在WEB-INF目錄下新建webservice配置文件cxf-webService.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jaxws="http://cxf.apache.org/jaxws"
xmlns:cxf="http://cxf.apache.org/core"
xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd
http://cxf.apache.org/core
http://cxf.apache.org/schemas/core.xsd
http://cxf.apache.org/transports/http/configuration
http://cxf.apache.org/schemas/configuration/http-conf.xsd
">
<import resource="classpath:META-INF/cxf/cxf.xml" />
<!-- 使用jaxws:server標籤發布WebService服務 ,設置address為訪問地址, 和web.xml文件中配置的CXF配合為一個完整的路徑 -->
<!-- serviceClass為實現類的接口 serviceBean引用配置好的WebService實現類 -->
<jaxws:server address="/webServiceInterface"
serviceClass="pms.inface.WebServiceInterface">
<jaxws:serviceBean>
<ref bean="WebServiceImpl" />
</jaxws:serviceBean>
</jaxws:server>
<!-- 為所有的WS設置超時時間 ,此時為默認值 連接時間30s,等待回復時間為60s-->
<http-conf:conduit name="*.http-conduit">
<http-conf:client ConnectionTimeout="60000" ReceiveTimeout="120000"/>
</http-conf:conduit>
</beans>
spring配置文件
在WEB-INF目錄下新建spring配置文件applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<bean id="WebServiceImpl" class="pms.impl.WebServiceImpl"></bean>
<import resource="cxf-webService.xml" />
</beans>
在web.xml中配置applicationContext.xml
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
/WEB-INF/applicationContext.xml
</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
- 將項目放至
tomcat中啟動
啟動后訪問地址：localhost:PORT/項目名/webservice/webServiceInterface?wsdl，如下圖所示，webservice接口發布成功
二、SoapUI測試
SoapUI是一個開源測試工具,通過soap/http來檢查、調用、實現Web Service的功能/負載/符合性測試。
下載
- 百度網盤
鏈接：https://pan.baidu.com/s/1N2RTqhvrkuzx7YJvmDeY7Q
提取碼：e1w3
測試
- 打開
SoapUI，新建一個SOAP項目，將剛才的發布地址copy至Initial WSDL欄，點擊OK按鈕
- 發起接口請求
三、客戶端
使用wsdl2java工具生成webservice客戶端代碼
- 該工具在剛才下載的
apache-cxf-3.3.2\bin目錄下
- 配置環境變量
設置CXF_HOME，並添加%CXF_HOME %/bin到path環境變量。
CMD命令行輸入wsdl2java -help，有正常提示說明環境已經正確配置 - wsdl2java.bat用法：
wsdl2java –p 包名 –d 存放目錄 -all wsdl地址
-p 指定wsdl的命名空間，也就是要生成代碼的包名
-d 指令要生成代碼所在目錄
-client 生成客戶端測試web service的代碼
-server 生成服務器啟動web service代碼
-impl 生成web service的實現代碼，我們在方式一用的就是這個
-ant 生成build.xml文件
-all 生成所有開始端點代碼
wsdl2java -p pms.inface -d ./ -all http://localhost:8080/spring_webservice_server/webservice/webServiceInterface?wsdl
客戶端調用
- 新建
web項目
- 放入依賴
將apache-cxf-3.3.2\lib中的jar包全部copy至項目WEB-INF\lib目錄下
- 將
wsdl2java生成的代碼放至src.pms.inface目錄下
調用方法一：
package pms;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
import pms.inface.WebServiceInterface;
public class webServiceClientMain {
public static void main(String[] args) {
JaxWsProxyFactoryBean svr = new JaxWsProxyFactoryBean();
svr.setServiceClass(WebServiceInterface.class);
svr.setAddress("http://localhost:8080/spring_webservice_server/webservice/webServiceInterface?wsdl");
WebServiceInterface webServiceInterface = (WebServiceInterface) svr.create();
System.out.println(webServiceInterface.sayBye("honey,"));
}
}
調用方法二：
- 在src目錄下新建
applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jaxws="http://cxf.apache.org/jaxws"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd">
<jaxws:client id="webServiceInterface"
serviceClass="pms.inface.WebServiceInterface"
address="http://localhost:8080/spring_webservice_server/webservice/webServiceInterface?wsdl" >
</jaxws:client>
</beans>
package pms;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import pms.inface.WebServiceInterface;
public class webServiceClientTest {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
WebServiceInterface webServiceInterface = context.getBean(WebServiceInterface.class);
String result = webServiceInterface.sayBye("honey,");
System.out.println(result);
}
}
四、服務端攔截器
- 需求場景：服務提供方安全驗證，也就是
webservice自定義請求頭的實現，服務接口在身份認證過程中的密碼字段滿足SM3（哈希函數算法標準）的加密要求
SM3加密所需jar包：commons-lang3-3.9.jar、bcprov-jdk15on-1.60.jar，這兩個jar包在剛才下載的apache-cxf-3.3.2\lib下就有- 請求頭格式
<security>
<username></username>
<password></password>
</auth>
- 在
src.pms.interceptor下新建WebServiceInInterceptor攔截器攔截請求，解析頭部
package pms.interceptor;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.xml.namespace.QName;
import org.apache.cxf.binding.soap.SoapMessage;
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.apache.cxf.transport.http.AbstractHTTPDestination;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import pms.support.Sm3Utils;
import pms.support.StringUtils;
/**
* WebService的輸入攔截器
* @author coisini
* @date May 2020, 13
*
*/
public class WebServiceInInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
private static final String USERNAME = "admin";
private static final String PASSWORD = "P@ssw0rd";
/**
* 允許訪問的IP
*/
private static final String ALLOWIP = "127.0.0.1;XXX.XXX.XXX.XXX";
public WebServiceInInterceptor() {
/*
* 攔截器鏈有多個階段，每個階段都有多個攔截器，攔截器在攔截器鏈的哪個階段起作用，可以在攔截器的構造函數中聲明
* RECEIVE 接收階段，傳輸層處理
* (PRE/USER/POST)_STREAM 流處理/轉換階段
* READ SOAPHeader讀取
* (PRE/USER/POST)_PROTOCOL 協議處理階段，例如JAX-WS的Handler處理
* UNMARSHAL SOAP請求解碼階段
* (PRE/USER/POST)_LOGICAL SOAP請求解碼處理階段
* PRE_INVOKE 調用業務處理之前進入該階段
* INVOKE 調用業務階段
* POST_INVOKE 提交業務處理結果，並觸發輸入連接器
*/
super(Phase.PRE_INVOKE);
}
/**
* 客戶端傳來的 soap 消息先進入攔截器這裏進行處理，客戶端的賬目與密碼消息放在 soap 的消息頭<security></security>中，
* 類似如下：
* <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
* <soap:Header><security><username>admin</username><password>P@ssw0rd</password></security></soap:Header>
* <soap:Body></soap:Body></soap:Envelope>
* 現在只需要解析其中的 <head></head>標籤，如果解析驗證成功，則放行，否則這裏直接拋出異常，
* 服務端不會再往後運行，客戶端也會跟着拋出異常，得不到正確結果
*
* @param message
* @throws Fault
*/
@Override
public void handleMessage(SoapMessage message) throws Fault {
System.out.println("PRE_INVOKE");
HttpServletRequest request = (HttpServletRequest)message.get(AbstractHTTPDestination.HTTP_REQUEST);
String ipAddr=request.getRemoteAddr();
System.out.println("客戶端訪問IP----"+ipAddr);
if(!ALLOWIP.contains(ipAddr)) {
throw new Fault(new IllegalArgumentException("非法IP地址"), new QName("0009"));
}
/**
* org.apache.cxf.headers.Header
* QName ：xml 限定名稱，客戶端設置頭信息時，必須與服務器保持一致，否則這裏返回的 header 為null，則永遠通不過的
*/
Header authHeader = null;
//獲取驗證頭
List<Header> headers = message.getHeaders();
for(Header h:headers){
if(h.getName().toString().contains("security")){
authHeader=h;
break;
}
}
System.out.println("authHeader");
System.out.println(authHeader);
if(authHeader !=null) {
Element auth = (Element) authHeader.getObject();
NodeList childNodes = auth.getChildNodes();
String username = null,password = null;
for(int i = 0, len = childNodes.getLength(); i < len; i++){
Node item = childNodes.item(i);
if(item.getNodeName().contains("username")){
username = item.getTextContent();
System.out.println(username);
}
if(item.getNodeName().contains("password")){
password = item.getTextContent();
System.out.println(password);
}
}
if(StringUtils.isBlank(username) || StringUtils.isBlank(password)) {
throw new Fault(new IllegalArgumentException("用戶名或密碼不能為空"), new QName("0001"));
}
if(!Sm3Utils.verify(USERNAME, username) || !Sm3Utils.verify(PASSWORD,password)) {
throw new Fault(new IllegalArgumentException("用戶名或密碼錯誤"), new QName("0008"));
}
if (Sm3Utils.verify(USERNAME, username) && Sm3Utils.verify(PASSWORD,password)) {
System.out.println("webService 服務端自定義攔截器驗證通過....");
return;//放行
}
}else {
throw new Fault(new IllegalArgumentException("請求頭security不合法"), new QName("0010"));
}
}
// 出現錯誤輸出錯誤信息和棧信息
public void handleFault(SoapMessage message) {
Exception exeption = message.getContent(Exception.class);
System.out.println(exeption.getMessage());
}
}
- 在
src.pms.support下新建Sm3Utils加密類
package pms.support;
import java.io.UnsupportedEncodingException;
import java.security.Security;
import java.util.Arrays;
import org.bouncycastle.crypto.digests.SM3Digest;
import org.bouncycastle.crypto.macs.HMac;
import org.bouncycastle.crypto.params.KeyParameter;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.pqc.math.linearalgebra.ByteUtils;
/**
* SM3加密
* @author coisini
* @date May 2020, 13
*/
public class Sm3Utils {
private static final String ENCODING = "UTF-8";
static {
Security.addProvider(new BouncyCastleProvider());
}
/**
* sm3算法加密
* @explain
* @param paramStr
* 待加密字符串
* @return 返回加密后，固定長度=32的16進制字符串
*/
public static String encrypt(String paramStr){
// 將返回的hash值轉換成16進制字符串
String resultHexString = "";
try {
// 將字符串轉換成byte數組
byte[] srcData = paramStr.getBytes(ENCODING);
// 調用hash()
byte[] resultHash = hash(srcData);
// 將返回的hash值轉換成16進制字符串
resultHexString = ByteUtils.toHexString(resultHash);
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
return resultHexString;
}
/**
* 返回長度=32的byte數組
* @explain 生成對應的hash值
* @param srcData
* @return
*/
public static byte[] hash(byte[] srcData) {
SM3Digest digest = new SM3Digest();
digest.update(srcData, 0, srcData.length);
byte[] hash = new byte[digest.getDigestSize()];
digest.doFinal(hash, 0);
return hash;
}
/**
* 通過密鑰進行加密
* @explain 指定密鑰進行加密
* @param key
* 密鑰
* @param srcData
* 被加密的byte數組
* @return
*/
public static byte[] hmac(byte[] key, byte[] srcData) {
KeyParameter keyParameter = new KeyParameter(key);
SM3Digest digest = new SM3Digest();
HMac mac = new HMac(digest);
mac.init(keyParameter);
mac.update(srcData, 0, srcData.length);
byte[] result = new byte[mac.getMacSize()];
mac.doFinal(result, 0);
return result;
}
/**
* 判斷源數據與加密數據是否一致
* @explain 通過驗證原數組和生成的hash數組是否為同一數組，驗證2者是否為同一數據
* @param srcStr
* 原字符串
* @param sm3HexString
* 16進制字符串
* @return 校驗結果
*/
public static boolean verify(String srcStr, String sm3HexString) {
boolean flag = false;
try {
byte[] srcData = srcStr.getBytes(ENCODING);
byte[] sm3Hash = ByteUtils.fromHexString(sm3HexString);
byte[] newHash = hash(srcData);
if (Arrays.equals(newHash, sm3Hash))
flag = true;
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
return flag;
}
public static void main(String[] args) {
// 測試二：account
String account = "admin";
String passoword = "P@ssw0rd";
String hex = Sm3Utils.encrypt(account);
System.out.println(hex);//dc1fd00e3eeeb940ff46f457bf97d66ba7fcc36e0b20802383de142860e76ae6
System.out.println(Sm3Utils.encrypt(passoword));//c2de40449a2019db9936381fa9810c22c8548a8635ed2b7fb3c7ec362e37429d
//驗證加密后的16進制字符串與加密前的字符串是否相同
boolean flag = Sm3Utils.verify(account, hex);
System.out.println(flag);// true
}
}
package pms.support;
/**
* 字符串工具類
* @author coisini
* @date Nov 27, 2019
*/
public class StringUtils {
/**
* 判空操作
* @param value
* @return
*/
public static boolean isBlank(String value) {
return value == null || "".equals(value) || "null".equals(value) || "undefined".equals(value);
}
}
- 在
cxf-webService.xml添加攔截器配置
<!-- 在此處引用攔截器 -->
<bean id="InInterceptor"
class="pms.interceptor.WebServiceInInterceptor" >
</bean>
<cxf:bus>
<cxf:inInterceptors>
<ref bean="InInterceptor" />
</cxf:inInterceptors>
</cxf:bus>
五、客戶端攔截器
- 在
src.pms.support下新建AddHeaderInterceptor攔截器攔截請求，添加自定義認證頭部
package pms.support;
import java.util.List;
import javax.xml.namespace.QName;
import org.apache.cxf.binding.soap.SoapHeader;
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;
public class AddHeaderInterceptor extends AbstractPhaseInterceptor<SoapMessage>{
private String userName;
private String password;
public AddHeaderInterceptor(String userName, String password) {
super(Phase.PREPARE_SEND);
this.userName = userName;
this.password = password;
}
@Override
public void handleMessage(SoapMessage msg) throws Fault {
System.out.println("攔截...");
/**
* 生成的XML文檔
* <authHeader>
* <userName>admin</userName>
* <password>P@ssw0rd</password>
* </authHeader>
*/
// SoapHeader部分待添加的節點
QName qName = new QName("security");
Document doc = DOMUtils.createDocument();
Element pwdEl = doc.createElement("password");
pwdEl.setTextContent(password);
Element userEl = doc.createElement("username");
userEl.setTextContent(userName);
Element root = doc.createElement("security");
root.appendChild(userEl);
root.appendChild(pwdEl);
// 創建SoapHeader內容
SoapHeader header = new SoapHeader(qName, root);
// 添加SoapHeader內容
List<Header> headers = msg.getHeaders();
headers.add(header);
}
}
java調用，修改webServiceClientMain調用代碼如下
public class webServiceClientMain {
public static void main(String[] args) {
JaxWsProxyFactoryBean svr = new JaxWsProxyFactoryBean();
svr.setServiceClass(WebServiceInterface.class);
svr.setAddress("http://localhost:8081/spring_webservice_server/webservice/webServiceInterface?wsdl");
WebServiceInterface webServiceInterface = (WebServiceInterface) svr.create();
// jaxws API 轉到 cxf API 添加日誌攔截器
org.apache.cxf.endpoint.Client client = org.apache.cxf.frontend.ClientProxy
.getClient(webServiceInterface);
org.apache.cxf.endpoint.Endpoint cxfEndpoint = client.getEndpoint();
//添加自定義的攔截器
cxfEndpoint.getOutInterceptors().add(new AddHeaderInterceptor("dc1fd00e3eeeb940ff46f457bf97d66ba7fcc36e0b20802383de142860e76ae6", "c2de40449a2019db9936381fa9810c22c8548a8635ed2b7fb3c7ec362e37429d"));
System.out.println(webServiceInterface.sayBye("honey,"));
}
}
六、代碼示例
服務端：https://github.com/Maggieq8324/spring_webservice_server.git
客戶端：https://github.com/Maggieq8324/spring_webservice_client.git
.end
本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理
【其他文章推薦】
※台北網頁設計公司這麼多該如何選擇?
※智慧手機時代的來臨，RWD網頁設計為架站首選
※評比南投搬家公司費用收費行情懶人包大公開
※回頭車貨運收費標準
※網頁設計最專業,超強功能平台可客製化
※別再煩惱如何寫文案,掌握八大原則!
