Axis的高级应用(一)

本文属于原创,转载请著明出处.欢迎各位朋友和我一起讨论.共同学习交流

      上一篇介绍了Axis的三种发布方式,之前有提到,应用得最广泛的还是stub方式.本章主要是围绕stub方式发布的webservice服务而展开.讲解将从浅到深,依次展开.

      本章将涉及到的内容主要是 handler 的应用. Handler和Chain是Axis引擎提供的一个很强大的工具.假如现在客户有以下需求:

       1.记录来访客户端的IP地址.

       2.记录webservice服务被访问的次数.

       3.以日志的形式记录以上两个信息.

       具体分析下来,该需求并不是很复杂.有几种解决方案:

       1.在所访问的webservice服务中实现一个全局变量,每次有访问,则加1,且取得IP

       2.在访问的入口处记录访问次数和IP

       假设现在对外提供10个webservice服务,那么采用第一种解决方案,势必要重复10次代码.若采用第二种解决方案,我们只需要实现handler,即可解决所有问题.handler的好处初步显露出来.下面看代码

服务端代码

package myservice;
public class MyService implements MyServiceInterface{

	public String processService(String arg) {
		return arg;
	}
	
	public String processService(String arg1, String arg2) throws Exception{
		return " welcome !";
	}
}

当客户端调用processService方法时,返回字符串

 

LogHandler类

public class LogHandler extends BasicHandler {
	public void invoke(MessageContext msgContext) throws AxisFault {
		// 每当web服务被调用，都记录到log中。
		try {
			Handler handler = msgContext.getService();
			String filename = (String) getOption("log");
			if ((filename == null) || (filename.equals(""))) {
				throw new AxisFault("Server.NoLogFile",
						"No log file configured for the LogHandler!", null,
						null);
			}
			URL url = ClassLoader.getSystemResource("");
			String path = "";
			if (url != null) {
				path = url.getPath();
				if (path.lastIndexOf("/work") != -1) {
					path = path.substring(0, path.length() - "/work".length());
				}
			}
			FileOutputStream fos = new FileOutputStream(path + filename, true);
			PrintWriter writer = new PrintWriter(fos);
			Integer counter = (Integer) handler.getOption("accesses");
			if (counter == null) {
				counter = new Integer(0);
			}
			counter = new Integer(counter.intValue() + 1);
			Date date = new Date();

			HttpServletRequest request = (HttpServletRequest) msgContext
					.getProperty(HTTPConstants.MC_HTTP_SERVLETREQUEST);
			msgContext.getMessage().writeTo(System.out);
			String result = "在" + date + ": Web 服务 "
					+ msgContext.getTargetService() + " 被来自 "
					+ getRealIpAddress(request) + " 调用, 现在已经共调用了 " + counter
					+ " 次.";
			handler.setOption("accesses", counter);
			writer.println(result);
			System.out.println(result);
			writer.close();
		} catch (Exception e) {
			throw AxisFault.makeFault(e);
		}
	}
}

BasicHandler是一个抽象类，Axis提供了很多Handler的具体实现，BasicHandler只是其中最简单的一个。invoke方法必须在BasicHandler的子类中实现.getOption(String name)方法是取得HashMap中的键值对中的值(稍后贴出源码).该LogHandler取"log"属性的文件名,创建日志文件,将访问端的IP地址和访问次数写入日志中.

 

getRealIpAddress(HttpRequest request)方法如下

public String getRealIpAddress(HttpServletRequest request) throws Exception {
		String ip = request.getRemoteAddr();
		try {
			ip = request.getHeader("x-forwarded-for");
			if (ip == null || ip.length() == 0
					|| "unknown".equalsIgnoreCase(ip)) {
				ip = request.getHeader("Proxy-Client-IP");
			}
			if (ip == null || ip.length() == 0
					|| "unknown".equalsIgnoreCase(ip)) {
				ip = request.getHeader("WL-Proxy-Client-IP");
			}
			if (ip == null || ip.length() == 0
					|| "unknown".equalsIgnoreCase(ip)) {
				ip = request.getRemoteAddr();
			}
		} catch (Exception ex) {
			throw ex;
		}
		return ip;
	}

上面这段代码我就不解释了,大家google一下

 

关键部分来了,来看看发布的deploy.wsdd

<deployment xmlns="http://xml.apache.org/axis/wsdd/"
	xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">
	<!-- 定义全局LogHandler -->
	<!-- 该Log用来记录访问者的IP地址等客户端信息 -->
	<handler name="Log" type="java:handler.LogHandler">  
       <parameter name="log" value="appliction.log"/>  
    </handler>
	<service name="MyService" provider="java:RPC">
		<parameter name="className" value="myservice.MyService" />
		<parameter name="allowedMethods" value="*" />		
		<!-- webservice服务中的object的生命周期 -->
		<!-- request, session, application -->
		<parameter name="scope" value="session"/>
		<requestFlow>  
       		<handler type="Log"/>   		
     	</requestFlow>  
	</service>
</deployment>

在应用的的 */WEB-INF/ 的目录下,执行命令

java -Djava.ext.dirs=lib org.apache.axis.client.AdminClient -lhttp://localhost:8080/axis_example/servlet/AxisServlet deploy.wsdd

(注意:1 在web.xml中要定义AxisServlet 和 AdminClient; 2 tomcat要在启动状态下)

命令成功后将生成server-config.wsdd,片段截取如下

 <handler name="Log" type="java:handler.LogHandler">
  <parameter name="log" value="appliction.log"/>
 </handler>
 <service name="MyService" provider="java:RPC">
  <requestFlow>
   <handler type="Log"/>
  </requestFlow>
  <parameter name="allowedMethods" value="*"/>
  <parameter name="scope" value="session"/>
  <parameter name="className" value="myservice.MyService"/>
 </service>

看到这,大家可能会猜到LogHandler类中getOption("log")的含义.没错.他就是取<parameter name="log" value="appliction.log"/>, 取得的值为"appliction.log". 为了验证自己的猜想,找到axis对应的源码.看看吧.

public abstract class BasicHandler implements Handler {
    protected boolean makeLockable = false;
    protected Hashtable options;
    protected String name;

    protected void initHashtable()
    {
        if (makeLockable) {
            options = new LockableHashtable();
        } else {
            options = new Hashtable();
        }
    }

    public void setOption(String name, Object value) {
        if ( options == null ) initHashtable();
        options.put( name, value );
    }

    public Object getOption(String name) {
        if ( options == null ) return( null );
        return( options.get(name) );
    }
}

Handler通过getOption(String)这个方法拿到了配置文件中我配置的属性值,而我们上述所做的所有工作对于原来的Webserivce来说都是透明的,不会对侵入原有的程序当中。一个Handler可以被多个service所使用通过<requestFlow>这个标签来引用到某一个service中,这里还要多提一句既然是一个requestFlow,这个当然可以加不只一个的Handler。除了<requestFlow>之外,Axis还提供了与之相应的</responseFlow>,用法和是requestflow一样的,所不同的是一个在service执行之前一个是之后。可以加下面代码到发布文件中的<service>元素下就可以实现responseflow的功能.在以后的文章中,会见到这两个标签的具体使用.在此先暂时不表.

 

     下一张,将在此章的基础上做一些扩展.我们来看看Handler其他的应用. 包括用户认证和权限认证,最后将引出chain的使用.