用XFire做的带验证（Handler方式）的Webservice！！！（完整版）

XFire是一个Webservice的框架。搞XFire两天了，前面也写了几篇文章，这里再写一个生产中的比较规范的demo，意图使人直接看到这篇文章也能实验成功。提供webservice接口给别人调用一般是给一个wsdl文件，这样别人就可以根据这个文件自动生成工具类进行调用。本文章带验证功能，生产中的webservice接口也不是知道地址就能调用的，最起码的一个账户、密码验证还是要的。废话不多说了！

 

简单分析下将要实现的功能，以便后面容易理解。调接口会拿到一个list，里面装的是自定义的类，前提是要先通过用户名和密码的验证才能拿到list结果，否则会提示身份验证失败！！！后面看到将会有两个项目，服务端：webservice 客户端：webserviceclient 。服务端和客户端都要加入xfire的jar包（xfire下的xfire-all-1.2.6.jar和xfire/lib下的*.jar，最好是复制到项目的lib下面，否则可能会出现一些不可预料的错误。），其中服务端要在web.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>/*</url-pattern> </servlet-mapping>

就这样开发环境算是搭好了，其中客户端大部分是利用ant根据wsdl自动生成的，这也是为什么webservice接口一般要求提供一个wsdl的原因了吧。还要说下项目的结构：

webservice：

WebserviceConstant类 抽取的项目中一般喜欢写死的常量，这样更灵活。（一改全改，统一维护）

Webservicehandler类 返回list集合的webservice接口实现类

WebserviceInfo类 JavaBean，list集合中装的就是这个自定义对象。

 WebserviceInterface类 webservice接口

WebserviceIpParameter类 读取配置文件的类，不是用户名和密码要通过验证嘛，服务端就是把的配置起来的，采用单例。

WebserviceServerHandler 服务端验证类，在里面验证用户名和密码

config.properties 放在src下面的。配置的是用户名和密码

src/META-INF/xfire/services.xml webservice的配置类。

WebserviceInterface.aegis.xml aegis绑定配置文件 

 

webserviceclient：

WebServiceTest.java 自己写的测试类

 WebserviceClientHandler.java 客户端调用接口需要传递验证信息，这个类就是构造验证信息的。

webserviceclient/build.xml 在项目下面的，根据wsdl自动生成一些代码到客户端

 

开发环境：xfire-distribution-1.2.6.zip、jdk1.6、eclipse3.2、tomcat6.0

需要说的基本都交代清楚了吧，没有说清楚的后面想到再说，我不是写书的，也就是想到哪说哪。草草的总结一个而已。下面上代码：

 

服务端代码,都是在webservice项目下面的 WebserviceInterface

package com.zte; import java.util.List; /** * 接口类 * * @author Administrator * */ public interface WebserviceInterface { public List<WebserviceInfo> getList(Integer id); }

 

WebserviceInterface.aegis.xml

<?xml version="1.0" encoding="UTF-8"?> <mappings> <mapping> <method name="getCollection"> <parameter index="0" mappedName="id"/> <return-type componentType="com.zte.WebserviceInfo"/> </method> </mapping> </mappings>

 

Webservicehandler

package com.zte; import java.util.ArrayList; import java.util.List; /** * 实现类 * * @author Administrator * */ public class Webservicehandler implements WebserviceInterface { @Override public List<WebserviceInfo> getList(Integer id) { List<WebserviceInfo> list = new ArrayList<WebserviceInfo>(); for (int i = 1; i <= 10; i++) { WebserviceInfo info = new WebserviceInfo(); info.setId(i); info.setValue(i * id + ""); list.add(info); } return list; } }

 

 WebserviceInfo

package com.zte; import java.io.Serializable; /** * JavaBean * * @author Administrator * */ public class WebserviceInfo implements Serializable { private static final long serialVersionUID = 3110812885882821496L; private Integer id; private String value; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getValue() { return value; } public void setValue(String value) { this.value = value; } }

 

WebserviceIpParameter

package com.zte; import java.io.IOException; import java.io.InputStream; import java.util.Properties; /** * 读取配置文件的类 * * @author Administrator * */ public class WebserviceIpParameter { private static WebserviceIpParameter parameter = null; Properties prop = null; private WebserviceIpParameter() { InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream( WebserviceConstant.CONFIG); if (prop == null) { prop = new Properties(); } try { prop.load(inputStream); } catch (IOException e) { e.printStackTrace(); } } public static WebserviceIpParameter getInstance() { if (parameter == null) { parameter = new WebserviceIpParameter(); } return parameter; } public String getValue(String key) { return prop.getProperty(key); } }

 

config.properties

webservice.username=admin webservice.password=123

 

WebserviceConstant

package com.zte; /** * 常量类 * * @author Administrator * */ public class WebserviceConstant { public static final String TOKEN = "AuthenticationToken"; public static final String USERNAME = "Username"; public static final String PASSWORD = "Password"; public static final String HEADER = "header"; public static final String CONFIG = "config.properties"; public static final String NAMEKEY = "webservice.username"; public static final String PAWDKEY = "webservice.password"; }

 

WebserviceServerHandler

package com.zte; import org.codehaus.xfire.MessageContext; import org.codehaus.xfire.fault.XFireFault; import org.codehaus.xfire.handler.AbstractHandler; import org.jdom.Element; /** * 服务端验证类 * * @author Administrator * */ public class WebserviceServerHandler extends AbstractHandler { @Override public void invoke(MessageContext context) throws Exception { if (context.getInMessage().getHeader() == null) { throw new XFireFault("----------请求必须包含身份验证信息！----------", XFireFault.SENDER); } Element token = context.getInMessage().getHeader().getChild(WebserviceConstant.TOKEN); if (token == null) { throw new XFireFault("----------请求必须包含身份验证信息！----------", XFireFault.SENDER); } String username = token.getChild(WebserviceConstant.USERNAME).getValue(); String password = token.getChild(WebserviceConstant.PASSWORD).getValue(); try { WebserviceIpParameter parameter = WebserviceIpParameter.getInstance(); String nameValue = parameter.getValue(WebserviceConstant.NAMEKEY); String pawdValue = parameter.getValue(WebserviceConstant.PAWDKEY); if (username.equals(nameValue) && password.equals(pawdValue)) { System.out.println("----------身份验证通过！----------"); } else { throw new Exception(); } } catch (Exception e) { throw new XFireFault("----------非法的用户名或密码！----------", XFireFault.SENDER); } } }

 

services.xml

<?xml version="1.0" encoding="UTF-8"?> <beans> <service xmlns="http://xfire.codehaus.org/config/1.0"> <name>WebService</name> <namespace>mca</namespace> <serviceClass>com.zte.WebserviceInterface</serviceClass> <implementationClass>com.zte.Webservicehandler</implementationClass> <inHandlers> <handler handlerClass="com.zte.WebserviceServerHandler"/> </inHandlers> </service> </beans>

 

接下来是客户端代码，webserviceclient下的

WebserviceClientHandler

package test; import org.codehaus.xfire.MessageContext; import org.codehaus.xfire.handler.AbstractHandler; import org.jdom.Element; import com.zte.WebserviceConstant; /** * 构造授权信息类 * * @author Administrator * */ public class WebserviceClientHandler extends AbstractHandler { private String username = null; private String password = null; public WebserviceClientHandler() { } public WebserviceClientHandler(String username, String password) { this.username = username; this.password = password; } public void setUsername(String username) { this.username = username; } public void setPassword(String password) { this.password = password; } @Override public void invoke(MessageContext context) throws Exception { Element el = new Element(WebserviceConstant.HEADER); context.getOutMessage().setHeader(el); Element auth = new Element(WebserviceConstant.TOKEN); Element username_el = new Element(WebserviceConstant.USERNAME); username_el.addContent(username); Element password_el = new Element(WebserviceConstant.PASSWORD); password_el.addContent(password); auth.addContent(username_el); auth.addContent(password_el); el.addContent(auth); } }

 

WebServiceTest

package test; import java.lang.reflect.Proxy; import java.util.List; import org.codehaus.xfire.client.Client; import org.codehaus.xfire.client.XFireProxy; import com.zte.WebserviceInfo; public class WebServiceTest { public static void main(String[] args) { WebServiceClient wclient = new WebServiceClient(); WebServicePortType service = wclient.getWebServiceHttpPort(); XFireProxy proxy = (XFireProxy) Proxy.getInvocationHandler(service); Client client = proxy.getClient(); client.addOutHandler(new WebserviceClientHandler("admin", "123")); List<WebserviceInfo> list = service.getList(6).getWebserviceInfo(); for (WebserviceInfo info : list) { System.out.println("id=" + info.getId().getValue() + ";value=" + info.getValue().getValue()); } } }

 

build.xml

<?xml version="1.0" encoding="UTF-8"?> <project name="xfireAnt" basedir="." default="createCode"> <property name="xfirelib" value="${basedir}/WebContent/WEB-INF/lib"/> <property name="sources" value="${basedir}/src"/> <path id="classpath"> <fileset dir="${xfirelib}"> <include name="*.jar"/> </fileset> </path> <target name="createCode"> <taskdef name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask" classpathref="classpath"/> <wsgen outputDirectory="${sources}" wsdl="http://127.0.0.1:8080/webservice/WebService?wsdl" package="test" overwrite="true"/> </target> </project>

 

WebServiceTest中的代码有很多类是没有介绍到的，一部分是jar里面带的，一部分是ant生成的。

build.xml 中的http://127.0.0.1:8080/webservice/WebService?wsdl是常量。

${basedir}/WebContent/WEB-INF/lib 是xfire的jar路径

客户端的WebserviceClientHandler类代码中用到了服务端的那个常量类，注意要在客户端引入。

还要说下原理，客户端和服务端分别都有个handler类（handler就类似与拦截器那种东东），服务端是验证身份，客户端是构造验证身份传给服务端。服务端验证通过了才调接口，否则抛出异常。

下面贴出的是虚拟的、其中服务端查找、客户端构造的虚拟的xml。在实际项目中是不存在的，再说一次虚拟的。贴出来是方面发家理解代码

 <AuthenticationToken> <Username>admin</Username> <Password>123</Password> </AuthenticationToken>

最后在贴出两个项目的截图：

webserviceclient/src/com.zte和mca和test都是生成的

webserviceclient中只手写了2个类一个xml（WebServiceTest.java WebserviceClientHandler.javabuild.xml）