XFire客戶端流程分析

XFire是當前J2EE領域非常流行的Web Service框架,以其卓越的性能和簡單易用的特性博得了廣大開發者的青睞。目前XFire已經演變爲Apache的CXF項目,但仍有大量用戶在使用XFire。

 

下面是XFire客戶端調用的流程分析圖,本文後續本分將圍繞該圖展開。

XFire客戶端的調用非常靈活,可以有很多種方式,如通過配置調用、通過API編程調用或者與Spring等IoC框架集成使用。雖然調用方式靈活多樣,但萬變不離其中,其內部流程是一致的。

創建服務模型

服務模型是XFire中非常重要的概念之一,包含了服務的接口信息、操作信息、Binding信息等諸多服務調用過程中需要的信息。因此在進行服務調用之前首先要創建服務模型。創建服務模型的工作是由服務工廠ServiceFactory完成的,用戶需要爲服務工程提供服務接口、名稱、命名空間等一些信息,其中服務接口是必須的,其他爲可選信息。

創建Client實例

Client是XFire客戶端的核心組成部分,間接的代表了一個服務。當爲具體某個服務配置攔截器(Handler,有很多種譯法如攔截器、處理器、過濾器等,本文統一用攔截器)時,其實是將攔截器信息應用到Client實例上。Client可以手工創建也可以由XFireProxyFactory創建,無論通過哪種方式,Client在初始化過程中最重要的一步都是在out攔截器堆棧中增加一個OutMessageSender攔截器。該攔截器負責最終將服務調用通過HTTP發送到服務提供者並返回處理結果。本文後續部分還會對OutMessageSender做更加詳細的講解。

創建服務代理對象

XFireProxy,XFire SOAP客戶端代理實現,用戶調用服務時(如Hello.echo(“tony”))就是通過該對象的invoke方法來執行。實際上,XFireProxy只是將調用代理到Client實例,最終執行服務的還是Client實例。

構造調用鏈信息

Client實例的invoke方法在執行時,生成了一個Invocation對象,該對象構造了一次完整的調用信息,包括OutMessage、MessageContext等。同時Invocation還負責構造一個攔截器管道(HandlerPipeline),該管道包含了本次調用需要執行的所有攔截器,當然也包括OutMessageSender。這些攔截器會分不同的階段來執行,這也是XFire一個特性。XFire默認定義了很多階段(Phase),每個階段都會有若干攔截器被調用。

循環調用攔截器

攔截器(Handler)是XFire中最爲重要的概念,一次服務調用就是由若干攔截器組合完成的。XFire默認提供了很多預定義的攔截器,用戶也可以定義自己的攔截器。基本上,通過攔截器可以影響XFire執行過程中的任何步驟,你可以爲所欲爲:)

 

攔截器有兩個重要的概念,一個是階段(Phase),一個是順序(Order)。這兩個因素共同決定了攔截器的執行順序。可以在三個不同的地方配置攔截器:

n         XFire實例:全局攔截器,對所有通道上的所有服務起作用

n         Transport:通道特定的攔截器,只對該通道(如HTTP、JMS)起作用

n         具體服務:服務特定的攔截器,只對該服務起作用

 

其實,具體服務上的攔截器最終是配置到Client上。對於同一個階段上的攔截器,執行順序爲“具體服務—>Transport—>XFire實例”。千萬不要忽視這些順序,這對你正確的使用攔截器非常有幫助。

發送遠程服務請求

這是整個調用鏈中最後的一環,也是最關鍵的一步。OutMessageHandler,前文已經有所提及,是一個特殊的攔截器,在Client初始化時創建並加入調用鏈中。該攔截器處於攔截器調用鏈的Phase.SEND階段,基本上也是最後的階段。OutMessageHandler從當前調用的消息上下文(MessageContext)中獲取請求的服務地址URI以及SOAP消息,然後通過HTTP將SOAP請求發送到遠程服務器(針對HTTP通道,如果是JMS通道則發送到指定的目的地)。最終將遠程服務器的響應逐級返回給調用者。

案例分析

前文很多地方都提到Handler非常重要,那麼具體有那些應用場景呢?本部分通過兩個案例逐步演示Handler的應用。

一、             簡單安全驗證

這是一個非常典型的應用場景,假設A公司對外提供了一個旅程信息查詢服務,該服務通過XFire對外發布。但是A公司只希望其合作伙伴才能使用該服務,那麼A公司可以爲該服務配置一個Handler,該Handler從SOAP的消息頭中獲取認證字符串,只有通過驗證的請求才被執行。下面是簡單的示例代碼,真實情況要比這複雜得多。

public void invoke(MessageContext context) throws Exception {

Element header = context.getInMessage().getHeader();  

      String authCode = header.getChild("authCode",null).getValue();

      if(!"tony".equals(authCode)){

        throw new XFireFault("Authentication Fail!", XFireFault.SENDER);

   }

}

 

對於A公司的合作伙伴,要想調用該服務,必須在其SOAP的消息頭中包含上面代碼中的驗證字符串,否則服務將被拒絕。下面是簡單的示例代碼:

    public void invoke(MessageContext context) throws Exception {

        Element header = context.getInMessage().getHeader();

        Element authCode = new Element("authCode");

        authCode.addContent("tony");

        header.addContent(authCode);

    }

 

二、             查找真實服務

這是一個比較特殊的應用場景:假設A公司已經初步實現SOA,擁有一個服務註冊中心,所有的XFire服務都在該中心註冊。客戶端在調用服務時需要動態的從該服務註冊中心獲取當前的服務地址及版本。通過其他方式肯定也可以實現該需求,但是通過Handler來實現會非常的幽雅,而且對應用不需要做任何變動。我們先來看一下Handler的代碼:

    public void invoke(MessageContext context) throws Exception {

            // 1.尋址

            lookupRealServiceUri(context);

}

    private void lookupRealServiceUri(MessageContext context) {

        String uri = context.getOutMessage().getUri();

        try {

            uri = serviceLocator.lookup(requestEnvironment, uri);

        } catch (Exception e) {

            // Ignoral this exception

        }

        context.getOutMessage().setUri(uri);

    }

正如代碼所示,只需要從context中獲取當前請求的服務URI地址,然後用當前請求環境信息及服務URI地址到服務註冊中心查找真實的服務,並重新設置服務的地址。

結束語

本文粗略的介紹了XFire客戶端的調用流程,並着重講解了Handler的擴展機制及其應用場景,力求讀者能夠通過本文對XFire能有更加深入的瞭解和掌握。文中難免存在不足之處,歡迎任何形式的交流。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章