java開發webservice的幾種方式

時間 2019-12-12

原文原文鏈接

webservice的應用已經愈來愈普遍了，下面介紹幾種在Java體系中開發webservice的方式，至關於作個記錄。html

1.Axis2方式java

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

（1）下載eclipse的Java EE版本spring

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

（2）下載axis2api

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

（3）下載eclipse的axis2插件瀏覽器

Axis2_Codegen_Wizardtomcat

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，內容以下：

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.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類，以下：

Jdkwebservice.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目錄中,寫接口類和實現類

Java代碼

package com.lamp.service;
public interface MessageService {
public String getName(String name);
}

實現類

Java代碼

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代碼

<?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

Xml代碼

<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代碼

<?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獲得代理對象
編寫一個測試類

Java代碼

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開發完畢

------------------------------------------------------------------------------------------------

webservice的應用已經愈來愈普遍了，下面介紹幾種在Java體系中開發webservice的方式，至關於作個記錄。

如今webservice加xml技術已經逐漸成熟，但要真正要用起來還需時日!!
    因爲畢業設計緣故，我看了不少關於webservice方面的知識，今天和你們一塊兒來研究研究webservice的各類使用方法。

1、利用jdk web服務api實現，這裏使用基於 SOAP message 的 Web 服務
     1.首先創建一個Web services EndPoint：

package Hello;

import javax.jws.WebService;

import javax.jws.WebMethod;

import javax.xml.ws.Endpoint;

@WebService

public class Hello {

@WebMethod

public String hello(String name) {

return "Hello, " + name + "\n";

}

public static void main(String[] args) {

// create and publish an endpoint

Hello hello = new Hello();

Endpoint endpoint = Endpoint.publish("http://localhost:8080/hello", hello);

}

       2.使用 apt 編譯 Hello.java(例：apt -d [存放編譯後的文件目錄] Hello.java ) ,會生成 jaws目錄
    3.使用java Hello.Hello運行，而後將瀏覽器指向http://localhost:8080/hello?wsdl就會出現下列顯示

   4.使用wsimport 生成客戶端

     使用以下：wsimport -p . -keep http://localhost:8080/hello?wsdl

    這時，會在當前目錄中生成以下文件：

       5.客戶端程序：

class HelloClient{
2

public static void main(String args[]) {
3

HelloService service = new HelloService();
4

Hello helloProxy = service.getHelloPort();
5

String hello = helloProxy.hello("你好");
6

System.out.println(hello);
7

}
8

}
9

     以上方法還稍顯繁瑣，還有更加簡單的方法

2、使用xfire，我這裏使用的是myeclipse集成的xfire進行測試的
    利用xfire開發WebService，能夠有三種方法：
      1一種是從javabean 中生成；
      2 一種是從wsdl文件中生成；
      3 還有一種是本身創建webservice
    步驟以下：
    用myeclipse創建webservice工程，目錄結構以下：

    首先創建webservice接口，
     代碼以下：

package com.myeclipse.wsExample;
2

//Generated by MyEclipse
3

public interface IHelloWorldService {
5

public String example(String message);
7

}

接着實現這個藉口：

package com.myeclipse.wsExample;
2

//Generated by MyEclipse
3

public class HelloWorldServiceImpl implements IHelloWorldService {
5

public String example(String message) {
7

return message;
8

}
9

}

修改service.xml 文件，加入如下代碼：

<service>
2

<name>HelloWorldService</name>
3

<serviceClass>
4

com.myeclipse.wsExample.IHelloWorldService
5

</serviceClass>
6

<implementationClass>
7

com.myeclipse.wsExample.HelloWorldServiceImpl
8

</implementationClass>
9

<use>literal</use>
11

<scope>application</scope>
12

</service>

把整個項目部署到tomcat服務器中，打開瀏覽器，輸入http://localhost:8989/HelloWorld/services/HelloWorldService?wsdl,能夠看到以下：

而後再展開HelloWorldService後面的wsdl能夠看到：

客戶端實現以下：

package com.myeclipse.wsExample.client;
2

import java.net.MalformedURLException;
4

import java.net.URL;
5

import org.codehaus.xfire.XFireFactory;
7

import org.codehaus.xfire.client.Client;
8

import org.codehaus.xfire.client.XFireProxyFactory;
9

import org.codehaus.xfire.service.Service;
10

import org.codehaus.xfire.service.binding.ObjectServiceFactory;
11

import com.myeclipse.wsExample.IHelloWorldService;
13

public class HelloWorldClient {
15

public static void main(String[] args) throws MalformedURLException, Exception {
16

// TODO Auto-generated method stub
17

Service s=new ObjectServiceFactory().create(IHelloWorldService.class);
18

XFireProxyFactory xf=new XFireProxyFactory(XFireFactory.newInstance().getXFire());
19

String url="http://localhost:8989/HelloWorld/services/HelloWorldService";
20

try
22

{
23

IHelloWorldService hs=(IHelloWorldService) xf.create(s,url);
25

String st=hs.example("zhangjin");
26

System.out.print(st);
27

}
28

catch(Exception e)
29

{
30

e.printStackTrace();
31

}
32

}
33

}
35

這裏再說點題外話，有時候咱們知道一個wsdl地址，好比想用java客戶端引用.net 作得webservice，使用myeclipse引用，可是卻出現沒法經過驗證的錯誤，這時咱們能夠直接在類中引用，步驟以下：

public static void main(String[] args) throws MalformedURLException, Exception {
2

// TODO Auto-generated method stub
3

Service s=new ObjectServiceFactory().create(IHelloWorldService.class);
4

XFireProxyFactory xf=new XFireProxyFactory(XFireFactory.newInstance().getXFire());
5

//遠程調用.net開發的webservice
8

Client c=new Client(new URL("http://www.webxml.com.cn/webservices/qqOnlineWebService.asmx?wsdl"));
9

Object[] o=c.invoke("qqCheckOnline", new String[]{"531086641","591284436"});
10

//調用.net本機開發的webservice
12

Client c1=new Client(new URL("http://localhost/zj/Service.asmx?wsdl"));
13

Object[] o1=c1.invoke("HelloWorld",new String[]{});
14

}

3、使用axis1.4調用webservice方法
   前提條件：下載axis1.4包和tomcat服務器   ，並將axis文件夾複製到tomcat服務器的webapp文件夾中
   這裏我就說一下最簡單的方法：
         首先創建一個任意的java類（例如：HelloWorld.java），複製到axis文件夾下,將其擴展名改成jws，而後從新啓動tomcat，在瀏覽器中輸入http://localhost:8989/axis/HelloWorld.jws?wsdl，就會獲得一個wsdl文件，其客戶端調用方法以下：

import javax.xml.rpc.Service;
2

import javax.xml.rpc.ServiceException;
3

import javax.xml.rpc.ServiceFactory;
4

import java.net.MalformedURLException;
6

import java.net.URL;
7

import java.rmi.RemoteException;
8

import javax.xml.namespace.QName;
10

public class TestHelloWorld {
12

public static void main(String[] args) throws MalformedURLException, ServiceException, RemoteException {
15

// TODO Auto-generated method stub
16

String wsdlUrl ="http://localhost:8989/axis/HelloWorld.jws?wsdl";
18

String nameSpaceUri ="http://localhost:8989/axis/HelloWorld.jws";
19

String serviceName = "HelloWorldService";
20

String portName = "HelloWorld";
21

ServiceFactory serviceFactory = ServiceFactory.newInstance();
23

Service afService =serviceFactory.createService(new URL(wsdlUrl),new QName(nameSpaceUri, serviceName));
24

HelloWorldInterface proxy = (HelloWorldInterface)afService.getPort(new QName(nameSpaceUri, portName),HelloWorldInterface.class);
25

System.out.println("return value is "+proxy.getName("john") ) ;
26

}
28

}
30

4、使用axis2開發webservice（這裏首先感謝李寧老師）
使用axis2 須要先下載

axis2-1.4.1-bin.zip

axis2-1.4.1-war.zip

  http://ws.apache.org/axis2/
同理，也須要將axis2複製到webapp目錄中
在axis2中部署webservice有兩種方法，
    第一種是pojo方式，這種方式比較簡單，可是有一些限制，例如部署的類不能加上包名
    第二種方式是利用xml發佈webservice，這種方法比較靈活，不須要限制類的聲明
    下面分別說明使用方法：
    1.pojo方式：在Axis2中不須要進行任何的配置，就能夠直接將一個簡單的POJO發佈成WebService。其中POJO中全部的public方法將被髮布成WebService方法。先實現一個pojo類：

public class HelloWorld{
2

public String getName(String name)
3

{
4

return "你好 " + name;
5

}
6

public int add(int a,int b)
7

{
8

return a+b;
9

}
10

}
11

因爲這兩個方法都是public類型，因此都會發布成webservice。編譯HelloWorld類後，將HelloWorld.class文件放到%tomcat%\webapps\axis2\WEB-INF\pojo目錄中（若是沒有pojo目錄，則創建該目錄），而後打開瀏覽器進行測試：
輸入一下url：

http://localhost:8080/axis2/services/listServices

會列出全部webservice

這是其中的兩個webservice列表，接着，在客戶端進行測試：
首先能夠寫一個封裝類，減小編碼，代碼以下：

package MZ.GetWebService;
2

import javax.xml.namespace.QName;
3

import org.apache.axis2.AxisFault;
5

import org.apache.axis2.addressing.EndpointReference;
6

import org.apache.axis2.client.Options;
7

import org.apache.axis2.rpc.client.RPCServiceClient;
8

public class GetWSByAxis2 {
11

private static String EndPointUrl;
12

private static String QUrl="http://ws.apache.org/axis2";
13

private QName opAddEntry;
14

public String WSUrl;
15

public RPCServiceClient setOption() throws AxisFault
16

{
17

RPCServiceClient serviceClient = new RPCServiceClient();
18

Options options = serviceClient.getOptions();
19

EndpointReference targetEPR = new EndpointReference(WSUrl);
20

options.setTo(targetEPR);
21

return serviceClient;
22

}
23

public QName getQname(String Option){
25

return new QName (QUrl,Option);
27

}
28

//返回String
29

public String getStr(String Option) throws AxisFault
30

{
31

RPCServiceClient serviceClient =this.setOption();
32

opAddEntry =this.getQname(Option);
34

String str = (String) serviceClient.invokeBlocking(opAddEntry,
36

new Object[]{}, new Class[]{String.class })[0];
37

return str;
38

}
39

// 返回一維String數組
40

public String[] getArray(String Option) throws AxisFault
41

{
42

RPCServiceClient serviceClient =this.setOption();
43

opAddEntry =this.getQname(Option);
45

String[] strArray = (String[]) serviceClient.invokeBlocking(opAddEntry,
47

new Object[]{}, new Class[]{String[].class })[0];
48

return strArray;
49

}
50

//從WebService中返回一個對象的實例
51

public Object getObject(String Option,Object o) throws AxisFault
52

{
53

RPCServiceClient serviceClient =this.setOption();
54

QName qname=this.getQname(Option);
55

Object object = serviceClient.invokeBlocking(qname, new Object[]{},new Class[]{o.getClass()})[0];
56

return object;
57

}
58

///////////////////////////////////////// 讀者能夠本身封裝數據類型，如int,byte,float等數據類型
60

}
61

客戶端調用方法：

MZ.GetWebService.GetWSByAxis2 ws=new MZ.GetWebService.GetWSByAxis2();

ws.WSUrl="http://localhost:8989/axis2/services/HelloWorld";

HelloWorld hello= (HelloWorld)ws.getObject("getName", HelloWorld.class);

System.out.println(hello.getName("zhangjin"));

2.使用service.xml發佈webservice，這種方式和直接放在pojo目錄中的POJO類不一樣。要想將MyService類發佈成Web Service，須要一個services.xml文件，這個文件須要放在META-INF目錄中，該文件的內容以下：

HelloWorld webservice

</description>

service.HelloWorld

</parameter>

<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>

其中<service>元素用於發佈Web Service，一個<service>元素只能發佈一個WebService類，name屬性表示WebService名，以下面的URL能夠得到這個WebService的WSDL內容：
http://localhost:8080/axis2/services/myService?wsdl
除此以外，還有直接能夠在其中制定webservice操做方法：能夠這樣些service.xml文件

<service name="HelloWorld">
2

<description>
3

HelloWorld service
4

</description>
5

<parameter name="ServiceClass">
6

service.HelloWorld
7

</parameter>
8

<operation name="getName">
9

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

</operation>
11

<operation name="add">
12

<messageReceiver
13