WebService介面開發

標籤：io   使用   java   ar   檔案   資料   sp   art   cti   

Web Service 中繼資料注釋（JSR 181）

 

@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：  wsdl:portName。預設值為 WebService.name+Port。

   5、targetNamespace：指定你想要的名稱空間，認是使用介面實作類別的包名的反綴

   6、wsdlLocation：指定用於定義 Web Service 的 WSDL 文檔的 Web 地址。Web 地址可以是相對路徑或絕對路徑。（字串）

   注意：實作類別上可以不添加Webservice註解  

 

 

 

 

@WebMethod 

   注釋表示作為一項 Web Service 操作的方法，將此注釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實作類別。

   要點：

       僅支援在使用 @WebService 注釋來注釋的類上使用 @WebMethod 注釋

 

 1、operationName：指定與此方法相匹配的wsdl:operation 的名稱。預設值為 Java 方法的名稱。（字串）

 2、action：定義此操作的行為。對於 SOAP 綁定，此值將確定 SOAPAction 頭的值。預設值為 Java 方法的名稱。（字串）

 3、exclude：指定是否從 Web Service 中排除某一方法。預設值為 false。（布爾值）  

 

 

 

@Oneway 

注釋將一個方法表示為只有輸入訊息而沒有輸出訊息的 Web Service 單向操作。

將此注釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實作類別  

 

 

@WebParam 

注釋用於定製從單個參數至 Web Service 訊息組件和 XML 元素的映射。

將此注釋應用於客戶機或伺服器服務端點介面（SEI）上的方法，或者應用於 JavaBeans 端點的伺服器端點實作類別。

1、name ：參數的名稱。如果操作是遠端程序呼叫（RPC）類型並且未指定partName 屬性，那麼這是用於表示參數的 wsdl:part 屬性的名稱。

如果操作是文件類型或者參數映射至某個頭，那麼 -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：指定設定檔中處理常式鏈的名稱。

WebService介面開發