日期:2014-05-17  浏览次数:20801 次

Apache xml-rpc与spring的整合
  之前在项目中使用了Apache xml-rpc,遇到了一个麻烦的问题。spring没有提供对xml-rpc的支持,在处理webservice请求的时候,没有办法使用spring容器中管理的各种各样的bean对象。显然,这是不能接受的。

  使用Apache xml-rpc,一般只需要在web.xml中定义一个servlet (XmlRpcServlet), 再实现用于处理webservice请求的组件类就可以了。
  比如定义一个Servlet:
<servlet>
	<servlet-name>XmlRpcServlet</servlet-name>
	<servlet-class>org.apache.xmlrpc.webserver.XmlRpcServlet</servlet-class>
	<init-param>
		<param-name>enabledForExtensions</param-name>
		<param-value>true</param-value>
	</init-param>
</servlet>

  实现处理webservice请求的组件:
public class Calculator
{
	public int add(int i1, int i2)
	{
		return i1 + i2;
	}
}

  除此之外,还需要定义一个property文件,告诉xml-rpc,在请求来了以后,用哪个组件去处理。这个property文件必须命名为XmlRpcServlet.properties,并且必须放到org.apache.xmlrpc.webserver包下面。
Calculator=com.oyl.Calculator

  这样,当webservice收到请求后,就会初始化一个新的组件对象去处理请求。这样,新的问题也来了,一般的web应用程序都使用spring来管理各个业务组件,通过上面的例子不难发现,我们没有办法使用spring管理的bean去处理webservice的请求,每次都初始化一个新的对象去处理请求,也会造成资源的浪费。
  那么,怎么才能在xml-rpc中使用spring管理的bean去处理webservice的请求呢?
  首先,要实现一个接口org.apache.xmlrpc.server.RequestProcessorFactoryFactory,这个接口类定义了如何创建对象去处理webservice请求:
public class CustomRequestProcessorFactoryFactory implements
        RequestProcessorFactoryFactory
{
    private final RequestProcessorFactory factory = new CustomRequestProcessorFactory();
    private final CustomWebServiceHandler service;


    public CustomRequestProcessorFactoryFactory(CustomWebServiceHandler service)
    {
        this.service = service;
    }


    @Override
    public RequestProcessorFactory getRequestProcessorFactory(Class arg0)
            throws XmlRpcException
    {
        return factory;
    }

    private class CustomRequestProcessorFactory implements
            RequestProcessorFactory
    {

        @Override
        public Object getRequestProcessor(XmlRpcRequest arg0)
                throws XmlRpcException
        {
            return service;
        }

    }
}

  仔细看代码会发现,接口org.apache.xmlrpc.server.RequestProcessorFactoryFactory实际上就是一个工厂的工厂,它是一个用于创建处理webservice请求对象的工厂的工厂类。在上面的例子中,创建webservice请求对象的工厂类是一个实现了RequestProcessorFactory接口的内部类,它主要是返回我们真正需要用来处理请求的CustomWebServiceHandler对象。
  有了上面这个工厂的工厂类,我们还需要扩展一下默认的XmlRpcServlet。主要是实现newXmlRpcHandlerMapping方法,在newXmlRpcHandlerMapping方法中,把需要用到的spring bean对象取出来,再作为参数创建一个RequestProcessorFactoryFactory对象,就可以达到目的了。
public class CustomXmlRpcServlet extends XmlRpcServlet
{
    private static final long serialVersionUID = 8615627610262194L;
    protected static ApplicationContext ctx = null;

    public CustomXmlRpcServlet()
    {
        super();
    }


    public void init()
    {
        if (ctx == null)
        {
            ctx = WebApplicationContextUtils
                    .getRequiredWebApplicationContext(this.getServletContext());
        }
    }


    protected XmlRpcHandlerMapping newXmlRpcHandlerMapping()
            throws XmlRpcException
    {
        PropertyHandlerMapping mapping = new PropertyHandlerMapping();
        
        CustomWebServiceHandler service = (CustomWebServiceHandler) ctx.getBean("customWebServiceHandler");
        
        mapping.setRequestProcessorFactoryFactory(new CustomRequestProcessorFactoryFactory(service));
        mapping.addHandler("CustomWebServiceHandler", CustomWebServiceHandler.class);

        return mapping;
    }
}

  这样扩展以后,之前提到的XmlRpcServlet.properties文件也不再需要了。