WebService註解彙總
阿新 • • 發佈：2019-01-10
Web Service 元資料註釋（JSR 181）
2、endpointInterface： 服務介面全路徑, 指定做SEI（Service EndPoint Interface）服務端點介面
3、name：此屬性的值包含XML Web Service的名稱。在預設情況下，該值是實現XML Web Service的類的名稱，wsdl:portType 的名稱。預設值為 Java 類或介面的非限定名稱。（字串)
4、portName：
5、targetNamespace：指定你想要的名稱空間，認是使用介面實現類的包名的反綴
6、wsdlLocation：指定用於定義 Web Service 的 WSDL 文件的 Web 地址。Web 地址可以是相對路徑或絕對路徑。（字串）
注意：實現類上可以不新增Webservice註解
要點：
僅支援在使用 @WebService 註釋來註釋的類上使用 @WebMethod 註釋
1、operationName
2、action：定義此操作的行為。對於 SOAP 繫結，此值將確定 SOAPAction 頭的值。預設值為 Java 方法的名稱。（字串）
3、exclude：指定是否從 Web Service 中排除某一方法。預設值為 false。（布林值）
將此註釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實現類
將此註釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實現類。
1、name ：
如果操作是文件型別或者引數對映至某個頭，那麼 -name 是用於表示該引數的 XML 元素的區域性名稱。如果操作是文件型別、
引數型別為 BARE 並且方式為 OUT 或 INOUT，那麼必須指定此屬性。（字串）
2、partName：定義用於表示此引數的 wsdl:part屬性的名稱。僅當操作型別為 RPC 或者操作是文件型別並且引數型別為BARE 時才使用此引數。（字串）
3、targetNamespace：指定引數的 XML 元素的 XML 名稱空間。當屬性對映至 XML 元素時，僅應用於文件繫結。預設值為 Web Service 的 targetNamespace。（字串）
4、mode：此值表示此方法的引數流的方向。有效值為 IN、INOUT 和 OUT。（字串）
5、header：指定引數是在訊息頭還是訊息體中。預設值為 false。（布林值）
1、name：當返回值列示在 WSDL 檔案中並且在連線上的訊息中找到該返回值時，指定該返回值的名稱。對於 RPC 繫結，這是用於表示返回值的 wsdl:part屬性的名稱。對於文件繫結，-name引數是用於表示返回值的 XML 元素的區域性名。對於 RPC 和 DOCUMENT/WRAPPED 繫結，預設值為 return。對於 DOCUMENT/BARE 繫結，預設值為方法名 + Response。（字串）
2、targetNamespace：指定返回值的 XML 名稱空間。僅當操作型別為 RPC 或者操作是文件型別並且引數型別為 BARE 時才使用此引數。（字串）
3、header：指定頭中是否附帶結果。預設值為false。（布林值）
4、partName：指定 RPC 或 DOCUMENT/BARE 操作的結果的部件名稱。預設值為@WebResult.name。（字串）
但是可以使用多種方法來配置客戶端的處理程式。可以通過對生成的服務類或者 SEI 使用 @HandlerChain 註釋來配置客戶端的處理程式。此外，可以按程式在服務上註冊您自己的 HandlerResolver 介面實現，或者按程式在繫結物件上設定處理程式鏈。
1、file：指定處理程式鏈檔案所在的位置。檔案位置可以是採用外部格式的絕對 java.net.URL，也可以是類檔案中的相對路徑。（字串）
2、name：指定配置檔案中處理程式鏈的名稱。
@WebService
1、serviceName： 對外發布的服務名，指定 Web Service 的服務名稱：wsdl:service。預設值為 Java 類的簡單名稱+Service。（字串）2、endpointInterface： 服務介面全路徑, 指定做SEI（Service EndPoint Interface）服務端點介面
3、name：此屬性的值包含XML Web Service的名稱。在預設情況下，該值是實現XML Web Service的類的名稱，wsdl:portType 的名稱。預設值為 Java 類或介面的非限定名稱。（字串)
4、portName：
5、targetNamespace：指定你想要的名稱空間，認是使用介面實現類的包名的反綴
6、wsdlLocation：指定用於定義 Web Service 的 WSDL 文件的 Web 地址。Web 地址可以是相對路徑或絕對路徑。（字串）
注意：實現類上可以不新增Webservice註解
@WebMethod
註釋表示作為一項 Web Service 操作的方法，將此註釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實現類。要點：
僅支援在使用 @WebService 註釋來註釋的類上使用 @WebMethod 註釋
1、operationName
2、action：定義此操作的行為。對於 SOAP 繫結，此值將確定 SOAPAction 頭的值。預設值為 Java 方法的名稱。（字串）
3、exclude：指定是否從 Web Service 中排除某一方法。預設值為 false。（布林值）
@Oneway
註釋將一個方法表示為只有輸入訊息而沒有輸出訊息的 Web Service 單向操作。將此註釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實現類
@WebParam
註釋用於定製從單個引數至 Web Service 訊息部件和 XML 元素的對映。將此註釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實現類。
1、name ：
如果操作是文件型別或者引數對映至某個頭，那麼 -name 是用於表示該引數的 XML 元素的區域性名稱。如果操作是文件型別、
引數型別為 BARE 並且方式為 OUT 或 INOUT，那麼必須指定此屬性。（字串）
2、partName：定義用於表示此引數的 wsdl:part屬性的名稱。僅當操作型別為 RPC 或者操作是文件型別並且引數型別為BARE 時才使用此引數。（字串）
3、targetNamespace：指定引數的 XML 元素的 XML 名稱空間。當屬性對映至 XML 元素時，僅應用於文件繫結。預設值為 Web Service 的 targetNamespace。（字串）
4、mode：此值表示此方法的引數流的方向。有效值為 IN、INOUT 和 OUT。（字串）
5、header：指定引數是在訊息頭還是訊息體中。預設值為 false。（布林值）
@WebResult
註釋用於定製從返回值至 WSDL 部件或 XML 元素的對映。將此註釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實現類。1、name：當返回值列示在 WSDL 檔案中並且在連線上的訊息中找到該返回值時，指定該返回值的名稱。對於 RPC 繫結，這是用於表示返回值的 wsdl:part屬性的名稱。對於文件繫結，-name引數是用於表示返回值的 XML 元素的區域性名。對於 RPC 和 DOCUMENT/WRAPPED 繫結，預設值為 return。對於 DOCUMENT/BARE 繫結，預設值為方法名 + Response。（字串）
2、targetNamespace：指定返回值的 XML 名稱空間。僅當操作型別為 RPC 或者操作是文件型別並且引數型別為 BARE 時才使用此引數。（字串）
3、header：指定頭中是否附帶結果。預設值為false。（布林值）
4、partName：指定 RPC 或 DOCUMENT/BARE 操作的結果的部件名稱。預設值為@WebResult.name。（字串）
@HandlerChain
註釋用於使 Web Service 與外部定義的處理程式鏈相關聯。只能通過對 SEI 或實現類使用 @HandlerChain 註釋來配置伺服器端的處理程式。但是可以使用多種方法來配置客戶端的處理程式。可以通過對生成的服務類或者 SEI 使用 @HandlerChain 註釋來配置客戶端的處理程式。此外，可以按程式在服務上註冊您自己的 HandlerResolver 介面實現，或者按程式在繫結物件上設定處理程式鏈。
1、file：指定處理程式鏈檔案所在的位置。檔案位置可以是採用外部格式的絕對 java.net.URL，也可以是類檔案中的相對路徑。（字串）
2、name：指定配置檔案中處理程式鏈的名稱。