WebService就該這么學

一：WebService簡介

1：WebService介紹

　　WebService是一個平臺獨立的、低耦合的、自包含的、基于可編程的web應用程序，可使用開放的XML來描述、發布、發現、協調和配置這些應用程序，用于開發分布式交互操作的應用程序。
　　WebService技術，能運行在不同機器上的不同應用無須借助附加的、專門的第三方軟件或硬件，就可相互交換數據或集成。依據WebService規范實施的應用之間，無論它們所使用的語言、平臺或內部協議是什么，都可以相互交換數據。

　　這么說吧，其實WebService就是一種跨編程語言和跨操作系統平臺的遠程調用技術（RPC的一種實現方式）。所謂可跨編程語言，就是說服務端程序和客戶端程序可以以不同的語言編寫也可以利用WebService互相調用；跨操作系統平臺則是指服務端程序和客戶端程序可以在不同的操作系統上運行。遠程調用，就是一臺計算機的應用可以調用其他計算機上的應用。例如：我自己編寫一個網站，里面想要個天氣預報的功能，這個時候我肯定去調用氣象局的接口服務而不是我自己發射衛星來監測天氣，再引入我網站里。

2：為什么使用WebService

　　WebService能解決跨平臺調用、跨語言調用、遠程調用（RPC）

　　以各個網站顯示天氣預報功能為例，氣象中心的管理系統將收集的天氣信息并將數據暴露出來(通過WebService Server)，而各大站點的應用就去調用它們得到天氣信息并以不同的樣式去展示(WebService Client)，我們網站雖然提供了天氣預報的服務，但其實它們什么也沒有做，只是簡單的調用了一下氣象中心服務器服務接口而已。

3：WebService原理及重要術語

　　XML、SOAP、WSDL 是構成WebService平臺的三大技術

一：基本術語
　　UDDI：Universal Description, Discovery, and Integration（統一描述、發現和集成）
    　　UDDI是OASIS發起的一個開放項目，它使企業在互聯網上可以互相發現并且定義業務之間的交互。
　　SOAP：simple object  access protocal（簡單對象訪問協議）
    　　①：是一種簡單的、基于HTTP和XML的協議, 用于在WEB上交換結構化的數據，結構化數據實際上就是xml的數據
    　　②：SOAP消息：請求消息和響應消息
    　　③：HTTP+XML片斷
　　WSDL：web service definition language（WebService定義語言）
    　　①：對應一種類型的文件.wsdl
    　　②：定義了WebService的服務器端與客戶端應用交互傳遞請求和響應數據的格式和方式
    　　③：一個WebService對應一個唯一的wsdl文檔（理解為接口說明書）
　　SEI：WebService EndPoint Interface(終端，WebService的終端接口)
    　　①：就是WebService服務器端用來處理請求的接口；我們可以理解為是xxxWebService的各個xxxWebServiceImpl實現類
　　CXF：Celtix + XFire，一個apache的用于開發webservice服務器端和客戶端的框架

WebService基本原理
①：WebService是采用HTTP協議在客戶端和服務端之間傳輸數據
②：WebService傳輸的數據是使用XML封裝后再傳輸交互，XML的優點在于它的跨平臺性（因為市面上的語言基本上都支持xml解析）
③：WebService發送的請求內容和響應內容都采用XML格式封裝，并增加了一些特定的HTTP消息頭，以說明HTTP消息的內容格式，這些特定
　　的HTTP消息頭和XML內容格式就是SOAP協議規定的
④：WebService服務器端首先要通過一個WSDL文件來說明自己有什么服務可以對外調用。簡單的說，WSDL就像是一個說明書，用于
　　描述WebService及其方法、參數和返回值。 WSDL文件保存在Web服務器上，通過一個url地址就可以訪問到它。客戶端要調用
　　一個WebService服務之前，要知道該服務的WSDL文件的地址。
⑤：WebService交互的過程就是,WebService遵循SOAP協議通過XML封裝數據，然后由Http協議來傳輸數據。

注：WebService服務提供商可以通過兩種方式來暴露它的WSDL文件地址：
    1：注冊到UDDI服務器，以便被人查找
    2：直接告訴給客戶端調用者

總結：要想編寫WebService接口就一定要以SOAP請求來傳輸數據（HTTP+XML），編寫完成后把服務暴露到UDDI服務器上，這時調用者
　　  可以通過指定的URL來生成WSDL

4：WebService兩種開發方式

1：JAX-WS(Java API for XML Web Service)：
    JAX-WS規范是一組XML web services的JAVA API，JAX-WS允許開發者可以選擇RPC-oriented或者message-oriented 
　　    來實現自己的web services。
　　在JAX-WS中，一個遠程調用可以轉換為一個基于XML的協議例如SOAP，在使用JAX-WS過程中，開發者不需要編寫任何生成和處
　　    理SOAP消息的代碼。JAX-WS的運行時實現會將這些API的調用轉換成為對應的SOAP消息
　　缺點：我們必須借助WSDL說明書來生成一個java客戶端代碼，后期就像調用方法一樣調用

2：JAX-RS(Java API for RESTful Web Servicecs):
    是一個Java編程語言的應用程序接口，支持按照表述性狀態轉移（REST）架構風格創建Web服務。JAX-RS使用了JavaSE5引入
        的Java標注來簡化Web服務的客戶端和服務端的開發和部署。
    優點：不用編寫客戶端，只需要服務端提供RESTFul的URL調用即可

二：WebService服務端和客戶端的開發（了解）

　　注：本章節案例用的全部注解在后面專門介紹（此章只是入門案例，具體在文章后面集成說明）！！！！！

　　此章里面的方式了解即可，因為在實際開發中都是以Spring來集成CXF方式開發服務端和客戶端；

　　JAX-WS就是我們俗稱的JDK（JDK版本1.6+才可以）開發，因為JDK自帶這種方式開發客戶端和服務端

　　Apache CXF = Celtix + XFire，ApacheCXF 的前身叫 Apache CeltiXfire，現在已經正式更名為 Apache CXF 了，以下簡稱為 CXF。CXF 繼承了 Celtix 和XFire 兩大開源項目的精華，提供了對 JAX-WS 全面的支持，并且提供了多種 Binding 、DataBinding、Transport 以及各種 Format 的支持，并且可以根據實際項目的需要，采用代碼優先（Code First）或者 WSDL 優先（WSDL First）來輕松地實現 Web Services 的發布和使用。

1：使用JAX-WS開發服務端（熟悉流程）

基本實體類Student、Dog
SEI接口及接口實現類
服務發布

　　完成到這一步后我們的服務端就編寫好了，接下來我們就要測試我們當前發布的服務是否可以訪問，這時候我們就要訪問我們當前編寫服務的WSDL說明書，WSDL服務訪問必須是我們發布的服務地址后加上?wsdl才可訪問；我們通過閱讀wsdl可以確定客戶端要怎么調用該服務端，wsdl定義了接口、方法、參數、返回值，告知我們以指定規范來調用服務端

　　說明：使用JDK自帶的WebService是沒有攔截器的，在這里大家知道它沒有攔截器功能即可！！！！！！！

2：使用JAX-WS開發客戶端（熟悉流程）

　　其實客戶端調用服務端的方法有很多，但在大多情況下我們都是用工具生成客戶端代碼，這里我們就用到wsimport.exe工具（JDK的bin目錄下自帶此工具，因為JAX-WS寫的服務本身就是JDK擁有的，所以也有生成客戶端工具）是jdk自帶的webservice客戶端工具可以根據wsdl文檔生成客戶端調用代碼(java代碼)。當然，無論服務器端的WebService是用什么語言寫的，都可以生成調用webservice的客戶端代碼

客戶端調用 TestClient類

3：使用CXF_WS開發服務端（WS方式）

基本實體類Student、Dog
SEI接口及接口實現類
pom.xml坐標文件
TestMain服務端發布代碼
log4j.properties日志配置文件

　　完成到這一步后我們訪問http://127.0.0.1:9999/WebService/student?wsdl 來查看我們的wsdl說明書（注SEI接口不要添加@WebService），查詢到wsdl我們就可以開發客戶端了

4：使用CXF_WS開發客戶端（WS方式）

　　在上面我們介紹了JDK自帶的wsimport.exe執行文件，其實用此工具也是可以生成CXF_WS的客戶端代碼，但是我們既然都知道是CXF寫的了，何必不用CXF自家的客戶端生成工具呢？所以我就介紹一些CXF特有的生成客戶端工具wsdl2java

　　cxf是Apache的，所以我們要去下載一個apache-cxf-x.x按照自己合適的版本來，我下載的是apache-cxf-3.4.4.zip ，解壓后在bin目錄下就有wsdl2java工具，此時如果想隨時隨地cmd使用我們就得去配置環境變量，大家自己像maven的配置方式配置，保證可以找到cxf的bin目錄里面（我就不配置了，直接訪問到此文件夾里）

基本使用wsdl2java
    基本語法：wsdl2java -d '生成客戶端的位置' -client '?wsdl地址或者wsdl文件'

-p：      指定其wsdl的命名空間，也就是要生成代碼的包名
-d：      指定要產生代碼所在目錄
-client： 生成客戶端測試web service的代碼
-server： 生成服務器啟動web service的代碼
-impl：   生成web service的實現代碼
-ant：    生成build.xml文件
-all：    生成所有開始端點代碼：types,service proxy,,service interface, server mainline,
          client mainline, implementation object, and an Ant build.xml file.
如我當前使用：
    wsdl2java -d C:UsersxiaofDesktopclient -client http://127.0.0.1:9999/WebService/student?wsdl
    wsdl2java -d C:UsersxiaofDesktopclient -client C:UsersxiaofDesktopstudent.wsdl

　　說到這，我們就可以生成客戶端代碼在我們的項目中了，關于cxf_ws的項目我們要引入一些指定的坐標

pom.xml坐標文件
客戶端調用代碼

5：使用CXF_RS開發服務端（restful方式）

　　此結構與CXF-WS目錄是一樣的定義，只是代碼改變，此方式是沒有wsdl說明書的，客戶端無需使用WSDL來生成客戶端代碼可以直接調用

基本實體類Student、Dog
SEI接口及接口實現類
服務發布TestMain
pom.xml坐標文件
log4j.properties日志文件

注意：

①：我們在訪問時界面出現這種錯誤提示

　　提示內容：此頁面包含以下錯誤：第1列第1行上的錯誤：文檔為空。下面是直到第一個錯誤的頁面呈現

　　此原因是因為我們沒有在對應的實體類上添加@XmlRootElement注解導致無法映射為XML，從而導致文檔為空

#因為CXF_RS開發的服務端，在客戶端是可以直接調用的，比如在瀏覽器中調用Get請求http://localhost:7777/WebService/student/findAll/22響應JSON數據在瀏覽器界面

6：使用CXF_RS開發客戶端（restful方式）

　　我們使用CXF_RS開發客戶端會使用到一個叫CXF的WebClient的工具類（后面章節介紹），可以發送不同類型的請求

　　在編寫客戶端之前，我們需要把服務端的實例對象復制到客戶端里

pom.xml坐標文件
客戶端類代碼

問題：

<!--客戶端加上此坐標可以轉換為json數據-->
<!--服務端加上此坐標可以解析json數據-->

<!--下面這兩個坐標不設置就會導致 是發送端無法轉換json發送,是接收端無法把json轉換為對象接收-->
        <!--設置CXF提供者坐標-->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-rs-extension-providers</artifactId>
            <version>3.4.3</version>
        </dependency>
        <!--JSON轉換坐標,會集成到CXF的providers里-->
        <dependency>
            <groupId>org.codehaus.jettison</groupId>
            <artifactId>jettison</artifactId>
            <version>1.4.1</version>
        </dependency>

三：使用SoapUI工具監控請求及響應

　　file --> New SOAP Project 創建SOAP請求　　file --> New REST Project 創建Rest請求（后面說）

四：WSDL說明書詳細說明（重要）

　　如果你對 XML 不熟悉的請先研究一下 XML ==>直達XML學習地址學習一下 Schema 約束那一章

下面我就以如下的文件來詳細分析一下 WSDL 說明書，這個文件是由我上面的 JAX-WS 案例生成的

示例wsdl說明書：http://localhost:8888/WebService/student?wsdl
示例wsdl類型說明書：http://localhost:8888/WebService/student?xsd=1

wsdl文檔說明書是由definitions標簽來包裹，內部有 五大標簽各司其職 分別為
service、binding、portType、message、types
這五大標簽我將在下面一一介紹

1：WSDL報文之 definitions

<definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
             xmlns:wsp="http://www.w3.org/ns/ws-policy"
             xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy"
             xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"
             xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
             xmlns:tns="http://impl.webservice.xw.cn/"
             xmlns:xsd="http://www.w3.org/2001/XMLSchema"
             xmlns="http://schemas.xmlsoap.org/wsdl/"
             targetNamespace="http://impl.webservice.xw.cn/"
             name="StudentWebServiceImplService">
    <!--內部標簽省略.....`-->
</definitions>

標簽：
    definitions：根元素
        每個wsdl文件包含一個根元素，內部定義一些屬性
屬性：
    xmlns:tns：引用
        相當于Java里面的import包的反轉路徑
    name：SEI定義名稱
        我們Java程序中的接口實現類，SEI定義規則是：服務接口類+Service后綴，Service系統自動追加
    targetNamespace：命名空間
        相當于Java里面的package，它剛好是和我們定義的的包名相反
    其它屬性：出現的其它屬性不能改動，必須那樣寫，因為是整篇wsdl說明書的約束條件

2：WSDL報文之 types

　　定義Web服務里用到的，XMLSchema定義的數據類型以外的自定義數據類型，對于我們自定義的類（Student），會對應到一個<complexType>（復雜類型標簽），其中用<element>元素指定每個參數的類型。

<types>
    <xsd:schema>
        <xsd:import namespace="http://impl.webservice.xw.cn/"
                    schemaLocation="http://localhost:8888/WebService/student?xsd=1"/>
    </xsd:schema>
</types>

標簽：types
    定義Web服務中用到的請求與響應的數據類型
標簽：xsd:schema
    約束標簽，用來指定內部類型按照指定規范編寫
標簽：xsd:import
    導入外部文件
    屬性：
        namespace：命名空間
        schemaLocation：約束文件地址
如下是http://localhost:8888/WebService/student?xsd=1約束文件

<xs:schema xmlns:tns="http://impl.webservice.xw.cn/"
           xmlns:xs="http://www.w3.org/2001/XMLSchema"
           version="1.0"
           targetNamespace="http://impl.webservice.xw.cn/">
<!--定義countAllStudent方法的請求類型   指定的類型是countAllStudent-->
<xs:element name="countAllStudent" type="tns:countAllStudent"/>
<!--定義countAllStudentResponse方法的響應類型   指定的類型是countAllStudentResponse-->
<xs:element name="countAllStudentResponse" type="tns:countAllStudentResponse"/>
<!--定義findByName方法的請求類型   指定的類型是findByName-->
<xs:element name="findByName" type="tns:findByName"/>
<!--定義findByNameResponse方法的響應類型   指定的類型是findByNameResponse-->
<xs:element name="findByNameResponse" type="tns:findByNameResponse"/>

<!--定義一個復雜類型，但此類型為空（就是說countAllStudent方法為空參數）-->
<xs:complexType name="countAllStudent">
    <xs:sequence/>
</xs:complexType>

<!--定義一個復雜類型，返回的是一個序列（參數按照要求位置）-->
<xs:complexType name="countAllStudentResponse">
    <xs:sequence>
        <!--此處告訴我們是一個響應的return參數，此時的參數類型為int 并且至少出現0次-->
        <xs:element name="return" type="xs:int" minOccurs="0"/>
    </xs:sequence>
</xs:complexType>
<!--后面不會的請參考具體的xml學習-->
    <!--后面的省略........-->
</xs:schema>

3：WSDL報文之 message

　　具體定義了在通信中使用的消息的數據結構，Message元素包含了一組Part元素，每個Part元素都是最終消息的一個組成部分，每個Part都會引用一個DataType（就是part里的element屬性）來表示它的結構。

<message name="findByName">
    <part name="parameters" element="tns:findByName"/>
</message>
<message name="findByNameResponse">
    <part name="parameters" element="tns:findByNameResponse"/>
</message>
<message name="countAllStudent">
    <part name="parameters" element="tns:countAllStudent"/>
</message>
<message name="countAllStudentResponse">
    <part name="parameters" element="tns:countAllStudentResponse"/>
</message>

標簽：message
    用來定義請求/響應消息的結構
    屬性：
        name：方法名稱
標簽：part
    指定引用types中定義的標簽片段
    屬性：
        name：此時說明都是參數
        element：引用指定的類型，類型在types中定義
大白話：
    我們編寫的SEI實現類的某一個方法會對于的兩個message，分別對象請求message和響應message
    而不管請求還是響應message都會有參數的傳輸，比如請求的message是有個請求參數的，這個請求參數
    的類型就是在此處說明，并引用types定義的具體復雜類型

4：WSDL報文之 portType

　　Operation是對服務中所支持的操作的抽象描述，一般單個Operation描述了一個訪問入口的請求/響應消息對。
　　PortType具體定義了一種服務訪問入口的類型，就是輸入/輸出消息的模式及其格式。一個PortType可以包含若干個Operation，而一個Operation則是指訪問入口支持的一種類型的調用。在WSDL里面支持四種訪問入口調用的模式如單請求、單響應、請求/響應、響應/請求。
　　在這里請求指的是從客戶端到Web服務端，而響應指的是從Web服務端到客戶端。PortType的定義中會引用消息定義部分的一個到兩個消息，作為請求或響應消息的格式。

<portType name="StudentWebServiceImpl">
    <operation name="findByName">
        <input wsam:Action="http://impl.webservice.xw.cn/StudentWebServiceImpl/findByNameRequest"
               message="tns:findByName"/>
        <output wsam:Action="http://impl.webservice.xw.cn/StudentWebServiceImpl/findByNameResponse"
                message="tns:findByNameResponse"/>
    </operation>
    <operation name="countAllStudent">
        <input wsam:Action="http://impl.webservice.xw.cn/StudentWebServiceImpl/countAllStudentRequest"
               message="tns:countAllStudent"/>
        <output wsam:Action="http://impl.webservice.xw.cn/StudentWebServiceImpl/countAllStudentResponse"
                message="tns:countAllStudentResponse"/>
    </operation>
</portType>

標簽：portType
    用來定義服務器端的SEI接口
    屬性：
        name：定義我們的實現類名稱
標簽：operation
    用來指定SEI中的處理請求的方法，一般分為請求和響應
    屬性：
        name:SEI實現類里的具體實現方法
標簽：input
    指定客戶端請求過來的數據，它會引用我們定義的message標簽來強行約束類型
    屬性：
        message：引用請求消息的約束
標簽：output
    指定服務端響應回去的數據，它會引用我們定義的message標簽來強行約束類型
    屬性：
        message：引用響應消息的約束

5：WSDL報文之 binding

　　此標簽包含了如何將抽象接口的元素(portType)轉變為具體表示的細節，具體表示也就是指特定的數據格式和協議的結合；特定端口類型的具體協議和數據格式規范的綁定。JAX-RPC規范規定，SOAP綁定可以有rpc和document兩種類型，分別表示遠程過程調用和基于消息的方式。use屬性可以是encoded或literal，對于前者要支持rpc的方式，對于后者要支持rpc和document的方式。

<binding name="StudentWebServiceImplPortBinding" type="tns:StudentWebServiceImpl">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="findByName">
        <soap:operation soapAction=""/>
        <input>
            <soap:body use="literal"/>
        </input>
        <output>
            <soap:body use="literal"/>
        </output>
    </operation>
    <operation name="countAllStudent">
        <soap:operation soapAction=""/>
        <input>
            <soap:body use="literal"/>
        </input>
        <output>
            <soap:body use="literal"/>
        </output>
    </operation>
</binding>

標簽：binding
    用于定義服務器端的SEI接口實現類
    屬性：
        name：實現類名稱
        type：此時這里是引用portType指定標簽
標簽：soap:binding
    綁定什么類型的數據用來請求響應
    屬性：
        type：綁定的數據是一個document(就是xml格式類型的請求響應)
標簽：operation
    用來指定SEI中的處理請求的方法，一般分為請求和響應
    屬性：
        name:SEI實現類里的具體實現方法
標簽：input和output
    指定客戶端請求和服務端響應過來的數據類型
    屬性：
        use：定義類型literal（文本）

結合上面可以看出當前的SEI實現類只可以用document（xml）類型來交互，并且里面的方法是使用xml的文本方式交互

6：WSDL報文之 service

　　描述的是一個具體被部署的Web服務所提供的所有訪問入口的部署細節，一個Service往往會包含多個服務訪問入口，而每個訪問入口都會使用一個Port元素來描述

<service name="StudentWebServiceImplService">
    <port name="StudentWebServiceImplPort" binding="tns:StudentWebServiceImplPortBinding">
        <soap:address location="http://localhost:8888/WebService/student"/>
    </port>
</service>

標簽：service
    一個WebService的容器
    屬性：
        name：它用來指定客戶端容器類
標簽：port
    用來指定一個服務器處理的請求入口（就是SEI的實現，理解為實現類）
    屬性：
        binding：引用具體的<binding/>標簽
        name：具體的實現類對象，正如 factory.getStudentWebServiceImplPort()獲取實現類對象
標簽：soap:address
    用來說明當前WebService的請求地址
    屬性：
        soap:address.location：標明具體的WebService請求地址

五：WebService開發常用注解介紹

1：@WebService

　　此注解主要是標注當前是個WebService服務

@WebService
    serviceName：
        對外發布的服務名，指定 WebService 的服務名稱；缺省值為Java類的非限定名稱+"Service"
            修改：wsdl:service["name"]
            修改：wsdl:definitions["name"]
    name：
        設置端口類型名稱，缺省值為Java接口或者類的非限定名稱
            修改：wsdl:portType["name"]
    portName：
        設置端口類型名稱，缺省值為端口類型名稱（就是我們設置的name或者缺省）+"Port"
            修改：wsdl:port["name"]
    targetNamespace：
        指定WebService生成的WSDL和XML元素命名空間，缺省為 "http://"+當前接口的包名倒排
            修改：wsdl:definitions["xmlns:tns"]
            修改：wsdl:definitions["targetNamespace"]
    endpointInterface：
        用于定義服務的抽象WebService的服務端點的限定名，如果指定了限定名，則會使用改服務端接口來確定抽象WSDL約束
    wsdlLocation：
        指定用于定義WebService的WSDL文檔的Web地址。Web地址可以是相對路徑或絕對路徑
注：
    ①：實現類上可以不添加 @WebService
    ②：如果@WebService在SEI實現類上添加后可以指定endpointInterface屬性來告知SEI接口限定類名

2：@WebMethod

　　此注解主要是標注WebService方法的具體名稱

@WebMethod
    operationName：
        指定SEI方法的具體名稱，缺省值為Java方法名稱
            修改：wsdl:operation["name"]
    action：
        定義操作的行為，缺省值為""
            修改：soap:operation["soapAction"]
    exclude：
        指定是否從WebService中排除某一方法，缺省值為false
注：
    ①：此注解添僅支持添加在方法上，且當前方法的類上必須存在@WebService注解才可使用
　　 ②：修改operationName會導致客戶端調用的方法名稱改變

4：@Oneway

　　此注解必須寫在帶有@WebService的類方法上，它是聲明此方法只有輸入消息而沒有輸出消息的WebService單向操作

5：@WebParam

　　此注解主要標注參數至WebService消息部件和XML元素的映射，不指定WebService參數名稱則默認xs:element["name"] = "args[0~*]"

@WebParam
    name：
        交互方法的參數名稱，如果操作是遠程過程調用（RPC）類型并且未指定partName屬性，那么這是用于表示參數的wsdl:part屬性的名稱
        如果操作是文檔類型或者參數映射至某個頭，那么name是用于表示該參數的XML元素的局部名稱。
        如果操作是文檔類型、參數類型為BARE并且方式為OUT或INOUT，那么必須指定此屬性
    targetNamespace：
        指定返回值的XML名稱空間。僅當操作類型為RPC或者操作是文檔類型并且參數類型為BARE時才使用此參數
    header：
        指定頭中是否附帶結果。缺省值為false
    partName：
        指定RPC或DOCUMENT/BARE操作的結果的部件名稱。缺省值為@WebResult.name

6：@WebResult

　　此注解主要標注從返回值至WSDL部件或XML元素的映射

@WebResult
    name：
        當返回值列是在WSDL文件中并且在連接上的消息中找到該返回值時，指定該返回值的名稱。
        對于RPC綁定，這是用于表示返回值的wsdl:part屬性的名稱。對于文檔綁定，name參數是用于表示返回值的XML元素的局部名。
        對于RPC和DOCUMENT/WRAPPED綁定，缺省值為return。對于DOCUMENT/BARE綁定，缺省值為方法名 + Response。
    targetNamespace：
        指定返回值的XML名稱空間。僅當操作類型為RPC或者操作是文檔類型并且參數類型為BARE時才使用此參數。
    header：
        指定頭中是否附帶結果。缺省值為false
    partName：
        指定RPC或DOCUMENT/BARE操作的結果的部件名稱。缺省值為@WebResult.name

7：@HandlerChain

　　注釋用于使 Web Service 與外部定義的處理程序鏈相關聯。只能通過對 SEI 或實現類使用 @HandlerChain 注釋來配置服務器端的處理程序。

　　但是可以使用多種方法來配置客戶端的處理程序。可以通過對生成的服務類或者 SEI 使用 @HandlerChain 注釋來配置客戶端的處理程序。此外，可以按程序在服務上注冊您自己的 HandlerResolver 接口實現，或者按程序在綁定對象上設置處理程序鏈。

@HandlerChain
    file：
        指定處理程序鏈文件所在的位置。文件位置可以是采用外部格式的絕對 java.net.URL，也可以是類文件中的相對路徑
    name：
        指定配置文件中處理程序鏈的名稱

8：@XmlRootElement

　　類級別的注解。將類映射為xml全局元素，也就是根元素

@XmlRootElement
    name：
        類級別的注解。將類映射為xml全局元素，也就是根元素
    namespace：
        namespace屬性用于指定生成的元素所屬的命名空間

9：@XmlSeeAlso

　　指示JAXB在綁定此類時也綁定其他類；

@XmlSeeAlso
    value：
        類級別的注解。映射屬性內部類型，value是class[]類型

@XmlRootElement(name = "Result")
@XmlSeeAlso({Student.class})
public class Result<T> {
    private Integer code;   //響應碼
    private String msg;     //響應信息
    //示例這個T可能是Student ，但也有可能會是別的類型，把可能出現的類型列舉在@XmlSeeAlso
    private List<T> data;    //響應數據
}

六：WebService開發RS方式類型特有注解

　　具體API官方文檔進入文檔使用全文匹配搜索Ctrl+f 搜索 'javax.ws.rs '

1：@Path

　　標識資源類或類方法將為其請求提供服務的URI路徑。

@Path
    value：
        設置請求路徑名稱，（和SpringMVC的@RequestMapping一個道理）

注意：資源路徑是以RSETful風格的路徑

GET方式：
    http://localhost/student/findById/23
    @Path("/student/findById/{id}")
POST方式：
    http://localhost/student/save
    @Path("/student/save")

2：@GET、@PUT、@POST、@DELETE

　　標注方法是用什么請求的HTTP才可以匹配到此方法，無屬性

3：@Produces

　　定義資源類或MessageBodyWriter的方法可以生成的媒體類型；說白了就是告訴當前方法的響應MIME媒體類型

@Produces
    value：
        MIME類型名稱
        
示例
    @Produces(value = {"application/json;charset=utf-8"})   
        返回JSON類型并且是UTF-8格式
    @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
        可以返回XML類型以及JSON類型
MediaType枚舉類定義了各種類型

類型舉例：
    text/plain              文本類型
    text/html               HTML類型
    application/json        JSON類型
    application/xml         XML類型 
    image/png               PNG類型

4：@Consumes

　　定義資源類或MessageBodyReader的方法可以接受的媒體類型；說白了就是告訴當前方法的請求MIME媒體類型

@Consumes
    value：
        MIME類型名稱

使用上和@Produces一樣，是個對應關系，一個請求和一個響應

5：@PathParam

　　將URI模板參數或包含模板參數的路徑段的值綁定到資源方法參數、資源類字段或資源類Bean屬性；說白了就是綁定RESTful風格的URL后面的參數到方法參數上

@PathParam
    value：
        綁定的名稱，注意要和URL里被{}括起來的名稱一一對應
示例：
　　@DELETE
　　@Path("/delete/{id}")
　　@Produces(value = {"application/json;charset=utf-8"})
　　void deleteById(@PathParam(value = "id") String id);

6：@MatrixParam

　　將URI的Matrix參數的值綁定到資源方法參數、資源類字段或資源類Bean屬性。

@MatrixParam
    value：
        獲取Matrix參數，名稱要和URL里的名稱對應

@MatrixParam具體使用及介紹

7：@QueryParam

　　將HTTP查詢參數的值綁定到資源方法參數、資源類字段或資源類Bean屬性。說白了就是綁定問號后的參數 ?x=x&z=z

@QueryParam
    value：
        從URL中提取指定名稱的參數;適用于?xxx=xxx&zzz=zzz

@QueryParam注解使用介紹

8：@FormParam

　　將URI模板參數或包含模板參數的路徑段的值綁定到資源方法參數、資源類字段或資源類Bean屬性。說白了就是綁定POST提交的Form參數，其中Content-Type被假設為application/x-www-formurlencoded。

@FormParam
    value:
        表單提交的鍵名稱
具體操作和@QueryParam差不多，只是@QueryParam是直接綁定URL上，而@FormParam是綁定POST提交的表單上

9：@HeaderParam

　　將HTTP標頭的值綁定到資源方法參數、資源類字段或資源類Bean屬性。說白了就是獲取請求的頭信息

@HeaderParam
    value:
        獲取請求頭信息，value填寫獲取的頭名稱（鍵）

10：@CookieParam

　　將HTTP Cookie的值綁定到資源方法參數、資源類字段或資源類Bean屬性。說白了就是獲取指定名稱Cooke值

@CookieParam
    value:
        獲取Cookie信息，value填寫獲取的指定Cookie名稱（鍵）

11：@DefaultValue

　　定義使用以下注釋之一綁定的請求元數據的默認值：PathParam,QueryParam,MatrixParam,CookieParam,FormParam,HeaderParam

@DefaultValue
    value:
        設置指定參數默認值

http://localhost:7777/WebService/testB/st001
接口：
    @GET
    @Path("testC/{id}")
    @Produces({"text/plain;charset=utf-8"})
    String testC(@PathParam("id") String id,
                 @DefaultValue("安徽大學") @QueryParam("address") String address);
實現類：
    @Override
    public String testC(String id,String address) {
        System.out.println("打印id:" + id);
        System.out.println("打印address:" + address);
        return "成功執行此方法!!";
    }

七：Spring整合CXF_WS（SOAP 重要）

1：CXF_WS開發服務端

pom.xml坐標文件編寫
實體對象Student、Dog
編寫SEI接口和SEI接口實現類（WebService服務類）
spring-cxf.xml (CXF配置文件)
applicationContext.xml （spring配置文件）
web.xml （WEB文件配置）

2：CXF_WS開發客戶端

　　開發前根據wsdl說明書來使用wsimport.exe生成具體的客戶端代碼，這里不懂的請看第二章入門案例

pom.xml坐標文件
spring-cxf.xml (CXF配置文件)
applicationContext.xml （spring配置文件）
TestClient 測試文件

八：Spring整合CXF_RS（RestFul 重要）

　　Rest是一種風格，而RestFul是一種符合Rest風格的一種架構，RestFul風格的URL是一個資源定位，通過GET、POST、PUT、DELETE來區分查增改刪方式，具體的規范請參考其它具體文章

　　我們在使用CXF_RS時我們是不用像開發WS一樣編寫完服務端還有根據WSDL說明書生成客戶端代碼，使用RS方式我們只要編寫服務端代碼，而客戶端代碼我們是不用自己編寫的，我們客戶端調用服務端方法只需要一個URL請求即可完成調用

1：CXF_RS開發服務端

　　在開發CXF_RS服務端時不理解的可以參考第二章節的入門開發方式，這里只是一個整合

實體類Student、Dog、Result
服務接口及接口實現類
spring-cxf.xml配置類
applicationContext.xml主配置類
log4j.properties日志配置
web.xml配置
pom.xml坐標文件

2：CXF_RS開發客戶端

　　其實CXF_RS開發客戶端容易，我們其實不需要生成任何的代碼來協助客戶端的編寫，我們只要借助WebClient就可以在任意的框架下使用，使用CXF_RS開發客戶端我們得保證我們的實體類與服務端的一樣

TestClient代碼
pom.xml文件

九：SpringBoot整合CXF_WS和CXF_RS

1：SpringBoot整合CXF_WS開發服務端

注：如果是我們創建BUS方法的話，那么注入到方法是必須寫方法名如springBus()，如果是直接注入就寫屬性名稱（參考配置類）

實體對象Student、Dog
SEI服務接口及SEI服務接口實現類
JaxWsConfig配置類
pom.xml坐標文件

　　我們完成上面幾步后，我們啟動SpringBoot項目后可以通過訪問?WSDL來查看我們發布的服務說明書，這時候我們客戶端就可生成客戶端代碼了

　　關于客戶端使用方式可以去參考我第二章我JAX_WS開發

2：SpringBoot整合CXF_RS開發服務端

　　Springboot整合CXF_RS開發服務端和整合CXF_WS的目錄是一樣的

實體類Student、Dog、Result
服務實現類及服務接口
JaxRsConfig配置類
pom.xml要導入的坐標

十：WebService攔截器

1：WebService攔截器介紹

　　在前面的整合和入門案例中，關于CXF_WS/CXF_RS這兩個技術中我都添加了系統的攔截器用來攔截日志的請求和響應并輸出，其實攔截器就是用來攔截我們的請求和響應，用來拒絕非法訪問，如訪問前驗證token啦，密碼驗證等等

系統攔截器：
    LoggingInInterceptor：系統請求入日志打印攔截器
    LoggingOutInterceptor：系統響應出日志打印攔截器
自定義攔截器：
    我們創建的每一個自定義攔截器都得繼承AbstractPhaseInterceptor類

要注意的是，不管是系統的攔截器還是自定義攔截器，我們都要最終添加到端點發布的
如：
    //服務端入攔截器
    List<Interceptor<? extends Message>> inInterceptors = endpoint.getInInterceptors();
    inInterceptors.add(new LoggingInInterceptor());//設置請求攔截日志
    //服務端出攔截器
    List<Interceptor<? extends Message>> outInterceptors = endpoint.getOutInterceptors();
    outInterceptors.add(new LoggingOutInterceptor());//設置響應攔截日志

2：SpringBoot整合CXF_WS并設置自定義攔截器（服務端）

　　本章我們說說SpringBoot整合CXF_WS，并設置了攔截器，請求頭設置賬號密碼都正確才可以訪問具體方法，我們復用上面的springboot整合CXF_WS的案例進一步添加功能

　　第一步我們就要創建一個自定義攔截器（入）加入容器了，用來校驗請求來的賬號密碼是否匹配

　　第二步我們再創建一個自定義的攔截器（出）加入容器了，用來都操作成功后響應攔截器寫回一些標簽屬性

InJaxWsInterceptopr入攔截器編寫，用來驗證請求過來的數據
OutJaxWsInterceptor出攔截器，用來對響應回去的數據加工

　　第三步光定義了自定義攔截器還不夠，我們要像系統攔截器一樣添加到服務發布端點里

修改JaxWsConfig端點發布配置代碼

Phase類里面定義了特別多靜態常量，常用的就是 Phase.PRE_REOTOCOL 代表請求協議和內容過來前攔截

說明：自定義攔截器拋出Fault代表攔截，什么都不拋出，正常把方法執行完代表允許放行

2：SpringBoot整合CXF_WS并設置自定義攔截器（客戶端）

　　客戶端代碼大家只需要通過wsdl2java工具生成即可，下面直接上重點調用

導入需要用到的pom.xml坐標

　　我們客戶端每次發送請求都要攜帶安全驗證賬號密碼頭，所以我直接在客戶端中設置出攔截器，用來每次創建指定的頭

JaxWsInterceptor出攔截器，來每次設置請求頭
調用服務端代碼

補充：WebService的熱部署使用JRebel插件，在IDEA就可以搜索；

作者：螞蟻小哥
出處：https://www.cnblogs.com/antLaddie/

作者：Leo_wl
　　　　出處：http://www.cnblogs.com/Leo_wl/
　　　　本文版權歸作者和博客園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責任的權利。
版權信息

總結

以上是生活随笔為你收集整理的WebService原理及重要术语的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。