1. 程式人生 > >Axis2與Web專案整合及Axis2在Web專案中整合Spring

Axis2與Web專案整合及Axis2在Web專案中整合Spring

Axis2簡介:

         Axis2是一套嶄新的WebService引擎,該版本是對Axis1.x重新設計的產物。Axis2不僅支援SOAP1.1和SOAP1.2,還集成了非常流行的REST WebService,同時還支援springJSON等技術。

一、說明:

       《使用Axis2實現WebService的釋出和呼叫》介紹了通過使用Axis2來發布和呼叫WebService,但是是把WebService釋出在Axis2提供的專案中,如果我們需要在自己的Web專案中來使用Axis2釋出WebService該怎麼做呢?

       本篇即介紹在Web專案中使用Axis2來發布WebService.

二、具體操作:

①   新建一個動態的web工程 (Dynamic Web project)

      本例中新建的工程名為:AxisWebDemo

②  將上次下載的  axis2-1.6.4-war.zip 檔案解壓到相應的目錄,將目錄中的axis2.war檔案放到Tomcat伺服器的webapps目錄中(本文使用的Tomcat的版本是7.x),並啟動Tomcat。 這時在Tomcat的webapps資料夾中會出現一個 名為 axis2 的資料夾(其實這就是部署好的 axis2工程),如下圖


③   將 axis2 下的 axis2-web 資料夾移動到我們 AxisWebDemo 工程的 WebContent目錄下 

       將WEB-INF 下的 lib 、conf  、modules資料夾移動到 AxisWebDemo工程的 WEB-INF目錄下 ,結構如下圖:


④   在src右鍵,新建package : com.elgin.webservice   

在這個包中新建一個我們需要釋出的 WebService 服務的類: WebServiceDemo

      程式碼如下:

package com.elgin.webservice;  
  
public class WebServiceDemo {  
     
    public String  sayHello(String name){  
        return "hello " + name;  
    }  
      
    public int getAge(){  
        return 26;  
    }  
}  

⑤   在 AxisWebDemo 工程的 WEB-INF 下新建如下層次結構目錄 : services/webservices/META-INF/services.xml  ,如下圖所示:


經過我的驗證,發現:目錄層次必須是  services / 任意名稱資料夾  / META-INF / services.xml   ,否則 WebService釋出會失敗 ,也就是說上圖的層次中 ,只有webservice這個資料夾的名字是可以自由指定,其它的檔案、資料夾名字都是固定的!

services.xml 配置檔案內容:

<?xml version="1.0" encoding="UTF-8"?>  
<serviceGroup>    
       <!- name屬性配置WebService的名稱 ->  
       <service name="myService">    
              <description>Web Service</description>    
              <!-- ServiceClass屬性配置提供WebService服務類的全類名 -->  
              <parameter name="ServiceClass">com.elgin.webservice.WebServiceDemo</parameter>    
              <messageReceivers>    
                     <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out" class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />    
                     <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only" class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />    
              </messageReceivers>    
       </service>    
</serviceGroup>   

⑥   在  AxisWebDemo 工程的 web.xml 檔案中加入axis2的配置支援:

<!-- 加入axis2支援 -->  
  <servlet>  
        <servlet-name>AxisServlet</servlet-name>  
        <servlet-class>org.apache.axis2.transport.http.AxisServlet</servlet-class>  
        <load-on-startup>1</load-on-startup>  
  </servlet>  
  <servlet-mapping>  
        <servlet-name>AxisServlet</servlet-name>  
        <url-pattern>/services/*</url-pattern>  
  </servlet-mapping>  

經過以上6個步驟 , axis2 已經整合到工程中了 ,把專案加入的Tomcat中,啟動Tomcat伺服器 ,在瀏覽器中輸入以下URL:

如果出現下圖所示的資訊,說明你的 WebService服務釋出成功了:


上圖中的 myService 即是你在 services.xml 中配置的 WebService的名稱

輸入下面URL:

出現下圖所顯示的關於服務的xml資訊:



注意上圖中  <wsdl:definitions> 元素中的 targetNamespace的值  ,上一篇介紹中也提到過 ,是提供WebService服務的類所在的包名倒過來。

三、呼叫上面工程中釋出的WebService服務:

Java呼叫程式碼:

package com.elgin.webservice.axis2;  
  
import java.io.File;  
import java.io.FileInputStream;  
import java.io.IOException;  
import javax.xml.namespace.QName;  
  
import org.apache.axis2.AxisFault;  
import org.apache.axis2.addressing.EndpointReference;  
import org.apache.axis2.client.Options;  
import org.apache.axis2.rpc.client.RPCServiceClient;  
  
  
public class RPCClient {  
      
   public static String address2="http://localhost:8080/AxisWebDemo/services/myService?wsdl";  
      
    public static void main(String[] args) throws IOException{  
      
        testWebDemo();  
          
    }  
      
    @SuppressWarnings("rawtypes")  
    public static Object[] invoke(String method,Object[] params,Class[] classes) throws AxisFault{  
        //使用RPC方式呼叫WebService  
        RPCServiceClient client=new RPCServiceClient();  
        Options option=client.getOptions();  
          
        //指定呼叫的URL  
        EndpointReference reference=new EndpointReference(address2);  
        option.setTo(reference);  
          
        /* 
         * 設定要呼叫的方法 
         * http://ws.apache.org/axis2 為預設的(無package的情況)名稱空間, 
         * 如果有包名,則為 http://axis2.webservice.elgin.com ,包名倒過來即可 
         * method為方法名稱 
         *  
         */  
        QName  qname=new QName("http://webservice.elgin.com", method);  
          
        //呼叫遠端方法,並指定方法引數以及返回值型別  
        Object[] result=client.invokeBlocking(qname,params,classes);  
          
        return result;  
          
    }  
      
    public static void testWebDemo() throws AxisFault{  
        Object[] result=invoke("sayHello", new Object[]{"elgin"}, new Class[]{String.class});  
        System.out.println(result[0]);  
        result=invoke("getAge", new Object[]{}, new Class[]{int.class});  
        System.out.println(result[0]);  
    }  
      
}  

執行結果:



在現今的Web應用中經常使用spring框架來裝載JavaBean。如果要想將某些在Spring中裝配的JavaBean釋出成WebService,本篇將做到介紹

一、說明:

上一篇說了Axis2與Web專案的整合過程,如果說在Web專案中使用了spring框架,那麼又改如何進行Axis2相關的配置操作呢?

二、Axis2 與 Spring 整合

①   新建專案 AxisSpringDemo,並在其中加入 Axis2 與 Spring 相關的 jar 包

Spring所需 Jar :

aopalliance-1.0.jar  
aspectjrt.jar  
aspectjweaver.jar  
spring-aop-3.2.1.RELEASE.jar  
spring-beans-3.2.1.RELEASE.jar  
spring-context-3.2.1.RELEASE.jar  
spring-core-3.2.1.RELEASE.jar  
spring-expression-3.2.1.RELEASE.jar  
spring-tx-3.2.1.RELEASE.jar  
spring-web-3.2.1.RELEASE.jar  
Axis2 所需 Jar :
activation-1.1.jar  
axiom-api-1.2.15.jar  
axiom-impl-1.2.15.jar  
axis2-adb-1.6.4.jar  
axis2-jaxws-1.6.4.jar  
axis2-kernel-1.6.4.jar  
axis2-spring-1.6.4.jar  
axis2-transport-http-1.6.4.jar  
axis2-transport-local-1.6.4.jar  
axis2-xmlbeans-1.6.4.jar  
commons-fileupload-1.3.1.jar  
commons-httpclient-3.1.jar  
commons-io-2.1.jar  
commons-logging-1.1.1.jar  
geronimo-stax-api_1.0_spec-1.0.1.jar  
httpcore-4.0.jar  
jsr311-api-1.1.1.jar  
mail-1.4.jar  
neethi-3.0.2.jar  
woden-api-1.0M9.jar  
wsdl4j-1.6.2.jar  
xml-resolver-1.2.jar  
XmlSchema-1.4.7.jar  
②  在工程中的 web.xml 檔案中加入 Spring 、 Axis2支援配置:
<!-- 加入Spring支援 -->  
 <context-param>  
   <param-name>contextConfigLocation</param-name>  
   <param-value>classpath:applicationContext.xml</param-value>  
 </context-param>  
 <listener>  
   <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
 </listener>  
   
 <!--加入Axis2支援  -->  
 <servlet>  
       <servlet-name>AxisServlet</servlet-name>  
       <servlet-class>org.apache.axis2.transport.http.AxisServlet</servlet-class>  
       <load-on-startup>1</load-on-startup>  
 </servlet>  
 <servlet-mapping>  
       <servlet-name>AxisServlet</servlet-name>  
       <url-pattern>/services/*</url-pattern>  
 </servlet-mapping>  
③  同上篇講的整合 web專案一致 ,將conf 、axis2-web  、modules資料夾移動到 AxisSpringDemo工程的 下各個對應的位置。如圖:


④  在src下新建包  com.elgin.spring.webservice ,並新建提供WebService服務的類  SpringWebServiceDemo ,程式碼如下:

package com.elgin.spring.webservice;  
  
import java.util.Random;  
  
import org.springframework.stereotype.Component;  
  
@Component("springWebService")  
public class SpringWebServiceDemo {  
      
    public String springHello(){  
        return "hello spring-axis2";   
    }  
      
    public int getAge(){  
        return new Random().nextInt(80);  
    }  
      
    public void update(){  
        System.out.println("update something..");  
    }  
} 

⑤  在類路徑下新建 Spring配置檔案 :applicationContxt.xml 配置檔案

<?xml version="1.0" encoding="UTF-8"?>  
<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"  
    xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"  
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd  
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.2.xsd  
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd  
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.2.xsd">  
  
    <!-- 配置spring註解掃描的包 -->  
    <context:component-scan base-package="com.elgin"></context:component-scan>  
<!-- 或者不用註解的形式載入bean,改用配置的方式  
<bean id="springWebService" class="com.elgin.spring.webservice.SpringWebServiceDemo ">    
利用property可以對SpringService類進行初始化,比如<property name="name" value="姚明" /><property name="job" value="職業男籃" />,在配置完SpringService類後,就可以直接在程式中FileSystemXmlApplicationContext類或其他類似功能的類讀取applicationContext.xml檔案中的內容,並獲得SpringService類的物件例項。但現在我們並不這樣做,而是將SpringService類釋出成WebService。在Tomcat的webapps專案中的WEB-INF\lib目錄中有一個axis2-spring-1.4.1.jar檔案, 該檔案用於將被裝配JavaBean的釋出成WebService。
  -->  
</beans>  


⑥  配置 Axis2的WebService服務:

同上一篇所說:在 AxisWebDemo 工程的 WEB-INF 下新建如下層次結構目錄 : services/springServices/META-INF/services.xml 

services.xml配置內容:

<?xml version="1.0" encoding="UTF-8"?>    
<serviceGroup>      
   <service name="springService">      
      <description>Web Service</description>      
   <!--   
 SpringBeanName作用類似於普通配置中的ServiceClass,都是用來建立服務類物件,只不過普通配置使用反射來建立 
加入Spring之後,物件的建立交給了Spring的IOC容器,SpringBeanName指定要釋出成WebService的Java類在applicationContext.xml檔案中裝配,
SpringBeanName引數是JavaBean的名稱。SpringBeanName固定的不能改 ,因為springWebService是spring中註冊的實現類得id 
如果不使用spring,可以使用ServiceClass屬性,ServiceClass引數要指定要釋出成WebService的Java類,並指定全類名的方式:com.elgin.spring.webservice.SpringWebServiceDemo  -->        
      <parameter name="SpringBeanName">springWebService</parameter>    
<!-- 通過ServiceObjectSupplier引數指定SpringServletContextObjectSupplier類來獲得Spring的ApplicationContext物件 -->  
      <parameter name="ServiceObjectSupplier">org.apache.axis2.extensions.spring.receivers.SpringServletContextObjectSupplier</parameter>      
       <!--     
           在這裡最值得注意的是<messageReceivers>元素,該元素用於設定處理WebService方法的處理器。    
           例如,getAge方法有一個返回值,因此,需要使用可處理輸入輸出的RPCMessageReceiver類,    
           而update方法沒有返回值,因此,需要使用只能處理輸入的RPCInOnlyMessageReceiver類。    
        -->    
      <messageReceivers>      
             <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out" class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />      
             <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only" class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />      
      </messageReceivers>      
   </service>      
</serviceGroup>   
配置web.xml

<?xml version="1.0" encoding="UTF-8"?>    
<web-app version="2.5"     
    xmlns="http://java.sun.com/xml/ns/javaee"     
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee     
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">    
     
    <servlet>    
        <servlet-name>AxisServlet</servlet-name>    
//註冊axis2的servlet    
        <servlet-class>org.apache.axis2.transport.http.AxisServlet</servlet-class>    
        <load-on-startup>1</load-on-startup>    
    </servlet>    
            
    <servlet-mapping>    
        <servlet-name>AxisServlet</servlet-name>    
        <url-pattern>/services/*</url-pattern>    
    </servlet-mapping>    
//載入spring的配置檔案    
    <context-param>    
      <param-name>contextConfigLocation</param-name>    
    
      <param-value>classpath*:applicationContext.xml</param-value>    
    </context-param>    
//增加spring監聽器    
    <listener>    
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>    
    </listener>    


測試總結:

經過上述的步驟,配置結束,將專案裝載的 Tomcat ,啟動 ,瀏覽器輸入http://localhost:8080/AxisSpringDemo/services/listServices 出現如下介面說明我們的服務已經發布成功了



訪問 
http://localhost:8080/WebService/services/springService?wsdl
可以檢視wsdl (springService為service.xml中service的name)
通過上面的測試可以發現:
加入Spring之後,除了spring的引入以及配置,唯一不同的地方就是 services.xml 的配置發生了變化