WebService大講堂之Axis2(5)：會話（Session）管理

本文為原創，如需轉載，請注明作者和出處，謝謝！

WebService給人最直覺的感覺就是由一個個方法組成，并在用戶端通過SOAP協定調用這些方法。這些方法可能有傳回值，也可能沒有傳回值。雖然這樣可以完成一些工具，但這些被調用的方法是孤立的，當一個方法被調用後，在其他的方法中無法獲得這個方法調用後的狀态，也就是說無法保留狀态。

讀者可以想象，這對于一個完整的應用程式，無法保留狀态，就意味着隻依靠WebService很難完成全部的工作。例如，一個完整的應用系統都需要進行登入，這在Web應用中使用Session來儲存使用者登入狀态，而如果用WebService的方法來進行登入處理，無法儲存登入狀态是非常令人尴尬的。當然，這也可以通過其他的方法來解決，如在服務端使用static變量來儲存使用者狀态，并發送一個id到用戶端，通過在服務端和用戶端傳遞這個id來取得相應的使用者狀态。這非常類似于Web應用中通過Session和Cookie來管理使用者狀态。但這就需要由開發人員做很多工作，不過幸好Axis2為我們提供了WebService狀态管理的功能。

使用Axis2來管理WebService的狀态基本上對于開發人員是透明的。在WebService類需要使用org.apache.axis2.context.MessageContext和org.apache.axis2.context.ServiceContext類來儲存與獲得儲存在服務端的狀态資訊，這有些象使用HttpSession接口的getAttribute和setAttribute方法獲得與設定Session域屬性。

除此之外，還需要修改services.xml檔案的内容，為<service>元素加一個scope屬性，該屬性有四個可取的值：Application,

SOAPSession, TransportSession, Request，不過要注意一下，雖然Axis2的官方文檔将這四個值的單詞首字母和縮寫字母都寫成了大寫，但經筆者測試，必須全部小寫才有效，也就是這四個值應為：application、soapsession、transportsession、request，其中request為scope屬性的預設值。讀者可以選擇使用transportsession和application分别實作同一個WebService類和跨WebService類的會話管理。

在用戶端需要使用setManageSession(true)打開Session管理功能。

綜上所述，實作同一個WebService的Session管理需要如下三步：

1. 使用MessageContext和ServiceContext獲得與設定key-value對。

2. 為要進行Session管理的WebService類所對應的<service>元素添加一個scope屬性，并将該屬性值設為transportsession。

3. 在用戶端使用setManageSession(true)打開Session管理功能。

下面是一個在同一個WebService類中管理Session的例子。

先建立一個WebService類，代碼如下：

<!--

Code highlighting produced by Actipro CodeHighlighter (freeware)

http://www.CodeHighlighter.com/

-->package service;

import org.apache.axis2.context.ServiceContext;

import org.apache.axis2.context.MessageContext;

public class LoginService

{

    public boolean login(String username, String password)

    {

        if("bill".equals(username) && "1234".equals(password))

        {

            //  第1步：設定key-value對

            MessageContext mc = MessageContext.getCurrentMessageContext();

            ServiceContext sc = mc.getServiceContext();

            sc.setProperty("login", "成功登入");    

            return true;

        }

        else

            return false;

    }

    public String getLoginMsg()

        //  第1步：獲得key-value對中的value

        MessageContext mc = MessageContext.getCurrentMessageContext();

        ServiceContext sc = mc.getServiceContext();

        return (String)sc.getProperty("login");    

}

Normal

7.8 磅

2

false

MicrosoftInternetExplorer4

/* Style Definitions */

table.MsoNormalTable

mso-style-parent:"";

font-size:10.0pt;

font-family:"Times New Roman";

mso-fareast-font-family:"Times New Roman";}

在LoginService類中有兩個方法：login和getLoginMsg，如果login方法登入成功，會将“成功登入”字元串儲存在ServiceContext對象中。如果在login方法傳回true後調用getLoginMsg方法，就會傳回“成功登入”。

下面是LoginService類的配置代碼（services.xml）：

--><!--  第2步：添加scope屬性  -->

<service name="loginService" scope="transportsession">

    <description>

        登入服務

        </description>

    <parameter name="ServiceClass">

        service.LoginService

        </parameter>

    <messageReceivers>

        <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"

            class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />

    </messageReceivers>

</service>

使用如下的指令生成用戶端使用的stub類：

-->%AXIS2_HOME%/bin/wsdl2java -uri http://localhost:8080/axis2/services/loginService?wsdl -p client -s -o stub

在stub/src/client目錄中生成了一個LoginServiceStub.java類，在該類中找到如下的構造句方法：

-->public LoginServiceStub(org.apache.axis2.context.ConfigurationContext configurationContext,

        java.lang.String targetEndpoint, boolean useSeparateListener)

        throws org.apache.axis2.AxisFault 

    _serviceClient.getOptions().setSoapVersionURI(

                                 org.apache.axiom.soap.SOAP12Constants.SOAP_ENVELOPE_NAMESPACE_URI);

在該方法中最後添加如下的代碼：

-->//  第3步：打開用戶端的Session管理功能

_serviceClient.getOptions().setManageSession(true);

下面的用戶端代碼使用LoginServiceStub對象通路了剛才建立的WebService：

-->LoginServiceStub stub = new LoginServiceStub();

LoginServiceStub.Login login = new LoginServiceStub.Login();

login.setUsername("bill");

login.setPassword("1234");

if(stub.login(login).local_return)

    System.out.println(stub.getLoginMsg().local_return);

運作上面的代碼後，會輸出“成功登入”資訊。