WebService原理及重要术语
WebService就該這么學(xué)
一：WebService簡介
1：WebService介紹
WebService是一個平臺獨(dú)立的、低耦合的、自包含的、基于可編程的web應(yīng)用程序，可使用開放的XML來描述、發(fā)布、發(fā)現(xiàn)、協(xié)調(diào)和配置這些應(yīng)用程序，用于開發(fā)分布式交互操作的應(yīng)用程序。
WebService技術(shù)，能運(yùn)行在不同機(jī)器上的不同應(yīng)用無須借助附加的、專門的第三方軟件或硬件，就可相互交換數(shù)據(jù)或集成。依據(jù)WebService規(guī)范實(shí)施的應(yīng)用之間，無論它們所使用的語言、平臺或內(nèi)部協(xié)議是什么，都可以相互交換數(shù)據(jù)。這么說吧，其實(shí)WebService就是一種跨編程語言和跨操作系統(tǒng)平臺的遠(yuǎn)程調(diào)用技術(shù)（RPC的一種實(shí)現(xiàn)方式）。所謂可跨編程語言，就是說服務(wù)端程序和客戶端程序可以以不同的語言編寫也可以利用WebService互相調(diào)用；跨操作系統(tǒng)平臺則是指服務(wù)端程序和客戶端程序可以在不同的操作系統(tǒng)上運(yùn)行。遠(yuǎn)程調(diào)用，就是一臺計(jì)算機(jī)的應(yīng)用可以調(diào)用其他計(jì)算機(jī)上的應(yīng)用。例如：我自己編寫一個網(wǎng)站，里面想要個天氣預(yù)報的功能，這個時候我肯定去調(diào)用氣象局的接口服務(wù)而不是我自己發(fā)射衛(wèi)星來監(jiān)測天氣，再引入我網(wǎng)站里。
2：為什么使用WebService
WebService能解決跨平臺調(diào)用、跨語言調(diào)用、遠(yuǎn)程調(diào)用（RPC）
以各個網(wǎng)站顯示天氣預(yù)報功能為例，氣象中心的管理系統(tǒng)將收集的天氣信息并將數(shù)據(jù)暴露出來(通過WebService Server)，而各大站點(diǎn)的應(yīng)用就去調(diào)用它們得到天氣信息并以不同的樣式去展示(WebService Client)，我們網(wǎng)站雖然提供了天氣預(yù)報的服務(wù)，但其實(shí)它們什么也沒有做，只是簡單的調(diào)用了一下氣象中心服務(wù)器服務(wù)接口而已。
3：WebService原理及重要術(shù)語
XML、SOAP、WSDL 是構(gòu)成WebService平臺的三大技術(shù)
一：基本術(shù)語
UDDI：Universal Description, Discovery, and Integration（統(tǒng)一描述、發(fā)現(xiàn)和集成） UDDI是OASIS發(fā)起的一個開放項(xiàng)目，它使企業(yè)在互聯(lián)網(wǎng)上可以互相發(fā)現(xiàn)并且定義業(yè)務(wù)之間的交互。 SOAP：simple object access protocal（簡單對象訪問協(xié)議） ①：是一種簡單的、基于HTTP和XML的協(xié)議, 用于在WEB上交換結(jié)構(gòu)化的數(shù)據(jù)，結(jié)構(gòu)化數(shù)據(jù)實(shí)際上就是xml的數(shù)據(jù) ②：SOAP消息：請求消息和響應(yīng)消息 ③：HTTP+XML片斷 WSDL：web service definition language（WebService定義語言） ①：對應(yīng)一種類型的文件.wsdl ②：定義了WebService的服務(wù)器端與客戶端應(yīng)用交互傳遞請求和響應(yīng)數(shù)據(jù)的格式和方式 ③：一個WebService對應(yīng)一個唯一的wsdl文檔（理解為接口說明書） SEI：WebService EndPoint Interface(終端，WebService的終端接口) ①：就是WebService服務(wù)器端用來處理請求的接口；我們可以理解為是xxxWebService的各個xxxWebServiceImpl實(shí)現(xiàn)類 CXF：Celtix + XFire，一個apache的用于開發(fā)webservice服務(wù)器端和客戶端的框架
WebService基本原理
①：WebService是采用HTTP協(xié)議在客戶端和服務(wù)端之間傳輸數(shù)據(jù) ②：WebService傳輸?shù)臄?shù)據(jù)是使用XML封裝后再傳輸交互，XML的優(yōu)點(diǎn)在于它的跨平臺性（因?yàn)槭忻嫔系恼Z言基本上都支持xml解析） ③：WebService發(fā)送的請求內(nèi)容和響應(yīng)內(nèi)容都采用XML格式封裝，并增加了一些特定的HTTP消息頭，以說明HTTP消息的內(nèi)容格式，這些特定
的HTTP消息頭和XML內(nèi)容格式就是SOAP協(xié)議規(guī)定的 ④：WebService服務(wù)器端首先要通過一個WSDL文件來說明自己有什么服務(wù)可以對外調(diào)用。簡單的說，WSDL就像是一個說明書，用于
描述WebService及其方法、參數(shù)和返回值。 WSDL文件保存在Web服務(wù)器上，通過一個url地址就可以訪問到它。客戶端要調(diào)用
一個WebService服務(wù)之前，要知道該服務(wù)的WSDL文件的地址。 ⑤：WebService交互的過程就是,WebService遵循SOAP協(xié)議通過XML封裝數(shù)據(jù)，然后由Http協(xié)議來傳輸數(shù)據(jù)。 注：WebService服務(wù)提供商可以通過兩種方式來暴露它的WSDL文件地址： 1：注冊到UDDI服務(wù)器，以便被人查找 2：直接告訴給客戶端調(diào)用者 總結(jié)：要想編寫WebService接口就一定要以SOAP請求來傳輸數(shù)據(jù)（HTTP+XML），編寫完成后把服務(wù)暴露到UDDI服務(wù)器上，這時調(diào)用者
可以通過指定的URL來生成WSDL
4：WebService兩種開發(fā)方式
1：JAX-WS(Java API for XML Web Service)：
JAX-WS規(guī)范是一組XML web services的JAVA API，JAX-WS允許開發(fā)者可以選擇RPC-oriented或者message-oriented
來實(shí)現(xiàn)自己的web services。
在JAX-WS中，一個遠(yuǎn)程調(diào)用可以轉(zhuǎn)換為一個基于XML的協(xié)議例如SOAP，在使用JAX-WS過程中，開發(fā)者不需要編寫任何生成和處
理SOAP消息的代碼。JAX-WS的運(yùn)行時實(shí)現(xiàn)會將這些API的調(diào)用轉(zhuǎn)換成為對應(yīng)的SOAP消息
缺點(diǎn)：我們必須借助WSDL說明書來生成一個java客戶端代碼，后期就像調(diào)用方法一樣調(diào)用
2：JAX-RS(Java API for RESTful Web Servicecs):
是一個Java編程語言的應(yīng)用程序接口，支持按照表述性狀態(tài)轉(zhuǎn)移（REST）架構(gòu)風(fēng)格創(chuàng)建Web服務(wù)。JAX-RS使用了JavaSE5引入
的Java標(biāo)注來簡化Web服務(wù)的客戶端和服務(wù)端的開發(fā)和部署。
優(yōu)點(diǎn)：不用編寫客戶端，只需要服務(wù)端提供RESTFul的URL調(diào)用即可
二：WebService服務(wù)端和客戶端的開發(fā)（了解）
注：本章節(jié)案例用的全部注解在后面專門介紹（此章只是入門案例，具體在文章后面集成說明）！！！！！
此章里面的方式了解即可，因?yàn)樵?strong>實(shí)際開發(fā)中都是以Spring來集成CXF方式開發(fā)服務(wù)端和客戶端；
JAX-WS就是我們俗稱的JDK（JDK版本1.6+才可以）開發(fā)，因?yàn)镴DK自帶這種方式開發(fā)客戶端和服務(wù)端
Apache CXF = Celtix + XFire，ApacheCXF 的前身叫 Apache CeltiXfire，現(xiàn)在已經(jīng)正式更名為 Apache CXF 了，以下簡稱為 CXF。CXF 繼承了 Celtix 和XFire 兩大開源項(xiàng)目的精華，提供了對 JAX-WS 全面的支持，并且提供了多種 Binding 、DataBinding、Transport 以及各種 Format 的支持，并且可以根據(jù)實(shí)際項(xiàng)目的需要，采用代碼優(yōu)先（Code First）或者 WSDL 優(yōu)先（WSDL First）來輕松地實(shí)現(xiàn) Web Services 的發(fā)布和使用。
1：使用JAX-WS開發(fā)服務(wù)端（熟悉流程）
基本實(shí)體類Student、Dog
SEI接口及接口實(shí)現(xiàn)類
服務(wù)發(fā)布
完成到這一步后我們的服務(wù)端就編寫好了，接下來我們就要測試我們當(dāng)前發(fā)布的服務(wù)是否可以訪問，這時候我們就要訪問我們當(dāng)前編寫服務(wù)的WSDL說明書，WSDL服務(wù)訪問必須是我們發(fā)布的服務(wù)地址后加上?wsdl才可訪問；我們通過閱讀wsdl可以確定客戶端要怎么調(diào)用該服務(wù)端，wsdl定義了接口、方法、參數(shù)、返回值，告知我們以指定規(guī)范來調(diào)用服務(wù)端
說明：使用JDK自帶的WebService是沒有攔截器的，在這里大家知道它沒有攔截器功能即可！！！！！！！
2：使用JAX-WS開發(fā)客戶端（熟悉流程）
其實(shí)客戶端調(diào)用服務(wù)端的方法有很多，但在大多情況下我們都是用工具生成客戶端代碼，這里我們就用到wsimport.exe工具（JDK的bin目錄下自帶此工具，因?yàn)镴AX-WS寫的服務(wù)本身就是JDK擁有的，所以也有生成客戶端工具）是jdk自帶的webservice客戶端工具可以根據(jù)wsdl文檔生成客戶端調(diào)用代碼(java代碼)。當(dāng)然，無論服務(wù)器端的WebService是用什么語言寫的，都可以生成調(diào)用webservice的客戶端代碼
客戶端調(diào)用 TestClient類
3：使用CXF_WS開發(fā)服務(wù)端（WS方式）
基本實(shí)體類Student、Dog
SEI接口及接口實(shí)現(xiàn)類
pom.xml坐標(biāo)文件
TestMain服務(wù)端發(fā)布代碼
log4j.properties日志配置文件
完成到這一步后我們訪問http://127.0.0.1:9999/WebService/student?wsdl 來查看我們的wsdl說明書（注SEI接口不要添加@WebService），查詢到wsdl我們就可以開發(fā)客戶端了
4：使用CXF_WS開發(fā)客戶端（WS方式）
在上面我們介紹了JDK自帶的wsimport.exe執(zhí)行文件，其實(shí)用此工具也是可以生成CXF_WS的客戶端代碼，但是我們既然都知道是CXF寫的了，何必不用CXF自家的客戶端生成工具呢？所以我就介紹一些CXF特有的生成客戶端工具wsdl2java
cxf是Apache的，所以我們要去下載一個apache-cxf-x.x按照自己合適的版本來，我下載的是apache-cxf-3.4.4.zip ，解壓后在bin目錄下就有wsdl2java工具，此時如果想隨時隨地cmd使用我們就得去配置環(huán)境變量，大家自己像maven的配置方式配置，保證可以找到cxf的bin目錄里面（我就不配置了，直接訪問到此文件夾里）
基本使用wsdl2java
基本語法：wsdl2java -d '生成客戶端的位置' -client '?wsdl地址或者wsdl文件'
-p： 指定其wsdl的命名空間，也就是要生成代碼的包名
-d： 指定要產(chǎn)生代碼所在目錄
-client： 生成客戶端測試web service的代碼
-server： 生成服務(wù)器啟動web service的代碼
-impl： 生成web service的實(shí)現(xiàn)代碼
-ant： 生成build.xml文件
-all： 生成所有開始端點(diǎn)代碼：types,service proxy,,service interface, server mainline,
client mainline, implementation object, and an Ant build.xml file.
如我當(dāng)前使用：
wsdl2java -d C:UsersxiaofDesktopclient -client http://127.0.0.1:9999/WebService/student?wsdl
wsdl2java -d C:UsersxiaofDesktopclient -client C:UsersxiaofDesktopstudent.wsdl
說到這，我們就可以生成客戶端代碼在我們的項(xiàng)目中了，關(guān)于cxf_ws的項(xiàng)目我們要引入一些指定的坐標(biāo)
pom.xml坐標(biāo)文件
客戶端調(diào)用代碼
5：使用CXF_RS開發(fā)服務(wù)端（restful方式）
此結(jié)構(gòu)與CXF-WS目錄是一樣的定義，只是代碼改變，此方式是沒有wsdl說明書的，客戶端無需使用WSDL來生成客戶端代碼可以直接調(diào)用
基本實(shí)體類Student、Dog
SEI接口及接口實(shí)現(xiàn)類
服務(wù)發(fā)布TestMain
pom.xml坐標(biāo)文件
log4j.properties日志文件
注意：
①：我們在訪問時界面出現(xiàn)這種錯誤提示
提示內(nèi)容：此頁面包含以下錯誤：第1列第1行上的錯誤：文檔為空。下面是直到第一個錯誤的頁面呈現(xiàn)
此原因是因?yàn)槲覀儧]有在對應(yīng)的實(shí)體類上添加@XmlRootElement注解導(dǎo)致無法映射為XML，從而導(dǎo)致文檔為空
#因?yàn)镃XF_RS開發(fā)的服務(wù)端，在客戶端是可以直接調(diào)用的，比如在瀏覽器中調(diào)用Get請求http://localhost:7777/WebService/student/findAll/22響應(yīng)JSON數(shù)據(jù)在瀏覽器界面
6：使用CXF_RS開發(fā)客戶端（restful方式）
我們使用CXF_RS開發(fā)客戶端會使用到一個叫CXF的WebClient的工具類（后面章節(jié)介紹），可以發(fā)送不同類型的請求
在編寫客戶端之前，我們需要把服務(wù)端的實(shí)例對象復(fù)制到客戶端里
pom.xml坐標(biāo)文件
客戶端類代碼
問題：
<!--客戶端加上此坐標(biāo)可以轉(zhuǎn)換為json數(shù)據(jù)-->
<!--服務(wù)端加上此坐標(biāo)可以解析json數(shù)據(jù)-->
<!--下面這兩個坐標(biāo)不設(shè)置就會導(dǎo)致 是發(fā)送端無法轉(zhuǎn)換json發(fā)送,是接收端無法把json轉(zhuǎn)換為對象接收-->
<!--設(shè)置CXF提供者坐標(biāo)-->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-extension-providers</artifactId>
<version>3.4.3</version>
</dependency>
<!--JSON轉(zhuǎn)換坐標(biāo),會集成到CXF的providers里-->
<dependency>
<groupId>org.codehaus.jettison</groupId>
<artifactId>jettison</artifactId>
<version>1.4.1</version>
</dependency>
三：使用SoapUI工具監(jiān)控請求及響應(yīng)
file --> New SOAP Project 創(chuàng)建SOAP請求 file --> New REST Project 創(chuàng)建Rest請求（后面說）
四：WSDL說明書詳細(xì)說明（重要）
如果你對 XML 不熟悉的請先研究一下 XML ==>直達(dá)XML學(xué)習(xí)地址學(xué)習(xí)一下 Schema 約束那一章
下面我就以如下的文件來詳細(xì)分析一下 WSDL 說明書，這個文件是由我上面的 JAX-WS 案例生成的
示例wsdl說明書：http://localhost:8888/WebService/student?wsdl
示例wsdl類型說明書：http://localhost:8888/WebService/student?xsd=1
wsdl文檔說明書是由definitions標(biāo)簽來包裹，內(nèi)部有 五大標(biāo)簽各司其職 分別為 service、binding、portType、message、types 這五大標(biāo)簽我將在下面一一介紹
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">
<!--內(nèi)部標(biāo)簽省略.....`-->
</definitions>
標(biāo)簽：
definitions：根元素
每個wsdl文件包含一個根元素，內(nèi)部定義一些屬性
屬性：
xmlns:tns：引用
相當(dāng)于Java里面的import包的反轉(zhuǎn)路徑
name：SEI定義名稱
我們Java程序中的接口實(shí)現(xiàn)類，SEI定義規(guī)則是：服務(wù)接口類+Service后綴，Service系統(tǒng)自動追加
targetNamespace：命名空間
相當(dāng)于Java里面的package，它剛好是和我們定義的的包名相反
其它屬性：出現(xiàn)的其它屬性不能改動，必須那樣寫，因?yàn)槭钦獁sdl說明書的約束條件
2：WSDL報文之 types
定義Web服務(wù)里用到的，XMLSchema定義的數(shù)據(jù)類型以外的自定義數(shù)據(jù)類型，對于我們自定義的類（Student），會對應(yīng)到一個<complexType>（復(fù)雜類型標(biāo)簽），其中用<element>元素指定每個參數(shù)的類型。
<types>
<xsd:schema>
<xsd:import namespace="http://impl.webservice.xw.cn/"
schemaLocation="http://localhost:8888/WebService/student?xsd=1"/>
</xsd:schema>
</types>
標(biāo)簽：types
定義Web服務(wù)中用到的請求與響應(yīng)的數(shù)據(jù)類型
標(biāo)簽：xsd:schema
約束標(biāo)簽，用來指定內(nèi)部類型按照指定規(guī)范編寫
標(biāo)簽：xsd:import
導(dǎo)入外部文件
屬性：
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方法的響應(yīng)類型 指定的類型是countAllStudentResponse-->
<xs:element name="countAllStudentResponse" type="tns:countAllStudentResponse"/>
<!--定義findByName方法的請求類型 指定的類型是findByName-->
<xs:element name="findByName" type="tns:findByName"/>
<!--定義findByNameResponse方法的響應(yīng)類型 指定的類型是findByNameResponse-->
<xs:element name="findByNameResponse" type="tns:findByNameResponse"/>
<!--定義一個復(fù)雜類型，但此類型為空（就是說countAllStudent方法為空參數(shù)）-->
<xs:complexType name="countAllStudent">
<xs:sequence/>
</xs:complexType>
<!--定義一個復(fù)雜類型，返回的是一個序列（參數(shù)按照要求位置）-->
<xs:complexType name="countAllStudentResponse">
<xs:sequence>
<!--此處告訴我們是一個響應(yīng)的return參數(shù)，此時的參數(shù)類型為int 并且至少出現(xiàn)0次-->
<xs:element name="return" type="xs:int" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<!--后面不會的請參考具體的xml學(xué)習(xí)-->
<!--后面的省略........-->
</xs:schema>
3：WSDL報文之 message
具體定義了在通信中使用的消息的數(shù)據(jù)結(jié)構(gòu)，Message元素包含了一組Part元素，每個Part元素都是最終消息的一個組成部分，每個Part都會引用一個DataType（就是part里的element屬性）來表示它的結(jié)構(gòu)。
<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>
標(biāo)簽：message
用來定義請求/響應(yīng)消息的結(jié)構(gòu)
屬性：
name：方法名稱
標(biāo)簽：part
指定引用types中定義的標(biāo)簽片段
屬性：
name：此時說明都是參數(shù)
element：引用指定的類型，類型在types中定義
大白話：
我們編寫的SEI實(shí)現(xiàn)類的某一個方法會對于的兩個message，分別對象請求message和響應(yīng)message
而不管請求還是響應(yīng)message都會有參數(shù)的傳輸，比如請求的message是有個請求參數(shù)的，這個請求參數(shù)
的類型就是在此處說明，并引用types定義的具體復(fù)雜類型
4：WSDL報文之 portType
Operation是對服務(wù)中所支持的操作的抽象描述，一般單個Operation描述了一個訪問入口的請求/響應(yīng)消息對。
PortType具體定義了一種服務(wù)訪問入口的類型，就是輸入/輸出消息的模式及其格式。一個PortType可以包含若干個Operation，而一個Operation則是指訪問入口支持的一種類型的調(diào)用。在WSDL里面支持四種訪問入口調(diào)用的模式如單請求、單響應(yīng)、請求/響應(yīng)、響應(yīng)/請求。
在這里請求指的是從客戶端到Web服務(wù)端，而響應(yīng)指的是從Web服務(wù)端到客戶端。PortType的定義中會引用消息定義部分的一個到兩個消息，作為請求或響應(yīng)消息的格式。
<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>
標(biāo)簽：portType
用來定義服務(wù)器端的SEI接口
屬性：
name：定義我們的實(shí)現(xiàn)類名稱
標(biāo)簽：operation
用來指定SEI中的處理請求的方法，一般分為請求和響應(yīng)
屬性：
name:SEI實(shí)現(xiàn)類里的具體實(shí)現(xiàn)方法
標(biāo)簽：input
指定客戶端請求過來的數(shù)據(jù)，它會引用我們定義的message標(biāo)簽來強(qiáng)行約束類型
屬性：
message：引用請求消息的約束
標(biāo)簽：output
指定服務(wù)端響應(yīng)回去的數(shù)據(jù)，它會引用我們定義的message標(biāo)簽來強(qiáng)行約束類型
屬性：
message：引用響應(yīng)消息的約束
5：WSDL報文之 binding
此標(biāo)簽包含了如何將抽象接口的元素(portType)轉(zhuǎn)變?yōu)榫唧w表示的細(xì)節(jié)，具體表示也就是指特定的數(shù)據(jù)格式和協(xié)議的結(jié)合；特定端口類型的具體協(xié)議和數(shù)據(jù)格式規(guī)范的綁定。JAX-RPC規(guī)范規(guī)定，SOAP綁定可以有rpc和document兩種類型，分別表示遠(yuǎn)程過程調(diào)用和基于消息的方式。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>
標(biāo)簽：binding
用于定義服務(wù)器端的SEI接口實(shí)現(xiàn)類
屬性：
name：實(shí)現(xiàn)類名稱
type：此時這里是引用portType指定標(biāo)簽
標(biāo)簽：soap:binding
綁定什么類型的數(shù)據(jù)用來請求響應(yīng)
屬性：
type：綁定的數(shù)據(jù)是一個document(就是xml格式類型的請求響應(yīng))
標(biāo)簽：operation
用來指定SEI中的處理請求的方法，一般分為請求和響應(yīng)
屬性：
name:SEI實(shí)現(xiàn)類里的具體實(shí)現(xiàn)方法
標(biāo)簽：input和output
指定客戶端請求和服務(wù)端響應(yīng)過來的數(shù)據(jù)類型
屬性：
use：定義類型literal（文本）
結(jié)合上面可以看出當(dāng)前的SEI實(shí)現(xiàn)類只可以用document（xml）類型來交互，并且里面的方法是使用xml的文本方式交互
6：WSDL報文之 service
描述的是一個具體被部署的Web服務(wù)所提供的所有訪問入口的部署細(xì)節(jié)，一個Service往往會包含多個服務(wù)訪問入口，而每個訪問入口都會使用一個Port元素來描述
<service name="StudentWebServiceImplService">
<port name="StudentWebServiceImplPort" binding="tns:StudentWebServiceImplPortBinding">
<soap:address location="http://localhost:8888/WebService/student"/>
</port>
</service>
標(biāo)簽：service
一個WebService的容器
屬性：
name：它用來指定客戶端容器類
標(biāo)簽：port
用來指定一個服務(wù)器處理的請求入口（就是SEI的實(shí)現(xiàn)，理解為實(shí)現(xiàn)類）
屬性：
binding：引用具體的<binding/>標(biāo)簽
name：具體的實(shí)現(xiàn)類對象，正如 factory.getStudentWebServiceImplPort()獲取實(shí)現(xiàn)類對象
標(biāo)簽：soap:address
用來說明當(dāng)前WebService的請求地址
屬性：
soap:address.location：標(biāo)明具體的WebService請求地址
五：WebService開發(fā)常用注解介紹
1：@WebService
此注解主要是標(biāo)注當(dāng)前是個WebService服務(wù)
@WebService
serviceName：
對外發(fā)布的服務(wù)名，指定 WebService 的服務(wù)名稱；缺省值為Java類的非限定名稱+"Service"
修改：wsdl:service["name"]
修改：wsdl:definitions["name"]
name：
設(shè)置端口類型名稱，缺省值為Java接口或者類的非限定名稱
修改：wsdl:portType["name"]
portName：
設(shè)置端口類型名稱，缺省值為端口類型名稱（就是我們設(shè)置的name或者缺省）+"Port"
修改：wsdl:port["name"]
targetNamespace：
指定WebService生成的WSDL和XML元素命名空間，缺省為 "http://"+當(dāng)前接口的包名倒排
修改：wsdl:definitions["xmlns:tns"]
修改：wsdl:definitions["targetNamespace"]
endpointInterface：
用于定義服務(wù)的抽象WebService的服務(wù)端點(diǎn)的限定名，如果指定了限定名，則會使用改服務(wù)端接口來確定抽象WSDL約束
wsdlLocation：
指定用于定義WebService的WSDL文檔的Web地址。Web地址可以是相對路徑或絕對路徑
注：
①：實(shí)現(xiàn)類上可以不添加 @WebService
②：如果@WebService在SEI實(shí)現(xiàn)類上添加后可以指定endpointInterface屬性來告知SEI接口限定類名
2：@WebMethod
此注解主要是標(biāo)注WebService方法的具體名稱
@WebMethod
operationName：
指定SEI方法的具體名稱，缺省值為Java方法名稱
修改：wsdl:operation["name"]
action：
定義操作的行為，缺省值為""
修改：soap:operation["soapAction"]
exclude：
指定是否從WebService中排除某一方法，缺省值為false
注：
①：此注解添僅支持添加在方法上，且當(dāng)前方法的類上必須存在@WebService注解才可使用
②：修改operationName會導(dǎo)致客戶端調(diào)用的方法名稱改變
4：@Oneway
此注解必須寫在帶有@WebService的類方法上，它是聲明此方法只有輸入消息而沒有輸出消息的WebService單向操作
5：@WebParam
此注解主要標(biāo)注參數(shù)至WebService消息部件和XML元素的映射，不指定WebService參數(shù)名稱則默認(rèn)xs:element["name"] = "args[0~*]"
@WebParam
name：
交互方法的參數(shù)名稱，如果操作是遠(yuǎn)程過程調(diào)用（RPC）類型并且未指定partName屬性，那么這是用于表示參數(shù)的wsdl:part屬性的名稱
如果操作是文檔類型或者參數(shù)映射至某個頭，那么name是用于表示該參數(shù)的XML元素的局部名稱。
如果操作是文檔類型、參數(shù)類型為BARE并且方式為OUT或INOUT，那么必須指定此屬性
targetNamespace：
指定返回值的XML名稱空間。僅當(dāng)操作類型為RPC或者操作是文檔類型并且參數(shù)類型為BARE時才使用此參數(shù)
header：
指定頭中是否附帶結(jié)果。缺省值為false
partName：
指定RPC或DOCUMENT/BARE操作的結(jié)果的部件名稱。缺省值為@WebResult.name
6：@WebResult
此注解主要標(biāo)注從返回值至WSDL部件或XML元素的映射
@WebResult
name：
當(dāng)返回值列是在WSDL文件中并且在連接上的消息中找到該返回值時，指定該返回值的名稱。
對于RPC綁定，這是用于表示返回值的wsdl:part屬性的名稱。對于文檔綁定，name參數(shù)是用于表示返回值的XML元素的局部名。
對于RPC和DOCUMENT/WRAPPED綁定，缺省值為return。對于DOCUMENT/BARE綁定，缺省值為方法名 + Response。
targetNamespace：
指定返回值的XML名稱空間。僅當(dāng)操作類型為RPC或者操作是文檔類型并且參數(shù)類型為BARE時才使用此參數(shù)。
header：
指定頭中是否附帶結(jié)果。缺省值為false
partName：
指定RPC或DOCUMENT/BARE操作的結(jié)果的部件名稱。缺省值為@WebResult.name
7：@HandlerChain
注釋用于使 Web Service 與外部定義的處理程序鏈相關(guān)聯(lián)。只能通過對 SEI 或?qū)崿F(xiàn)類使用 @HandlerChain 注釋來配置服務(wù)器端的處理程序。
但是可以使用多種方法來配置客戶端的處理程序。可以通過對生成的服務(wù)類或者 SEI 使用 @HandlerChain 注釋來配置客戶端的處理程序。此外，可以按程序在服務(wù)上注冊您自己的 HandlerResolver 接口實(shí)現(xiàn)，或者按程序在綁定對象上設(shè)置處理程序鏈。
@HandlerChain
file：
指定處理程序鏈文件所在的位置。文件位置可以是采用外部格式的絕對 java.net.URL，也可以是類文件中的相對路徑
name：
指定配置文件中處理程序鏈的名稱
8：@XmlRootElement
類級別的注解。將類映射為xml全局元素，也就是根元素
@XmlRootElement
name：
類級別的注解。將類映射為xml全局元素，也就是根元素
namespace：
namespace屬性用于指定生成的元素所屬的命名空間
9：@XmlSeeAlso
指示JAXB在綁定此類時也綁定其他類；
@XmlSeeAlso
value：
類級別的注解。映射屬性內(nèi)部類型，value是class[]類型
@XmlRootElement(name = "Result")
@XmlSeeAlso({Student.class})
public class Result<T> {
private Integer code; //響應(yīng)碼
private String msg; //響應(yīng)信息
//示例這個T可能是Student ，但也有可能會是別的類型，把可能出現(xiàn)的類型列舉在@XmlSeeAlso
private List<T> data; //響應(yīng)數(shù)據(jù)
}
六：WebService開發(fā)RS方式類型特有注解
具體API官方文檔進(jìn)入文檔使用全文匹配搜索Ctrl+f 搜索 'javax.ws.rs '
1：@Path
標(biāo)識資源類或類方法將為其請求提供服務(wù)的URI路徑。
@Path
value：
設(shè)置請求路徑名稱，（和SpringMVC的@RequestMapping一個道理）
注意：資源路徑是以RSETful風(fēng)格的路徑
GET方式：
http://localhost/student/findById/23
@Path("/student/findById/{id}")
POST方式：
http://localhost/student/save
@Path("/student/save")
2：@GET、@PUT、@POST、@DELETE
標(biāo)注方法是用什么請求的HTTP才可以匹配到此方法，無屬性
3：@Produces
定義資源類或MessageBodyWriter的方法可以生成的媒體類型；說白了就是告訴當(dāng)前方法的響應(yīng)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的方法可以接受的媒體類型；說白了就是告訴當(dāng)前方法的請求MIME媒體類型
@Consumes
value：
MIME類型名稱
使用上和@Produces一樣，是個對應(yīng)關(guān)系，一個請求和一個響應(yīng)
5：@PathParam
將URI模板參數(shù)或包含模板參數(shù)的路徑段的值綁定到資源方法參數(shù)、資源類字段或資源類Bean屬性；說白了就是綁定RESTful風(fēng)格的URL后面的參數(shù)到方法參數(shù)上
@PathParam
value：
綁定的名稱，注意要和URL里被{}括起來的名稱一一對應(yīng)
示例：
@DELETE
@Path("/delete/{id}")
@Produces(value = {"application/json;charset=utf-8"})
void deleteById(@PathParam(value = "id") String id);
6：@MatrixParam
將URI的Matrix參數(shù)的值綁定到資源方法參數(shù)、資源類字段或資源類Bean屬性。
@MatrixParam
value：
獲取Matrix參數(shù)，名稱要和URL里的名稱對應(yīng)
@MatrixParam具體使用及介紹
7：@QueryParam
將HTTP查詢參數(shù)的值綁定到資源方法參數(shù)、資源類字段或資源類Bean屬性。說白了就是綁定問號后的參數(shù) ?x=x&z=z
@QueryParam
value：
從URL中提取指定名稱的參數(shù);適用于?xxx=xxx&zzz=zzz
@QueryParam注解使用介紹
8：@FormParam
將URI模板參數(shù)或包含模板參數(shù)的路徑段的值綁定到資源方法參數(shù)、資源類字段或資源類Bean屬性。說白了就是綁定POST提交的Form參數(shù)，其中Content-Type被假設(shè)為application/x-www-formurlencoded。
@FormParam
value:
表單提交的鍵名稱
具體操作和@QueryParam差不多，只是@QueryParam是直接綁定URL上，而@FormParam是綁定POST提交的表單上
9：@HeaderParam
將HTTP標(biāo)頭的值綁定到資源方法參數(shù)、資源類字段或資源類Bean屬性。說白了就是獲取請求的頭信息
@HeaderParam
value:
獲取請求頭信息，value填寫獲取的頭名稱（鍵）
10：@CookieParam
將HTTP Cookie的值綁定到資源方法參數(shù)、資源類字段或資源類Bean屬性。說白了就是獲取指定名稱Cooke值
@CookieParam
value:
獲取Cookie信息，value填寫獲取的指定Cookie名稱（鍵）
11：@DefaultValue
定義使用以下注釋之一綁定的請求元數(shù)據(jù)的默認(rèn)值：PathParam,QueryParam,MatrixParam,CookieParam,FormParam,HeaderParam
@DefaultValue
value:
設(shè)置指定參數(shù)默認(rèn)值
http://localhost:7777/WebService/testB/st001
接口：
@GET
@Path("testC/{id}")
@Produces({"text/plain;charset=utf-8"})
String testC(@PathParam("id") String id,
@DefaultValue("安徽大學(xué)") @QueryParam("address") String address);
實(shí)現(xiàn)類：
@Override
public String testC(String id,String address) {
System.out.println("打印id:" + id);
System.out.println("打印address:" + address);
return "成功執(zhí)行此方法!!";
}
七：Spring整合CXF_WS（SOAP 重要）
1：CXF_WS開發(fā)服務(wù)端
pom.xml坐標(biāo)文件編寫
實(shí)體對象Student、Dog
編寫SEI接口和SEI接口實(shí)現(xiàn)類（WebService服務(wù)類）
spring-cxf.xml (CXF配置文件)
applicationContext.xml （spring配置文件）
web.xml （WEB文件配置）
2：CXF_WS開發(fā)客戶端
開發(fā)前根據(jù)wsdl說明書來使用wsimport.exe生成具體的客戶端代碼，這里不懂的請看第二章入門案例
pom.xml坐標(biāo)文件
spring-cxf.xml (CXF配置文件)
applicationContext.xml （spring配置文件）
TestClient 測試文件
八：Spring整合CXF_RS（RestFul 重要）
Rest是一種風(fēng)格，而RestFul是一種符合Rest風(fēng)格的一種架構(gòu)，RestFul風(fēng)格的URL是一個資源定位，通過GET、POST、PUT、DELETE來區(qū)分查增改刪方式，具體的規(guī)范請參考其它具體文章
我們在使用CXF_RS時我們是不用像開發(fā)WS一樣編寫完服務(wù)端還有根據(jù)WSDL說明書生成客戶端代碼，使用RS方式我們只要編寫服務(wù)端代碼，而客戶端代碼我們是不用自己編寫的，我們客戶端調(diào)用服務(wù)端方法只需要一個URL請求即可完成調(diào)用
1：CXF_RS開發(fā)服務(wù)端
在開發(fā)CXF_RS服務(wù)端時不理解的可以參考第二章節(jié)的入門開發(fā)方式，這里只是一個整合
實(shí)體類Student、Dog、Result
服務(wù)接口及接口實(shí)現(xiàn)類
spring-cxf.xml配置類
applicationContext.xml主配置類
log4j.properties日志配置
web.xml配置
pom.xml坐標(biāo)文件
2：CXF_RS開發(fā)客戶端
其實(shí)CXF_RS開發(fā)客戶端容易，我們其實(shí)不需要生成任何的代碼來協(xié)助客戶端的編寫，我們只要借助WebClient就可以在任意的框架下使用，使用CXF_RS開發(fā)客戶端我們得保證我們的實(shí)體類與服務(wù)端的一樣
TestClient代碼
pom.xml文件
九：SpringBoot整合CXF_WS和CXF_RS
1：SpringBoot整合CXF_WS開發(fā)服務(wù)端
注：如果是我們創(chuàng)建BUS方法的話，那么注入到方法是必須寫方法名如springBus()，如果是直接注入就寫屬性名稱（參考配置類）
實(shí)體對象Student、Dog
SEI服務(wù)接口及SEI服務(wù)接口實(shí)現(xiàn)類
JaxWsConfig配置類
pom.xml坐標(biāo)文件
我們完成上面幾步后，我們啟動SpringBoot項(xiàng)目后可以通過訪問?WSDL來查看我們發(fā)布的服務(wù)說明書，這時候我們客戶端就可生成客戶端代碼了
關(guān)于客戶端使用方式可以去參考我第二章我JAX_WS開發(fā)
2：SpringBoot整合CXF_RS開發(fā)服務(wù)端
Springboot整合CXF_RS開發(fā)服務(wù)端和整合CXF_WS的目錄是一樣的
實(shí)體類Student、Dog、Result
服務(wù)實(shí)現(xiàn)類及服務(wù)接口
JaxRsConfig配置類
pom.xml要導(dǎo)入的坐標(biāo)
十：WebService攔截器
1：WebService攔截器介紹
在前面的整合和入門案例中，關(guān)于CXF_WS/CXF_RS這兩個技術(shù)中我都添加了系統(tǒng)的攔截器用來攔截日志的請求和響應(yīng)并輸出，其實(shí)攔截器就是用來攔截我們的請求和響應(yīng)，用來拒絕非法訪問，如訪問前驗(yàn)證token啦，密碼驗(yàn)證等等
系統(tǒng)攔截器：
LoggingInInterceptor：系統(tǒng)請求入日志打印攔截器
LoggingOutInterceptor：系統(tǒng)響應(yīng)出日志打印攔截器
自定義攔截器：
我們創(chuàng)建的每一個自定義攔截器都得繼承AbstractPhaseInterceptor類
要注意的是，不管是系統(tǒng)的攔截器還是自定義攔截器，我們都要最終添加到端點(diǎn)發(fā)布的
如：
//服務(wù)端入攔截器
List<Interceptor<? extends Message>> inInterceptors = endpoint.getInInterceptors();
inInterceptors.add(new LoggingInInterceptor());//設(shè)置請求攔截日志
//服務(wù)端出攔截器
List<Interceptor<? extends Message>> outInterceptors = endpoint.getOutInterceptors();
outInterceptors.add(new LoggingOutInterceptor());//設(shè)置響應(yīng)攔截日志
2：SpringBoot整合CXF_WS并設(shè)置自定義攔截器（服務(wù)端）
本章我們說說SpringBoot整合CXF_WS，并設(shè)置了攔截器，請求頭設(shè)置賬號密碼都正確才可以訪問具體方法，我們復(fù)用上面的springboot整合CXF_WS的案例進(jìn)一步添加功能
第一步我們就要創(chuàng)建一個自定義攔截器（入）加入容器了，用來校驗(yàn)請求來的賬號密碼是否匹配
第二步我們再創(chuàng)建一個自定義的攔截器（出）加入容器了，用來都操作成功后響應(yīng)攔截器寫回一些標(biāo)簽屬性
InJaxWsInterceptopr入攔截器編寫，用來驗(yàn)證請求過來的數(shù)據(jù)
OutJaxWsInterceptor出攔截器，用來對響應(yīng)回去的數(shù)據(jù)加工
第三步光定義了自定義攔截器還不夠，我們要像系統(tǒng)攔截器一樣添加到服務(wù)發(fā)布端點(diǎn)里
修改JaxWsConfig端點(diǎn)發(fā)布配置代碼
Phase類里面定義了特別多靜態(tài)常量，常用的就是 Phase.PRE_REOTOCOL 代表請求協(xié)議和內(nèi)容過來前攔截
說明：自定義攔截器拋出Fault代表攔截，什么都不拋出，正常把方法執(zhí)行完代表允許放行
2：SpringBoot整合CXF_WS并設(shè)置自定義攔截器（客戶端）
客戶端代碼大家只需要通過wsdl2java工具生成即可，下面直接上重點(diǎn)調(diào)用
導(dǎo)入需要用到的pom.xml坐標(biāo)
我們客戶端每次發(fā)送請求都要攜帶安全驗(yàn)證賬號密碼頭，所以我直接在客戶端中設(shè)置出攔截器，用來每次創(chuàng)建指定的頭
JaxWsInterceptor出攔截器，來每次設(shè)置請求頭
調(diào)用服務(wù)端代碼
補(bǔ)充：WebService的熱部署使用JRebel插件，在IDEA就可以搜索；
作者：螞蟻小哥
出處：https://www.cnblogs.com/antLaddie/
作者：Leo_wl
出處：http://www.cnblogs.com/Leo_wl/
本文版權(quán)歸作者和博客園共有，歡迎轉(zhuǎn)載，但未經(jīng)作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責(zé)任的權(quán)利。
版權(quán)信息
總結(jié)
以上是生活随笔為你收集整理的WebService原理及重要术语的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 使用CodeFirst创建并更新数据库
- 下一篇： [BZOJ1880] [Sdoi2009