java開發webservice的幾種方式

彙總，四種方式：ax2，CXF，jdk自帶，xfire

webservice的應用已經越來越廣泛了，下面介紹幾種在Java體系中開發webservice的方式，相當於做個記錄。

1.Axis2

Axis是apache下一個開源的webservice開發組件，出現的算是比較早了，也比較成熟。這裏主要介紹Axis+eclipse開發webservice，當然不用eclipse也可以開發和發佈webservice，只是用eclipse會比較方便。

 

（1）下載eclipse的Java EE版本

http://www.eclipse.org/downloads/

 

（2）下載axis2

http://axis.apache.org/axis2/java/core/download.cgi

 

（3）下載eclipse的axis2插件

Axis2_Codegen_Wizard

Axis2_Service_Archiver

http://axis.apache.org/axis2/java/core/tools/index.html

推薦使用1.3的版本

 

（4）eclipse安裝axis2插件

1）在任意目錄下新建一個Axis2文件夾，在該文件夾下新建eclipse目錄，在eclipse目錄中新建plugins目錄和features目錄，例如：D:\programSoftware\eclipse-SVN\Axis2\eclipse；

2）把下載的axis2插件解壓，並把解壓的文件放到新建的eclipse的plugins目錄下；

3）在%eclipse_home%的目錄下新建links目錄，並在links目錄下新建axis2.link文件，內容爲：path=D:\programSoftware\eclipse-SVN\Axis2;

4）重啓eclipse，點擊·file-new-other,如果看到Axis2 Wizards，則表明插件安裝成功。

 

（5）安裝axis2

下載Axis2的WAR Distribution並解壓，把axis2.war包放置到%TOMCAT_HOME%/webapps下，啓動tomcat，訪問http://localhost:port/axis2，Axis2安裝成功。

 

（6）使用eclipse新建web工程，創建一個普通java類，至少包含一個方法。

 

（7）發佈webservice

1）點擊eclipse的File-New-other，打開Axis2 Wizards，選擇Axis2 Service Archiver，然後Next;

2）選擇Class File Location，也就是類文件存放路徑，注意：只選到classes目錄，不要包括包文件夾，然後Next;

3）選擇Skip WSDL，然後Next

4）一路Next到Select the Service XML file to be included in the Service archive，勾選Generate theservice xml automatically；

5）Service Name-填寫你的service名稱，Class Name-填寫類名稱，要包括包名，然後點擊load，然後點擊Finish，這時webservice就發佈成功了；

6）然後到%TOMCAT_HOME%/webapps/axis2/WEB-INF/services 看看是否多了一個.aar的文件；

7）訪問http://localhost:8085/axis2/services/類名?wsdl 就可看到生成的wsdl文件了。

注意：以上的方式是發佈到axis2.war包中，你也可以把生成.aar文件copy到你的實際應用中，同時，你也可以使用eclipse的create webservice功能發佈你的webservice，選擇axis2生成你的webservice，這樣webservice就會部署到你的應用中了。

 

2.Apche CXF

CXF開發webservice也是比較方便和簡單的，它和spring的集成可以說是非常地好。舉一個CXF開發webservice的例子吧。

1）在eclipse中新建一個web工程，導入依賴包，如圖：

 

2）編寫一個接口，如:

public String test(@WebParam(name="value", targetNamespace = "http://service.cxf.zcl.com/", mode = WebParam.Mode.IN)String value);

注意：CXF開發的webservice，接口中的方法的參數一定要以這種方式，否則客戶端調用的時候CXF服務端會接收不到參數的值，name：參數名稱，可不寫（建議寫上），targetNamespace：命名空間，一定要填寫上，默認是包名反過來的順序，mode：參數類型，IN表示輸入。

3）編寫一個實現類，實現接口的方法；

4）和spring的集成，編寫一個bean文件，如：cxf-beans.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:jaxws="http://cxf.apache.org/jaxws"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
                        http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd">

    <import resource="classpath:META-INF/cxf/cxf.xml" />
    <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

    <jaxws:endpoint id="vote" implementor="com.zcl.cxf.service.VoteImpl" address="/Vote" />
</beans>

 這個文件比較容易理解，就不解釋了。

5）配置CXFServlet

在web.xml文件中配置CXFServlet，加載cxf-beans.xml文件，內容如下：

 

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>WEB-INF/cxf-beans.xml</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>cxf</servlet-name>
        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>cxf</servlet-name>
        <url-pattern>/services/*</url-pattern>
    </servlet-mapping>
</web-app>

 把工程部署到中間件，如tomcat，就可以訪問該webservice了。

 

3.JDK開發webservice

1）編寫一個Java類，如下：

 

package demo;

import javax.jws.WebParam;
import javax.jws.WebService;
import javax.xml.ws.Endpoint;

@WebService
public class JdkWebService {

    public String doSomething(@WebParam(name="value", targetNamespace = "http://demo/", mode = WebParam.Mode.IN)String value) {
        return "Just do it," + value + "!";
    }

    public static void main(String[] args) {
        Endpoint.publish("http://localhost:8080/jdkwsdemo/demo.JdkWebService", new JdkWebService());
    }
}

 2）運行該java類，在瀏覽器上就可以訪問該webservice了。

注意：開發web工程的時候，這種方法不太友好。我們可以編寫一個servlet類，在servlet類的初始化方法中發佈webservice，這樣我們的中間件服務器啓動的時候就會幫我們自動webservice了。

 

 4)  xfire

開發WebService的框架不少，每個框架都有各自的有點，最近我用xfire練習開發WebService,下面是開發WebService的小例子，希望對入門的人有些小幫助 
1.新建一個java web project命名爲TestWebService，將xfire相關的jar包添加到lib目錄中,寫接口類和實現類 

package com.lamp.service;

public interface MessageService {
    public String getName(String name);
}

package com.lamp.service;

public interface MessageService {
    public String getName(String name);
}

實現類 

package com.lamp.service.impl;

import com.lamp.service.MessageService;

public class MessageServiceImpl implements MessageService {

    public String getName(String name) {
        return "hellow " + name + ", welcome to WebService world";
    }

}

package com.lamp.service.impl;

import com.lamp.service.MessageService;

public class MessageServiceImpl implements MessageService {

    public String getName(String name) {
        return "hellow " + name + ", welcome to WebService world";
    }

}

在src目錄下新建文件夾META-INF，然後再在其下新建文件夾xfire,在xfire目錄下新建配置文件services.xml 

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
  <service>
    <name>MessageService</name>
    <serviceClass>com.lamp.service.MessageService</serviceClass>
    <implementationClass>com.lamp.service.impl.MessageServiceImpl</implementationClass>
  </service>
</beans>

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
  <service>
    <name>MessageService</name>
    <serviceClass>com.lamp.service.MessageService</serviceClass>
    <implementationClass>com.lamp.service.impl.MessageServiceImpl</implementationClass>
  </service>
</beans>

最後在web.xml中配置xfire的servlet 

<servlet>
        <servlet-name>XFireServlet</servlet-name>
        <servlet-class>
            org.codehaus.xfire.transport.http.XFireConfigurableServlet
        </servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>XFireServlet</servlet-name>
        <url-pattern>/servlet/XFireServlet/*</url-pattern>
    </servlet-mapping>

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

<servlet>
        <servlet-name>XFireServlet</servlet-name>
        <servlet-class>
            org.codehaus.xfire.transport.http.XFireConfigurableServlet
        </servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>XFireServlet</servlet-name>
        <url-pattern>/servlet/XFireServlet/*</url-pattern>
    </servlet-mapping>

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

項目部署後在瀏覽器中通過http://localhost:8080/TestWebService/services訪問看到遠程訪問的接口，並得到wsdl爲http://localhost:8080/TestWebService/services/MessageService?wsdl 

這樣服務器端開發完畢，現在開始客戶端的開發 
新建一個java project也將xfire相關的jar引入，我用ant在客戶端生成代理對象，在項目路徑下新建build.xml,代碼爲 

<?xml version="1.0" encoding="UTF-8"?>

<project name="WebService" basedir="." default="gen-webservice">

    <property file="build.properties">
    </property>

    <path id="project-classpath">
        <fileset dir="${lib.dir}">
            <include name="**/*.jar" />
        </fileset>
    </path>

    <target name="gen-webservice">
        <taskdef name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask" classpathref="project-classpath" />

        <wsgen outputDirectory="${src.dir}"
          wsdl="${wsdl.dir}" package="com.lamp.ws.client" overwrite="true"/>

    </target>

</project>

<?xml version="1.0" encoding="UTF-8"?>

<project name="WebService" basedir="." default="gen-webservice">

    <property file="build.properties">
    </property>

    <path id="project-classpath">
        <fileset dir="${lib.dir}">
            <include name="**/*.jar" />
        </fileset>
    </path>

    <target name="gen-webservice">
        <taskdef name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask" classpathref="project-classpath" />

        <wsgen outputDirectory="${src.dir}"
          wsdl="${wsdl.dir}" package="com.lamp.ws.client" overwrite="true"/>

    </target>

</project>

其引入的build.properties文件也在項目路徑下 
src.dir=${basedir}/src 
lib.dir=F:/WebService/xfire-1.2.6/lib 
wsdl.dir=http://localhost:8080/TestWebService/services/MessageService?wsdl 
其中lib.jar爲我存放xfire的路徑，運行ant得到代理對象 
編寫一個測試類 

package com.lamp.test;

import com.lamp.ws.client.MessageServiceClient;
import com.lamp.ws.client.MessageServicePortType;

public class TestGetName {

    public static void main(String[] args) {
        MessageServiceClient msg = new MessageServiceClient();
        MessageServicePortType portType = msg.getMessageServiceHttpPort();
        String result = portType.getName("張三");
        System.out.println(result);
    }

}

package com.lamp.test;

import com.lamp.ws.client.MessageServiceClient;
import com.lamp.ws.client.MessageServicePortType;

public class TestGetName {

    public static void main(String[] args) {
        MessageServiceClient msg = new MessageServiceClient();
        MessageServicePortType portType = msg.getMessageServiceHttpPort();
        String result = portType.getName("張三");
        System.out.println(result);
    }

}

運行在控制檯看到了hellow 張三, welcome to WebService world至此一個簡單的WebService開發完畢