WebService之XFire和SOAP实例(基于JAVA)

开发环境：jdk1.6 + Tomcat7 + MyEclipse10
源码下载地址张贴在文章最后面：
首先是使用WSDL协议实现:这里使用XFire
XFire一个免费、开源的SOAP框架，它构建了POJO和SOA之间的桥梁，主要特性就是支持将POJO通过非常简单的方式发布成Web服务，其原理是以接口反射机制自动取得远程方法的
WSDL是一个用来描述Web服务和说明如何与Web服务通信的XML语言

准备：开发之前请先下载xfire-distribution-1.2.6.zip并解压缩

(1)、新建一个Web项目(服务端)，名称为XFireWebService，其目的是为了测试WebService服务端
为工程添加XFire支持的类库，把xfire-1.2.6里lib所有jar和xfire-all-1.2.6.jar拷贝到工程lib里

(2)、把XFire加载到系统中来，增加web.xml的配置信息

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.5" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<servlet>
<servlet-name>XFireServlet</servlet-name>
<servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>
<load-on-startup>0</load-on-startup>
</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>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>

(3)、创建Web服务接口，声明该Web服务对外暴露的接口

package com.test.ws;
import java.util.List;
/**
* Title: IHelloService
* Description: 定义接口
*/
public interface IHelloService {
public String getTestString(String str);
public ExceedVO getTestObject(EnterVO vo);
public List getTestList(List list);
}

(4)、创建Web服务实现类，为Web服务接口提供实现

package com.test.ws;
import java.util.ArrayList;
import java.util.List;
/**
* Title: HelloServiceImpl
* Description: 接口实现
*/
public class HelloServiceImpl implements IHelloService {
@Override
public String getTestString(String str) {
return "Hello" + str;
}
@Override
public ExceedVO getTestObject(EnterVO vo) {
ExceedVO revo = new ExceedVO();
revo.setDescStr("名称："+vo.getName()+"年龄："+vo.getAge());
return revo;
}
@Override
public List getTestList(List list) {
List<EnterVO> users = new ArrayList<EnterVO>();
for(int i=0; i<9; i++){
EnterVO user = new EnterVO("姓名"+i, i);
users.add(user);
}
return users;
}
}

(5)、这两个类是具体的业务实现类，对业务方法的具体实现放在里面

package com.test.ws;
import java.io.Serializable;
/**
* Title: EnterVO
* Description: 入参对象
*/
public class EnterVO implements Serializable {
private static final long serialVersionUID = 1L;
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public EnterVO(String name, int age) {
this.name = name;
this.age = age;
}
public EnterVO() { }
}
package com.test.ws;
import java.io.Serializable;
/**
* Title: ExceedVO
* Description: 出参对象
*/
public class ExceedVO implements Serializable {
private static final long serialVersionUID = 1L;
private String descStr;
public String getDescStr() {
return descStr;
}
public void setDescStr(String descStr) {
this.descStr = descStr;
}
}

(6)、在src目录下新建一个META-INF/xfire/services.xml,该文件是XFire框架的服务发布文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
<service>
<name>HelloService</name>
<namespace>http://test/HelloService</namespace>
<serviceClass>com.test.ws.IHelloService</serviceClass>
<implementationClass>com.test.ws.HelloServiceImpl</implementationClass>
</service>
</beans>

(7)、注意：当用到List等集合类型时，需要定义Mapping关系
必须与接口同名后缀.aegis.xml，而且要与接口同一位置

<mappings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xfire.codehaus.org/schemas/1.0/mapping.xsd">
<mapping>
<method name="getTestList">
<parameter index="0" componentType="java.lang.String" />
<return-type componentType="com.test.ws.EnterVO" />
</method>
</mapping>
</mappings>

web.xml和service.xml都可以通过IDE自动生成，也可以手写

(8)、到这步webService服务端就基本完成
部署项目，启动Tomcat，测试一下wsdl，访问http://localhost:8080/XFireWebService/services/HelloService?wsdl
如果能正确显示wsdl文件，说明刚才的部署成功了！！！

(9)、再建一个Web项目(客户端)，名称为XFireWebClient，其目的是用来调用一个webService服务
将XFire的库文件拷贝到Web项目的WEB-INF\lib目录下，同时需要将服务器端发布的服务打包发布给客户端，发布给客户端的代码只需要打包接口和参数类即可，实现类不必打包到客户端
这里发布的jar包名称为IHelloService.jar，里面包含IHelloService、EnterVO、ExceedVO这三个类

(10)、在这个Web项目里面新建一个Servlet作为测试的Servlet，名称为ClientTestServlet.java
在web.xml里面配置好这个Servlet后，就可以在Servlet里面写webService调用的代码了

package com.test.ws;
import java.io.IOException;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.codehaus.xfire.XFire;
import org.codehaus.xfire.XFireFactory;
import org.codehaus.xfire.client.XFireProxyFactory;
import org.codehaus.xfire.service.Service;
import org.codehaus.xfire.service.binding.ObjectServiceFactory;
/**
* Title: ClientTestServlet
* Description: 测试Servlet
*/
public class ClientTestServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
request.setCharacterEncoding("UTF-8");
Service serviceModel = new ObjectServiceFactory().create(IHelloService.class);
XFire xfire = XFireFactory.newInstance().getXFire();
XFireProxyFactory factory = new XFireProxyFactory(xfire);
String serviceUrl = "http://localhost:8080/XFireWebService/services/HelloService";
IHelloService client = null;
try {
client = (IHelloService) factory.create(serviceModel, serviceUrl);
} catch (MalformedURLException e) {
e.printStackTrace();
}
String str = client.getTestString("Beijing");
request.setAttribute("str", str);
EnterVO enterVO = new EnterVO();
enterVO.setName("Yaodi");
enterVO.setAge(26);
ExceedVO vo = client.getTestObject(enterVO);
request.setAttribute("vo", vo);
List<String> al = new ArrayList<String>();
al.add("111");
al.add("222");
al.add("333");
List list = client.getTestList(al);
request.setAttribute("list", list);
request.getRequestDispatcher("/result.jsp").forward(request, response);
}
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doGet(request,response);
}
}

客户端的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>ClientTestServlet</servlet-name>
<servlet-class>com.test.ws.ClientTestServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>ClientTestServlet</servlet-name>
<url-pattern>/ClientTest.do</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>ClientTest.do</welcome-file>
</welcome-file-list>
</web-app>

(11)、注意：XFireWebService项目里的IHelloService.aegis.xml文件，也要放到XFireWebClient项目中来，位置与ClientTestServlet.java同级

(12)、Servlet返回的结果页面：result.jsp

<%@ page language="java" pageEncoding="UTF-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<%@ page isELIgnored="false"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>测试客户端</title>
</head>
<body>
测试客户端！！！
String：${str}
Object：${vo.descStr}
List：
<c:forEach items="${list}" var="list">
${list.name} --- ${list.age}
</c:forEach>
</body>
</html>

(13)、同样将这个Web项目发布，同时启动XFireWebService和XFireWebClient这两个应用，然后在地址栏里面输入http://localhost:8080/XFireWebClient/
此时会调用客户端的Servlet，然后调用其doGet方法，如果正常的话，可以看到页面输出结果了(*^__^*)

注：参考文章地址http://di201yao.iteye.com/blog/310292

源码下载地址（测试通过,下载时需要修改tomcat服务器的端口，我用的端口是18080）：http://download.csdn.net/detail/carboncomputer/8445449

巴特西

WebService之XFire和SOAP实例(基于JAVA)

最新文章

热门文章