axis2系列之模块（Module）编写

Axis2 可以通过模块（Module）进行扩展。Axis2 模块至少需要有两个类，这两个类分别实现了 Module 和 Handler接口。开发和使用一个 Axis2 模块的步骤如下：

1. 编写实现Module接口的类，Axis2模块在进行初始化，销毁等动作时会调用该类中相应的方法。
   
2. 编写实现Handler接口的类，该类是Axis2模块的业务处理类。
   
3. 编写module.xml文件。该文件放在META-INF目录下(与services.xml文件在同级目录下)，用于配置Axis2模块。
   
4. 在WEB-INF目录下建立conf文件夹，将Axis2中的axis2.xml文件复制到该文件夹下，并在该文件中配置axis2模块。  在axis2.xml文件中，找到如下四个元素，<phaseOrder type="InFlow">，<phaseOrder type="OutFlow">，<phaseOrder type="InFaultFlow"> ，<phaseOrder type="OutFaultFlow">，分别在该四个元素中末尾加上在module.xml文件中配置的<order>元素值。                                                                                                    举例：                                                                                                                                                                          module.xml:<order parse="loggingPhase"/>                                                                                                              axis2.xml :                                                                                                                                                                                  <phaseOrder type="InFlow">                                                                                                                                          ....                                                                                                                                                                            <phase name="loggingPhase"/>                                                                                                                    </phaseOrder>
5. 在services.xml文件中配置axis2模块。每一个axis2模块都需要使用<module>元素引用才能使用。                           在services.xml文件中引入logging模板：<module name="logging"/>，name在module.xml文件中配置。
   
6. 发布axis2模块，需要使用jar命令将axis2模块压缩成.mar包，并放在modules文件夹下。                                          在系统盘符下，创建任意文件夹,比如test，并在该文件夹下创建如下格式的目录：                                             举例：
      Module类的全类名：module.main.LoggingModule
      Handler类的全类名：module.handler.LoggingHandler
      test文件夹下的目录结构如下：
      ----module
      -----------main
      -------------LoggingModule.class
      -----------handler
     -------------LoggingHandler.class
     ----META-INF
      --------module.xml
     
     在dos命令下进入到test文件夹下，执行如下命令：
      jar cvf logging.jar .
     执行完成后，将test文件夹下的logging.jar的后缀改成.mar，
     然后将axis2安装包中的modules文件夹复制到工程中的WEB-INF目录下，并将logging.mar复制到该文件夹下，
     最后打开该modules文件夹下的modules.list文件，将logging.mar加入其中。

一、编写实现Module接口的类

/**
 * 该类虽然没有实现实际的功能，但是必须要存在的，因为模块的初始化与销毁都必须在该类中完成
 * @author Administrator
 *
 */
public class LoggingModule implements Module {

	//初始化模块
	@Override
	public void init(ConfigurationContext context, AxisModule module)
			throws AxisFault {
		System.out.println("初始化完成！！！");
	}
	
	@Override
	public void applyPolicy(Policy policy, AxisDescription desc) throws AxisFault {

	}

	@Override
	public boolean canSupportAssertion(Assertion assertion) {
		return true;
	}

	@Override
	public void engageNotify(AxisDescription desc) throws AxisFault {

	}

	//停止模块执行
	@Override
	public void shutdown(ConfigurationContext context) throws AxisFault {

		System.out.println("模块已停止执行。。。");
	}

}

二、编写实现Handler接口的类

public class LoggingHandler extends AbstractHandler implements Handler{

	private static final Log log = LogFactory.getLog(LogHandler.class);
	private String name;
	
	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	@Override
	public InvocationResponse invoke(MessageContext msgContext) throws AxisFault {
		//向tomcat控制台输出请求和相应的SOAP信息
		log.info(msgContext.getEnvelope().toString());
		return InvocationResponse.CONTINUE;
	}
	
	public void revoke(MessageContext msgContext){
		log.info(msgContext.getEnvelope().toString());
	}

}

三、编写module.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<module name="logging" class="com.test.module.main.LoggingModule">
<InFlow>
<handler name="InFlowLogHandler" class="com.test.module.handler.LoggingHandler">
<order phase="loggingPhase"/>
</handler>
</InFlow>
<OutFlow>
<handler name="OutFlowLogHandler" class="com.test.module.handler.LoggingHandler">
<order phase="loggingPhase"/>
</handler>
</OutFlow>
<OutFaultFlow>
<handler name="FaultOutFlowLogHandler" class="com.test.module.handler.LoggingHandler">
<order phase="loggingPhase"/>
</handler>
</OutFaultFlow>
<InFaultFlow>
<handler name="FaultInFlowLogHandler" class="com.test.module.handler.LoggingHandler">
<order phase="loggingPhase"/>
</handler>
</InFaultFlow>
</module>

四、编写axis2.xml文件

<phaseOrder type="InFlow">
		......
		<phase name="soapmonitorPhase" />
		<phase name="loggingPhase" />
	</phaseOrder>
	<phaseOrder type="OutFlow">
		......
		<phase name="Security" />
		<phase name="loggingPhase" />
	</phaseOrder>
	<phaseOrder type="InFaultFlow">
		......
		<phase name="soapmonitorPhase" />
		<phase name="loggingPhase" />
	</phaseOrder>
	<phaseOrder type="OutFaultFlow">
		......
		<phase name="Security" />
		<phase name="loggingPhase" />
	</phaseOrder>

五、在services.xml文件中配置axis2模块

<service name="moduleService">
<description>
使用 logging 模块
</description>
<!-- 引用 logging 模块 -->
<module ref="logging"/>
<parameter name="ServiceClass">
com.test.moduleservice.ModuleService
</parameter>
<messageReceivers>
<messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
</messageReceivers>
</service>

服务器端与客户端的代码与普通web service 一样，在此省略。

执行结果：

在程序启动时，LoggingModule进行数据的初始化，输出：

在客户端调用成功后，LoggingHandler获得服务器响应信息，在此例中，仅仅打印：

信息: <?xml version='1.0' encoding='utf-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body><getGreeting xmlns="http://impl.moduleservice.test.com"><arg0 xmlns="">bill</arg0><arg1 xmlns="">123</arg1>

</getGreeting></soapenv:Body></soapenv:Envelope>

客户端结果：

最总项目目录结构如下：