2. 程式人生 > >如何在SpringMVC專案中部署WebService服務並打包生成客戶端

如何在SpringMVC專案中部署WebService服務並打包生成客戶端

阿新 • • 發佈：2019-02-11

場景

某SpringMVC專案原本為一個HTTP的WEB服務專案，之後想在該專案中新增WebService支援，使該專案同時提供HTTP服務和WebService服務。其中WebService服務通過 /ws/** 地址攔截。

配置

通過配置讓SpringMVC支援WebService。

依賴

首先通過Maven引入必要依賴包。

  • org.apache.cxf
  • org.apache.neethi
  • com.ibm.wsdl4j
  • org.apache.XmlSchema

Web.xml

通過配置Web.xml使Spring框架具備WebService特性，這裡通過新增Servlet（這裡使用CXFServlet）實現。假設SpringMVC本身的DispatcherServlet已經啟用，則在第2啟動順序新增CXFServlet。並新增servlet-mapping匹配請求。
配置如下

<!-- 在上下文中新增配置檔案 -->
<context-param>
    <param-name>patchConfigLocation</param-name>
    <param-value>
        /WEB-INF/applicationServlet.xml
        /WEB-INF/webservice.xml
    <param-value>
</context-param>
<!-- 新增servlet -->
<servlet>
    <servlet-name
 
>ws</servlet-name>
    <servlet-class>org.apache.cxf.trasport.servlet.CXFServlet</servlet-class>
    <load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>ws</servlet-name>
    <url-pattern>/ws/**</url-pattern>
 

</servlet-mapping>

webservice.xml

將webservice的介面配置單獨分離出來。配置如下：

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://cxf.apache.org/jaxws
        http://cxf.apache.org/schemas/jaxws.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">
    <!-- cxf必要配置 -->
    <import resource="classpath:META-INF/cxf/cxf.xml" />  
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />  
    <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />

    <!-- 介面的實現類宣告 -->
    <jaxws:endpoint id="ticketDecodeAuthService" 
        implementorClass="com.xxx.apps.web.ws.server.decode.XXXServiceImpl" 
        address="/ticketDecodeAuth" />

</beans>

介面編寫

對應上文宣告的介面文件在寫在相應的位置上（如本文例子則寫在com.xxx.apps.web.ws.server.decode包中）
程式碼如下：

@WebService
@SOAPBinding(style = Style.RPC)
public interface XXXService {

    public WSReturn getAuth(String userName, String password) throws Exception;

}

介面實現類：

@WebService
@SOAPBinding(style = Style.RPC)
@SuppressWarnings("deprecation")
public class XXXServiceImpl implements XXXService {

    private static final Logger LOGGER = Logger.getLogger(XXXServiceImpl.class);

    @Override
    public WSReturn getAuth(String userName, String password) throws Exception {
        // WSReturn 是自定義的通用介面返回包裝，可以用別的
        WSReturn res = new WSReturn();
        // TODO : your code here
        return res;
    }

}

釋出介面效果

啟動SpringMVC專案，根據配置檔案定義，介面地址類似：http://ip:port/專案名/ws/**
若本例配置則有如下介面可以檢視：

檢視所有介面列表

http://ip:port/專案名/ws

某具體埠(XXXService)為例

這也是客戶端呼叫時候的地址
http://ip:port/專案名/ws/XXXService?wsdl
這裡可以看到埠的規範定義

客戶端編寫

客戶端程式碼

通過CXF的動態代理方式編寫，以反射方式將class直接引入可以實現統一呼叫方法。這樣該Client即可呼叫任意介面。
程式碼如下：

/**
 * webservice服務客戶端
 * @author WSY
 *
 */
public class WSClient {

        private static Logger logger = LoggerFactory.getLogger(WSClient.class);

        /**
         * 呼叫代理
         * @param cls 服務介面代理
         * @param method 方法名
         * @param wsdl wsdl地址
         * @param params 引數Object[]
         * @return
         * @throws Exception
         */
        @SuppressWarnings("rawtypes")
        public static WSReturn invoke(Class cls,String method,String wsdl, Object[] params) throws Exception{
            synchronized(WSClient.class){
                logger.info("[WSClient invoking] - class:"+cls.getName()+"; method:"+method+"; wsdl:"+
                        wsdl+"; params:"+getParams(params));

                JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
                factory.getInInterceptors().add(new LoggingInInterceptor());
                factory.getOutInterceptors().add(new LoggingOutInterceptor());
                factory.setServiceClass(cls);
                factory.setAddress(wsdl);
                Object cInstance = factory.create();
                Method invokeMethod = null;
                for(Method m : cls.getDeclaredMethods()){
                    if(m.getName().equalsIgnoreCase(method)){
                        invokeMethod = m;
                        break;
                    }
                }
                if(invokeMethod == null)
                    throw new Exception("ERROR:method not found");

                WSReturn res = (WSReturn) invokeMethod.invoke(cInstance, params);
                return res;
            }

            private static String getParams(Object[] params){
                StringBuilder sb = new StringBuilder("{");
                for(Object b : params){
                    sb.append(b).append(",");
                }
                if(sb.length()==1)
                    return "{}";
                else 
                    return sb.substring(0,sb.length()-1)+"}";
            }
    }
}

打包

寫個Ant指令碼將一些必要的Java類和定義的Interface(不要打實現類)打成包。本文中將Client程式碼也寫在了Service端了，所以將WSClient也一併打包進去。這樣在編寫對應的客戶端時候，僅需專注於功能實現即可。

<?xml version="1.0"?>
<project name="tws-interfaces" default="jar" basedir=".">

    <!-- Give user a chance to override without editing this file or typing -D -->
    <property name="coredir" location="." />
    <property name="classdir" location="${basedir}/target/classes" />

    <target name="jar" description="Build the jars for core">
        <delete file="${coredir}/webservice-interfaces-1.0.jar" />
        <jar destfile="${coredir}/webservice-interfaces-1.0.jar">
            <fileset dir="${classdir}">
                <include name="**/com/xxx/apps/web/ws/server/**/*Service.class" />
                <include name="**/com/xxx/apps/web/ws/server/tokenservice/**/*.class" />
                <include name="**/com/xxx/apps/web/ws/server/WSReturn.class"/>
                <include name="**/com/xxx/apps/comm/ResultState.class"/>
                <include name="**/com/xxx/apps/web/ws/server/wsclient/WSClient.class"/>
                <include name="**/com/xxx/apps/comm/RespResult.class"/>
                <exclude name="**/com/xxx/apps/web/ws/server/**/*Impl.class" />
            </fileset>
        </jar>
        <copy todir="../xxxclient/lib" file="./webservice-interfaces-1.0.jar"></copy>
    </target>

</project>

客戶端專案實現

依賴

首先通過Maven引入必要依賴包。

  • org.apache.cxf.cxf-rt-frontend-jaxws
  • org.apache.cxf.cxf-rt-databinding-aegis
  • org.apache.cxf.cxf-rt-transports-http
  • org.apache.cxf.cxf-rt-transports-http-jetty

  • commons-codec.commons-codec

    最重要的：引入server端打包好的jar包，裡邊有WSClient和必要的介面

        <dependency>
        <groupId>com.xxx</groupId>
        <artifactId>xxxserver</artifactId>
        <version>1.0</version>
        <scope>system</scope>
        <systemPath>${project.basedir}/lib/webservice-interfaces-1.0.jar</systemPath>
    </dependency>

WSClient呼叫

通過直接呼叫jar包中的WSClient即可呼叫遠端WebService介面。
呼叫示例程式碼如下：

/** 這裡將呼叫註釋複製過來
     * 呼叫代理
     * @param cls 服務介面代理
     * @param method 方法名
     * @param wsdl wsdl地址
     * @param params 引數Object[]
     * @return
     * @throws Exception
     */
WSReturn res= WSClient.invoke(XXXService.class
                , "getAuth"
                ,endpoints.get(XXXService.class.getName())
                , new Object[]{"admin","admin"});
        if(token.getStatusId() == ResultState.SUCESS){
            tokenValue = (String) token.getMap().get("token");
        } else {
            logger.error("獲取token失敗:"+token.getMsg());
        }

一些坑

一定要引入cxf的必要配置

雖然在專案中看不到，但是這些xml檔案在cxf的jar包中。

    <!-- cxf必要配置 -->
    <import resource="classpath:META-INF/cxf/cxf.xml" />  
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />  
    <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />

Interface的類路徑一定要統一

如服務端的 XXXService.java 在 com.xxx.web.ws.server 中，則在客戶端的XXXService.java類也應該在相同的路徑即： com.xxx.web.ws.server 。 所以為方便起見，用Ant直接打包比較方便，不容易錯。

客戶端併發問題

本例中呼叫WSClient，通過反射機制呼叫，共用一個Factory，因此在併發時候容易出現問題，需要在WSClient中加鎖

相關推薦

如何在SpringMVC專案中部署WebService服務並打包生成客戶端

場景 某SpringMVC專案原本為一個HTTP的WEB服務專案，之後想在該專案中新增WebService支援，使該專案同時提供HTTP服務和WebService服務。其中WebService服務通過 /ws/** 地址攔截。 配置 通過配置讓Spri

javaWeb專案中的路徑格式 請求url地址 客戶端路徑 服務端路徑 url-pattern 路徑 獲取資源路徑 地址 url

javaweb專案中有很多場景的路徑客戶端的POST/GET請求,伺服器的請求轉發,資源獲取需要設定路徑等這些路徑表達的含義都有不同,所以想要更好的書寫規範有用的路徑程式碼 需要對路徑有一個清晰地認知 路徑基本上分三類 客戶端路徑 服務端路徑

cxf釋出webservice簡介 及 wsdl2java生成客戶端程式碼

下面我們簡要介紹如何通過cxf框架釋出webservice 首先新建一個Java project為cxfmodel_server 首先去官網下載cxf：http://cxf.apache.org/download.html 下面我們就開始使用 （1）釋出服務 第一步：新建

SpringBoot專案中使用webservice呼叫遠端服務

        有一個webservice專案，對外提供資源查詢服務，使用了Apache的cxf框架，soap協議。如今都使用微服務，在一個springboot專案中需要遠端呼叫這個資源查詢服務，RPC的一種，既然是RPC，就需要有客戶端的存根（stub）和服務端的骨架（sk

SpringMVC專案中獲取所有URL到Controller Method的對映

參考連結 https://www.cnblogs.com/yuananyun/archive/2014/08/25/3934371.html   參考上面大神的程式碼寫的，發現他的程式碼有點小小的問題啊，我這隻菜鳥有點小小不懂哈，然後我就Ctrl+C了一下，然後修改一下了啊，改成我寄己可以執行的

Docker中部署mysql服務

最近一直在學習docker，感覺這麼厲害的東西怎麼以前不知道呢，把自己搗鼓的過程整理記錄下來，供同學們參考 第零步：從Docker Hub拉取官方mysql映象 docker pull mysql 然後就是進入漫長的等待，當然如果你配置了映象加速器，速度會快那麼一丟丟 第一步：使用d

AngulrJs-專案中使用$q服務的defer方法處理非同步問題

由於js指令碼語言的獨特性，當同時呼叫多個介面時就不得不處理js的非同步問題。在AngularJs中解決非同步的方法之一：使用$q的defer方法，defer方法會返回一個物件，我們常呼叫resolve()和reject()處理成功時的響應資料和失敗時的響應資料，接下來在方法中返回一個pri

在 vue cli3 的專案中配置雙服務，模擬 ajax 分頁請求

最近安裝了下vue cli3版本，與 cli 2 相比，檔案少了，以前配置方法也不管用了。demo 中的大量的資料，需要做成 ajax 請求的方式來展示資料，因此，需要啟動兩個服務，一個用作前端請求，一個用作後端傳送。 雙服務的配置方法在 build / webpack.dev.conf.js 中寫入。

如何在Maven中構建SWT應用並打包成可執行的jar包

    前面在Maven中構建SWT應用的時候發現SWT相關jar包在Maven中央倉庫上找不到，後面在stackoverflow上有人提供了一個倉庫地址：https://github.com/maven-eclipse/maven-eclipse.github.io。 &n

Spring專案中新增Redis服務與快取同步問題

一、Redis應用場景      本專案使用redis對圖片進行快取儲存，展示圖片時，先根據圖片ID去Redis快取中查取，沒有再查資料庫，同時將該圖片set進Redis。      使用spring&nb

Redis（1）虛擬機器中部署Redis服務

一、安裝virtualbox 傻瓜式安裝 二、virtualbox中安裝CentOS7 1、下載CentOS7 2、安裝CentOS7 這一步網上教程很多，我在安裝過程中，遇到一個問題，就是virtualbox中沒有64位選項，無法安裝成功，這裡介紹一下這個問題

SpringMVC專案中 web.xml模板

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLS

SpringMVC專案中pom.xml模板

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://m

在同一SpringBoot專案中啟動Dubbo服務端和客戶端

Dubbo是微服務框架，服務需要部署到不同JVM虛擬機器，由此代理的問題是需要提供一個統一Jar包（包含Dubbo介面和JVM間傳遞的實體類），Dubbo伺服器端與客戶端需要共享這個Jar包，在專案開發中這是最為通用的方法， 但在Dubbo案例中如此實現，需要定義三個Maven工程，工作量

05-專案中部署redis企業級資料備份方案

1、企業級的持久化的配置策略 在企業中，RDB的生成策略，用預設的也差不多 save 60 10000：如果你希望儘可能確保說，RDB最多丟1分鐘的資料，那麼儘量就是每隔1分鐘都生成一個快照，低峰期，資料量很少，也沒必要 10000->生成RDB，1

06-專案中部署redis的讀寫分離架構

一主一從，往主節點去寫，在從節點去讀，可以讀到，主從架構就搭建成功了 1、啟用複製，部署slave node wget http://downloads.sourceforge.net/tcl/tcl8.6.1-src.tar.gz tar -xzv

Jenkins安裝及拉取遠端專案並打包生成

       Jenkins是一個開源軟體專案，是基於Java開發的一種持續整合工具，用於監控持續重複的工作，旨在提供一個開放易用的軟體平臺，使軟體的持續整合變成可能。        使用Jenkins可以自動進行專案的打包釋出等工作，這裡講下Jenkins的

SSM專案中整合WebService

package clack.webserviceimp; import java.net.URL; import java.util.List; import javax.xml.namespace.QName; import javax.xml.ws.Service; import org.apac

maven專案匯入依賴jar包並打包為可執行的jar包

1.在pom.xml檔案中新增外掛 <build> <finalName>LeadServer</finalName> <!-- jar包名字首，如果沒有指定，則會使用{artifactId}作為字首 --> <plugins>

在springmvc專案中使用poi匯入匯出excel

@Override public byte[] exportBrandPeriodSort(List<BrandCompleteInfoEntity> list) throws Exception { ByteArrayOutputStream out = new ByteArray