使用SOAP開發java web服務

2024-07-21 02:27:36

字體：大中小

來源：轉載

供稿：網友

本文的預定讀者首先要對j2ee有所了解，熟悉xml，tomcat等基本內容，本文主要是簡單介紹一下web服務的基本內容，怎樣在java 中構建soap服務：
一、soap（simple object access protocol）簡單對象訪問協議，要了解soap，首先就需要了解分布式計算的由來，隨著下一代的分布式計算體系web服務的出現，soap成為了創建和調用通過網絡發布的應用程序的實際通信標準。soap類似傳統的二進制協議iiop（corba）和jrmp（rmi），但它不采用二進制數據表示法，而是采用使用xml的，基于文本的數據表示法。
        通過xml表示法，soap定義了一種小型有線連接協議和編碼格式，以表示數據類型、編程語言和數據庫，還可以使用各種internet標準協議作為其消息傳輸工具，還可以提供表示rpc和文檔驅動的消息交換等通信模型的約定。請注意，w3c正致力于soap的研究，http://www.w3c.org/2000/xp/group/ ，并得到了主流供應商的積極響應，以便對于基于xml的協議相關的重要任務達成共識，并定義其關鍵要求和使用場景。
        soap1.2的基本規范定義了以下基本內容：
       1）用于將xml文檔表示為結構化soap消息的語法和語義
       2）在soap消息中表示數據的編碼標準
       3）用于交換soap消息的通信模型
       4）soap傳輸等底層協議的綁定
      soap消息主要包括了信封頭，消息頭，主體，附件幾部分
      一個簡單的soap消息表示：
      post   /studentinfo   http/1.1
      host：anthropology.cun.edu
      content-type: text/xml;charset="utf-8"
      content-length: 640
      soapaction:  "getstudentinfo"

     <soap-env:envelop xmlns:soap-env="http://www.w3c.org/2001/06/soap-envelope"
              xmlns:xsi="http://www.w3c.org/2001/xmlschema-instance"
              xmlns:xsd="http://www.w3c.org/2001/xmlschema"
             soap-env:encodingstyle="http://www.w3c.org/2001/06/soap-encoding">
        <soap-env:header>
            <person:mail xmlns:person="http://www.cun.edu/header">[email protected]
        </soap-env:header>

        <soap-env:body>
            <m:getstudentinfo   xmlns:m="http://www.cun.edu/jws.student.studentinfo">
                 <student_name xsi:type='xsd:string'>
                        wang wen yin
                 </student>
             </m:getstudentinfo>
        </soap-env:body>
    </soap-env:envelop>
   以上是1.2版本命名空間，1.1的命名空間 soap envelope：http://schemas.xmlsoap.org/soap/envelop/ ,soap encoding: http://schemas.xmlsoap.org/soap/encoding/
   關于soap編碼規范請參閱www.w3c.org/tr/xmlschema-2/ 定義的編碼值，其他的一些規范可以上www.w3c.org 上具體查看。
二、以下從實際例子來學習，這里我使用的是apache的一個子項目axis的具體例子，便于深入了解soap的運行：
    1）下載axis的相關內容http://ws.apache.org/axis/：
    2）建立一個實例程序（遵守j2ee的web程序規范），如（webservicetest目錄）
          把axis中lib文件夾的內容拷到你的webservicetest/web-inf/lib下，同時上網下載xerces(下載地點：http://xml.apache.org/xerces-j/）解釋器的包文件xerces.jar，也拷到webservicetest/web-inf/lib文件夾下,（若要配置log4j，請把屬性文件log4j.properties拷到webservicetest/web-inf/classes文件夾下)
    3)修改應用程序webservicetest/web-inf中的web.xml文件：主要servlet設置如下
       <servlet>
              <servlet-name>testservlet</servlet-name>
              <servlet-class>org.apache.axis.transport.http.axisservlet</servlet-class>
      </servlet>
      <servlet-mapping>
              <servlet-name>testservlet</servlet-name>
              <url-pattern>*.jws</url-pattern>
     </servlet-mapping>
     <servlet-mapping>
              <servlet-name>testservlet</servlet-name>
              <url-pattern>/servlet/testservlet</url-pattern>
    </servlet-mapping>

    <servlet-mapping>
              <servlet-name>testservlet</servlet-name>
              <url-pattern>/services/*</url-pattern>
     </servlet-mapping>

     <servlet>
          <servlet-name>adminservlet</servlet-name>
          <servlet-class>
               org.apache.axis.transport.http.adminservlet
          </servlet-class>
          <load-on-startup>100</load-on-startup>
     </servlet>

     <servlet-mapping>
          <servlet-name>adminservlet</servlet-name>
          <url-pattern>/servlet/adminservlet</url-pattern>
     </servlet-mapping>

     <mime-mapping>
          <extension>wsdl</extension>
          <mime-type>text/xml</mime-type>
     </mime-mapping>

     <mime-mapping>
          <extension>xsd</extension>
          <mime-type>text/xml</mime-type>
     </mime-mapping>
    你現在可以在網址里輸入http://localhost/webservicetest/servlet/testservlet 看到了嗎？axis是使用axis.jar包里的org.apache.axis.transport.http.axisservlet對應用程序進行處理的，基本配置就講到這里。
三、接著我們來說axis中的內核。
1）不使用tomcat引擎運行axis。
       先建立一個腳步文件，對環境變量classpath進行設置要把lib下的那些包文件的路徑全都包括進去，運行：java  org.apache.axis.transport.http.simpleaxisserver <port>
2）內部服務處理程序是org.apache.axis.providers.java.rpcprovider，標志出服務所需的方法，然后提供從soap請求消息組成部分的參數。
3）axis的應用程序端管理功能：
       java org.apache.axis.client.adminclient 就會列出參數，可供你選擇。我們的例子是：java org.apache.axis.client.adminclient -l http://localhost/webservicetest/servlet/testservlet list 就會顯示出服務列表，返回的是xml文件
4）wsdl2java應用程序可以把wsdl文件創建基于java的程序，如占位程序等
     java org.apache.axis.wsdl.wsdl2java <url>
axis的基本內容說到這里
四、具體例子
1）編寫邏輯程序，簡單如：soaptest.java
    public class soaptest{
        public string getstr(string name){
            return "hello，"+name;
        }
    }
2) 部署服務，編寫wsdd文件soaptest_deploy.wsdd:
     <deployment name="simapletest" xmlns="http://xml.apache.org/axis/wsdd/"
         xmlns:java="http://xml.apache.org/axis/wsdd/providers/java"
         xmlns:xsd="http://www.w3.org/2000/10/xmlschema"
         xmlns:xsi="http://www.w3.org/2000/10/xmlschema-instance">
             <service name="soaptest" provider="java:rpc">
                  <parameter name="classname" value="soaptest"/>
                  <parameter name="allowedmethods" value="getstr"/>
             </service>
    </deployment>
    其中classname參數是你的想部署的類名（全名），allowedmethods是調用的服務的方法，如果有多個方法的話可以用空格分開（如： <parameter name="allowedmethods" value="getstr getmoney"/>),當用*的時候表示全部。
     好了現在準備部署了，確保環境路徑classpath設置正確，運行：
        java org.apache.axis.client.adminclient -l http://localhost/webservicetest/servlet/testservlet soaptest_deploy.wsdd
     （這里不懂的話，請參考以上的說明）
ok，呵呵，至此，我們已經完成了一個web服務的部署：測試http://localhost/webservicetest/servlet/testservlet 看里面是否多了一個選擇soaptest服務？
      如果不想要服務了那重新編寫一個wsdd文件，內容改為：
<deployment name="simapletest" xmlns="http://xml.apache.org/axis/wsdd/"
         xmlns:java="http://xml.apache.org/axis/wsdd/providers/java"
         xmlns:xsd="http://www.w3.org/2000/10/xmlschema"
         xmlns:xsi="http://www.w3.org/2000/10/xmlschema-instance">
            <service name="soaptest"/>
</deployment>
和上面一樣，對比一下就ok了。
五、客戶端測試：
     客戶端我們也可以使用java來進行測試，網上也有資料的，你可以去學習，很簡單的。現在為了體現web服務的魅力，我用.net平臺來測試吧，客戶端使用c#編寫（先要安裝.net framework sdk)：
    1）通過wsdl生成web服務代理，在net平臺下運行：
      wsdl /l:cs /protocol:soap /out:soaptestclient.cs http://localhost/webservicetest/services/soaptest?wsdl
        我們通過wsdl得到了一個cs文件soaptestclient.cs（當前目錄），你可以打開cs文件，研究一下里面的代碼，那個getstr(string name)就是我們需要調用的方法，我們的客戶端通過調用該方法就可以調用服務器端的方法，內部的轉化wsdl.exe工具已經幫我們完成了，axis下的wsdl2java工具也是一樣的功能，可以參考我上面所說的關于axis的內核內容
   2)編譯cs文件成程序集dll：
      csc /target:library /r:system.web.services.dll /r:system.xml.dll soaptestclient.cs
      最后我們等到了一個dll文件soaptestclient.dll，客戶端程序通過調用它就行了
   3）編寫客戶端應用程序soaptestclientapp.cs
      using system;

      namespache jws.client{
         public class soaptestclientapp{
            public soaptestclientapp(){
            }
            public static void main(string[] args){
                if(args.length!=1){
                    console.writeline("usage:soaptestclientapp <name>");
                    environment.exit(1);
                }
                soaptestservice st_service=new soaptestservice();
                st_service.getstr("wang wenyin");
           }
        }
     }
４）編譯文件csc /r:soaptestclient.dll soaptestclientapp.cs
    運行soaptestclientapp
輸出結果：
     hello,wang wenyin
與預期結果相符。

好了，關于soap開發web服務就說到這里了，希望這篇文章能對大家有所幫助，謝謝了：）有問題的話可以留言，也可以跟我聯系 [email protected]