關於WebService 的用法demo 總結

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

前言

在跨系統和跨平臺的系統通訊中，WebService是一個事實上的標準，其以平臺無關性，獲得了廣泛的應用。本文將講述如何基於spring來整合CXF，並開發出第一個Hello World的應用。

1.Web Service是什麼？

Web service是一個平臺獨立的，低耦合的，自包含的、基於可程式設計的web的應用程式，可使用開放的XML（標準通用標記語言下的一個子集）標準來描述、釋出、發現、協調和配置這些應用程式，用於開發分散式的互操作的應用程式。
Web Service技術，能使得執行在不同機器上的不同應用無須藉助附加的、專門的第三方軟體或硬體，就可相互交換資料或整合。依據Web Service規範實施的應用之間，無論它們所使用的語言、平臺或內部協議是什麼，都可以相互交換資料。Web Service是自描述、自包含的可用網路模組，可以執行具體的業務功能。Web Service也很容易部署，因為它們基於一些常規的產業標準以及已有的一些技術，諸如標準通用標記語言下的子集XML、HTTP。Web Service減少了應用介面的花費。Web Service為整個企業甚至多個組織之間的業務流程的整合提供了一個通用機制。

2.Web Service模型

WebService體系結構基於三種角色（即服務提供者、服務註冊中心和服務請求者）之間的互動。互動涉及釋出、查詢和繫結操作，這些角色和操作一起作用於WebServices元件，即WebServices軟體模組及其描述。在典型情況下，服務提供者託管可通過網路訪問的的軟體模組，定義WebServices的服務描述並把它釋出到服務註冊中心；服務請求者使用查詢操作來從服務註冊中心檢索服務描述，然後使用服務描述與服務提供者進行繫結並呼叫WebServices實現和同它互動。

從圖中可以看出，SOA結構中共有三種角色：
（1）、服務提供者：釋出自己的服務，並且對服務請求進行響應。
（2）、服務註冊中心：註冊已經發布的WebServices，對其進行分類，並提供搜尋服務。
（3）、服務請求者：利用服務註冊中心查詢所需的服務，然後使用該服務。

SOA體系結構中的元件必須具有上述一種或多種角色，這些角色之間使用三種操作：
（1）、釋出操作：使服務提供者可以向服務註冊中心註冊自己的功能及訪問介面。
（2）、查詢操作：使服務請求者可以通過服務註冊中心查詢特定種類的服務。
（3）、繫結操作：使服務請求者能夠真正使用服務提供者提供的服務。

3.WebService開源框架的選擇

目前主流的Web Service框架主要有3種： Axis 2, CXF, 和 Spring WS。Axis 2和CXF都是來自於Apache，各個方面相差不多，但是目前市場上使用CXF比較多一點。

使用篇

cfx一套最簡配置jar包

cxf3.0.4框架必需的包為：
cxf-core-3.0.4.jar
cxf-rt-bindings-soap-3.0.4.jar
cxf-rt-databinding-jaxb-3.0.4.jar
cxf-rt-frontend-jaxws-3.0.4.jar
cxf-rt-frontend-simple-3.0.4.jar
cxf-rt-transports-http-3.0.4.jar
cxf-rt-transports-udp-3.0.4.jar
cxf-rt-ws-addr-3.0.4.jar
cxf-rt-wsdl-3.0.4.jar
cxf-rt-ws-policy-3.0.4.jar
cxf-rt-wsdl-3.0.4.jar
neethi-3.0.3.jar
slf4j-api-1.7.9.jar
xmlschema-core-2.2.1.jar
注意：這裡不包括spring依賴包和commoms下的jar包

maven依賴

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-core</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-bindings-soap</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-databinding-jaxb</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-frontend-jaxws</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-frontend-simple</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-udp</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-ws-addr</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-wsdl</artifactId>
    <version>3.0.4</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-ws-policy</artifactId>
    <version>3.0.4</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.neethi/neethi -->
<dependency>
    <groupId>org.apache.neethi</groupId>
    <artifactId>neethi</artifactId>
    <version>3.0.3</version>
</dependency>
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http-jetty</artifactId>
    <version>3.0.3</version>
</dependency>

1.最簡單的demo

服務端介面定義

服務端提供的獲取使用者的方法

@WebService
public interface IUserWebService {

    User getUserByName(@WebParam(name="userName") String userName);

    List<User> getAllUsers();

}

注意：“@WebService”標記表示該介面是一個WebService服務；“@WebMethod”表示表示以下方法為WebService服務中的方法；“@WebParam(name=”username”)”表示方法中的引數，username屬性限制了引數的名稱，若沒有指定該屬性，引數將被重新命名。
@WebParam(name=”userName”) 經測試, 可省略, 但為了便於閱讀,還是加上

服務端介面實現

模擬從服務端獲取使用者

public class UserWebServiceImpl implements IUserWebService {

    private static List<User> users = new ArrayList<User>();
    static {
        users.add(new User("001", "李四"));
        users.add(new User("002", "王五"));
        users.add(new User("003", "趙六"));
    }

    public User getUserByName(String userName) {
        if (StringUtils.isEmpty(userName)) {
            return null;
        }
        for (User user: users) {
            if (userName.equals(user.getname())) {
                return user;
            }
        }
        return null;
    }

    public List<User> getAllUsers() {
        return users;
    }

}

編寫服務端的啟動程式

模擬WebService服務啟動

public class WebServiceApp {

    public static void main(String[] args) {
        // webservice介面
        IUserWebService userService = new UserWebServiceImpl();
        // 訪問地址
        String address="http://localhost:8080/userWebService";
        // 釋出服務
        Endpoint.publish(address, userService);
        System.out.println("web service 已啟動");
   }
}

This XML file does not appear to have any style information associated with it. The document tree is shown below.
<wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:tns="http://webservice.demo.coolframe/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http"
    name="UserWebServiceImplService" targetNamespace="http://webservice.demo.coolframe/">
    <wsdl:types>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://webservice.demo.coolframe/"
            elementFormDefault="unqualified" targetNamespace="http://webservice.demo.coolframe/" version="1.0">
            <xs:element name="getAllUsers" type="tns:getAllUsers" />
            <xs:element name="getAllUsersResponse" type="tns:getAllUsersResponse" />
            <xs:element name="getUserByName" type="tns:getUserByName" />
            <xs:element name="getUserByNameResponse" type="tns:getUserByNameResponse" />
            <xs:complexType name="getAllUsers">
                <xs:sequence />
            </xs:complexType>
            <xs:complexType name="getAllUsersResponse">
                <xs:sequence>
                    <xs:element maxOccurs="unbounded" minOccurs="0" name="return" type="tns:user" />
                </xs:sequence>
            </xs:complexType>
            <xs:complexType name="user">
                <xs:sequence>
                    <xs:element minOccurs="0" name="id" type="xs:string" />
                    <xs:element minOccurs="0" name="name" type="xs:string" />
                    <xs:element maxOccurs="unbounded" minOccurs="0" name="phones" nillable="true" type="xs:string" />
                </xs:sequence>
            </xs:complexType>
            <xs:complexType name="getUserByName">
                <xs:sequence>
                    <xs:element minOccurs="0" name="userName" type="xs:string" />
                </xs:sequence>
            </xs:complexType>
            <xs:complexType name="getUserByNameResponse">
                <xs:sequence>
                    <xs:element minOccurs="0" name="return" type="tns:user" />
                </xs:sequence>
            </xs:complexType>
        </xs:schema>
    </wsdl:types>
    <wsdl:message name="getUserByNameResponse">
        <wsdl:part element="tns:getUserByNameResponse" name="parameters"></wsdl:part>
    </wsdl:message>
    <wsdl:message name="getAllUsers">
        <wsdl:part element="tns:getAllUsers" name="parameters"></wsdl:part>
    </wsdl:message>
    <wsdl:message name="getAllUsersResponse">
        <wsdl:part element="tns:getAllUsersResponse" name="parameters"></wsdl:part>
    </wsdl:message>
    <wsdl:message name="getUserByName">
        <wsdl:part element="tns:getUserByName" name="parameters"></wsdl:part>
    </wsdl:message>
    <wsdl:portType name="IUserWebService">
        <wsdl:operation name="getAllUsers">
            <wsdl:input message="tns:getAllUsers" name="getAllUsers"></wsdl:input>
            <wsdl:output message="tns:getAllUsersResponse" name="getAllUsersResponse"></wsdl:output>
        </wsdl:operation>
        <wsdl:operation name="getUserByName">
            <wsdl:input message="tns:getUserByName" name="getUserByName"></wsdl:input>
            <wsdl:output message="tns:getUserByNameResponse" name="getUserByNameResponse"></wsdl:output>
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:binding name="UserWebServiceImplServiceSoapBinding" type="tns:IUserWebService">
        <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
        <wsdl:operation name="getAllUsers">
            <soap:operation soapAction="" style="document" />
            <wsdl:input name="getAllUsers">
                <soap:body use="literal" />
            </wsdl:input>
            <wsdl:output name="getAllUsersResponse">
                <soap:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
        <wsdl:operation name="getUserByName">
            <soap:operation soapAction="" style="document" />
            <wsdl:input name="getUserByName">
                <soap:body use="literal" />
            </wsdl:input>
            <wsdl:output name="getUserByNameResponse">
                <soap:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="UserWebServiceImplService">
        <wsdl:port binding="tns:UserWebServiceImplServiceSoapBinding" name="UserWebServiceImplPort">
            <soap:address location="http://localhost:8080/userWebService" />
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>

顯示這樣的頁面說明服務啟動成功了, 下面模擬客戶端訪問

編寫客戶端

public class WebServiceClient {

    public static void main(String[] args) {
        JaxWsProxyFactoryBean svr = new JaxWsProxyFactoryBean();
        // 服務端介面
        svr.setServiceClass(IUserWebService.class);
        // 服務端地址
        svr.setAddress("http://localhost:8080/userWebService");
        IUserWebService userWebService = (IUserWebService) svr.create();
        List<User> users = userWebService.getAllUsers();
        System.out.println(users);
    }
}

輸出結果:
[User [name=isName:李四], User [name=isName:王五], User [name=isName:趙六]]

2.如何整合spring框架

前提:檢查spring版本

瞭解你的spring版本, cxf對spring版本, 需要的依賴是不同的.至於什麼版本匹配, 還需要自行百度, 我只實驗了spring4.0 + ,需要cxf3.0以上的版本支援,不然報錯.

在Web.xml中宣告CXF監聽器

<servlet>  
<servlet-name>CXFServlet</servlet-name>  
    <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>  
    <load-on-startup>1</load-on-startup>  
</servlet>  
<servlet-mapping>  
     <servlet-name>CXFServlet</servlet-name>  
     <url-pattern>/webservice/*</url-pattern>  
</servlet-mapping>

注意：下的指明瞭服務訪問地址的形式，“/*”代表URL地址中，包名稱後直接跟服務endpoint地址，若指明為/webservice/*，則URL為“包名/webservice/endpoing?wsdl”。例如之前例子的:http://localhost:8080/userWebService?wsdl, 其中userWebService等同於這裡的endpoing

建立WebService宣告的Spring配置檔案spring-cxf.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: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.xsd     
        http://cxf.apache.org/jaxws   
        http://cxf.apache.org/schemas/jaxws.xsd  
        http://cxf.apache.org/transports/http/configuration      
        http://cxf.apache.org/schemas/configuration/http-conf.xsd"> 
  <!-- 2.7以上不用寫這些 -->
  <import resource="classpath:META-INF/cxf/cxf.xml" />  
  <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />  
  <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />  
  <!-- /2.7以上不用寫 -->

  <bean id="userWebService" class="coolframe.demo.webservice.IUserWebService"/>  

    <jaxws:endpoint id="隨便起這個" implementor="#userWebService" address="/UserWebService" />

注意：<jaxws:endpoint>定義了一個WebService，implementor是WebService處理類，值上面定義的bean的id，其具體的實現類在class中指明，address是它的訪問路徑，就是上面提到的將要在URL中顯示的endpoint的名稱。

下面可以啟動專案, 訪問:http://host:port/專案名/webservice/services?wsdl
看一下都有什麼webservice服務,
讀取wsdl檔案內容，訪問路徑： http://host:port/專案名/services/serviceName?wsdl

配置多個介面的方法

<bean id="roleWebService" class="coolframe.demo.webservice.RoleWebServiceImpl"/>  

<bean id="userWebService" class="coolframe.demo.webservice.UserWebServiceImpl"/>  

<jaxws:server id="aWebService"  
    serviceClass="coolframe.demo.webservice.IRoleWebService"  
    address="/RoleWebService">  
    <jaxws:serviceBean>      
        <ref bean="hello"/>  
    </jaxws:serviceBean> 
</jaxws:server> 

<jaxws:server id="bWebService"  
    serviceClass="coolframe.demo.webservice.IUserWebService"  
    address="/UserWebService">  
    <jaxws:serviceBean>      
        <ref bean="userWebService"/>  
    </jaxws:serviceBean> 
</jaxws:server>

總結: 配置方面基本完成了, 剩下還是客戶端的呼叫

客戶端的呼叫

模擬客戶端的呼叫

public class WebServiceClient {

    public static void main(String[] args) {

        String serviceURL = "http://localhost:8000/coolframe/webservice/UserWebService";
        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
        factory.setServiceClass(IUserWebService.class);
        factory.setAddress(serviceURL);
        IUserWebService userWebService = (IUserWebService)factory.create();
        List<User> userList = userWebService.getAllUsers();
        System.out.println(userList);

    }
    // 輸出結果: [User [name=isName:李四], User [name=isName:王五], User [name=isName:趙六]]
}

異常問題總結

jar包缺失

在使用cxf過程中經常出 Cannot find any registered HttpDestinationFactory from the Bus，一般是沒有引入cxf-rt-transports-http-jetty-xxx.jar。檢視apache.cxf.transport.http.HTTPTransportFactory.getDestination(HTTPTransportFactory.java:270)類，jettyFactory為null，也就是缺少http-jetty的實現。

Caused by: java.io.IOException: Cannot find any registered HttpDestinationFactory from the Bus.

解決辦法:

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http-jetty</artifactId>
    <version>3.0.3</version>
</dependency>

spring版本和cxf版本不匹配

java.lang.NoSuchMethodError: org.springframework.aop.support.AopUtils.isCglibProxyClass(Ljava/lang/Class;)Z

解決辦法:

根據spring版本自行百度,更換cxf依賴版本

xml載入取順序問題

org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'cxf' is defined

解決辦法:

把cxf的配置不要放在DispatcherServlet裡, 放到contextConfigLocation里加載

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
    classpath*:conf/spring-cxf.xml
</param-value>
</context-param>

xml檔案找不到

java.io.FileNotFoundException: class path resource [META-INF/cxf/cxf-extension-soap.xml] cannot be opened because it does not exist

cxf 2.7 以上spring-cxf.xml配置中不要寫下面的兩句

<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

關於WebService 的用法demo 總結

前言在跨系統和跨平臺的系統通訊中，WebService是一個事實上的標準，其以平臺無關性，獲得了廣泛的應用。本文將講述如何基於spring來整合CXF，並開發出第一個Hello World的應用。 1.Web Service是什麼？

localStorage用法小總結

打印 val scrip span ttr aso comm head com API如下表所示名稱作用 clear 清空localStorage上存儲的數據 getItem 讀取數據 hasOwnProperty 檢查localStorage上是否保

自動化構建工具—gulp的用法簡單總結

修復 git func 文件夾 open lean 發生遍歷 nod 　　把之前用到的gulp總結整理下，有時候說不出來的，就寫出來吧，做個筆記，以後也可以慢慢補充　　cnpm i --save-dev gulp 把nodejs模塊寫到package.json配置文件中

【轉載】關於generate用法的總結【Verilog】

case分支 intro 技術分享結構類型 img ora 做了 alt http://www.cnblogs.com/nanoty/archive/2012/11/13/2768933.html Abtract generate語句允許細化時間（Elabora

Scrapy爬蟲小demo總結

訪問情況需要 line 架構方法 pid 說著 () 一、 Scrapy入坑。 a) Scrapy的安裝。這個沒什麽可講的，網上一大把。註意的問題，可能我下載的是32位的python，出現了pywin32沒法用的情況，這個直接pip

小demo總結

AD 但是 TE class 。。 load 一位 pri 試驗沒事時自己敲敲代碼，將寫下來的簡單東西，記錄下來。代碼傳到了git上，工程裏包含多個demo的代碼，沒有將他們區分開。有需要的話，自己downlaod，代碼裏註釋寫的很詳細，這裏只做簡單的記錄。 1.SS

QMsgPack的用法DEMO

click mva tle variant double packlist begin exc ast QMsgPack的用法DEMO 引用單元文件： uses qstring, qmsgpack, qjson; 演示一： procedure TForm2.Button10

PHP命令空間namespace及use的用法實踐總結

方便 ive import names hid bsp pre admin 不同看PHP中的命名空間和use namespace app\admin\model; use think\Model; use think\Db; 綜上可以看出，命名空間就是相當於一個文件夾的路

關於Rigidbody，Collider和CharacterController三者之間的關系和用法的總結

詭異 nor 觸發回調函數 force body 想要 die 實現 Rigidbody：多用在“物體”上，因為“物體”都是“死”的，他們的運動一般都是靠物理系統。所以對於Rigidbody的移動，不要用Translate()，要用各種“力”, 比如：Rigidbody的

java webservice - cxf使用總結一

lin 文檔 log pack tel pen args maven ext 1.創建maven項目加入pom依賴 <dependency> <groupId>org.apache.cxf</groupId> <

關於generate用法的總結[Verilog]

轉載http://www.cnblogs.com/nanoty/archive/2012/11/13/2768933.html Abtract generate語句允許細化時間（Elaboration-time）的選取或者某些語句的重複。這些語句可以包括

關於 webservice 的概念總結

WebService到底是什麼一言以蔽之：WebService是一種跨程式語言和跨作業系統平臺的遠端呼叫技術。所謂跨程式語言和跨操作平臺，就是說服務端程式採用java編寫，客戶端程式則可以採用其他程式語言編寫，反

const_cast的用法demo

#include<iostream> #include <windows.h> #include <string> using namespace std; void StringPrint(char *pStr) { std::cout <<

Vue.js中ref ($refs)用法舉例總結

原文地址：http://www.cnblogs.com/xueweijie/p/6907676.html <div id="app"> <input type="text" ref="input1"/> <button @click

C#之非同步程式設計基礎--Task用法簡單總結

Task類 Task類可以有返回值，返回值可以有多個，對於返回值的操作，可以使用Task<TResult> 類。也可以沒有返回值，通常以非同步方式來呼叫。看下下面一個簡單的例子。首先定義了一個Task物件，返回值為string。有一個Start()方

Android中Gesture手勢的基本用法（總結）

應用場景：（1）左右上下滑動螢幕的事件監聽。比如，上拉彈出自定義的底部佈局之類的，換頁之類的等等。（2）畫一些不規則的幾何圖形。執行順序： 1.手指觸碰螢幕時，觸發MotionEvent事件！ 2.該事件被OnTouchListener監聽，可在它的onTo

Asp.net中DataBinder.Eval用法的總結

<%# Bind("Subject") %> //繫結欄位 <%# Container.DataItemIndex + 1%> //實現自動編號 <%# DataBinder.Eval(Container.DataItem, "[n]") %&g

JavaFX學習筆記——用法技巧總結（三）

如何建立響應式元件問題在不同的解析度下，介面的大小始終固定，導致在小螢幕下的文字圖片大小適中，而在大螢幕下顯得過小解決方法使用dimension類 Dimension screensize = Toolkit.getDefaultToolkit

JavaFX學習筆記——用法技巧總結（二）

如何改變兄弟節點的覆蓋關係問題倘若編寫下列程式碼，實現把兩個相交的圓作為一對兄弟節點放入同一個父節點pane中，卻發現不能讓circle覆蓋circle2 Circle circle = new Circle(

JavaFX學習筆記——用法技巧總結（五）

如何正確監聽鍵盤事件問題對於一個事件的觸發，這裡摘取JavaFx China對於常用的滑鼠事件和鍵盤事件的描述當一個動作發生時，系統根據內部規則決定哪一個Node是事件目標。規則如下： ● 對於鍵盤事件，事件目標是已獲取焦點的Node。 ● 對於滑鼠事件，事

關於WebService 的用法demo 總結

前言

1.Web Service是什麼？

2.Web Service模型

3.WebService開源框架的選擇

使用篇

cfx一套最簡配置jar包

maven依賴

1.最簡單的demo

服務端介面定義

服務端介面實現

編寫服務端的啟動程式

編寫客戶端

2.如何整合spring框架

前提:檢查spring版本

在Web.xml中宣告CXF監聽器

建立WebService宣告的Spring配置檔案spring-cxf.xml

客戶端的呼叫

異常問題總結

相關推薦