Spring技术内幕——深入解析Spring架构与设计原理(五)Spring与远端调用
在应用开发中,常常涉及服务器系统中各种不同进程之间的通信与计算交互,远端调用(RMI)是实现这种计算场景的一种有效方式。此外,还存在着另一种情况,在这种应用场景中,与那些典型的基于HTML的B/S应用不同,客户端程序需要完成对服务器端应用的直接调用,这也是需要远端调用大显身手的场合。
Spring中提供了轻量级的远端调用模块,从而为我们在上面提到的应用场景开发,提供平台支持。根据Spring的既定策略,它依然只是起到一个集成平台的作用,而并不期望在实现方案上,与已有的远端调用方案形成竞争。也就是说,在Spring远端调用架构中,具体的通信协议设计、通信实现,以及在服务器和客户端对远端调用的处理封装,Spring没有将其作为实现重点,在这个技术点上,并不需要重新发明轮子。对Spring来说,它所要完成的工作,是在已有远端调用技术实现的基础上,通过IoC与AOP的封装,让应用更方便地使用这些远端调用服务,并能够更方便灵活地与现有应用系统实现集成。通过Spring封装以后,应用使用远端过程调用非常方便,既不需要改变原来系统的相关实现接口,也不需要为远端调用功能增加新的封装负担。因此,这种使用方式,在某种程度上,可以称为轻量级的远端调用方案。
在实现远端调用的过程中,往往需要涉及客户端和服务器端的相关设置,这些设置通过Spring的IoC容器就可以很好的完成,这是我们已经很熟悉的IoC容器的强项了。同时,Spring为远端调用的实现,提供了许多不同的方案,玲琅满目,任君选择。如RMI、HTTP调用器、第三方远端调用库Hessian/Burlap、基于Java RMI的解决方案,等等。
Spring对不同的远端调用的实现封装,基本上,都采用了类似的模式来完成,比如在客户端,都是通过相关的ProxyFactoryBean和ClientInterceptor来完成的,在服务器端是通过ServiceExporter来导出远端的服务对象的。有了这些统一的命名规则,应用配置和使用远端调用会非常方便,同时,通过对这些Spring远端调用基础设施实现原理的分析,还可以看到一些常用处理方法的技术实现,比如对代理对象的使用、拦截器的使用、通过afterPropertiesSet来启动远端调用基础设施的建立,等等,这些都是在Spring中常用的技术。
HTTP调用器客户端的实现
在HtttpInvokerProxyFactory中,设置了serviceProxy对象作为远端服务的本地代理对象;同时,在依赖注入完成以后,通过afterPropertiesSet来对远端调用完成设置。
public class HttpInvokerProxyFactoryBean extends HttpInvokerClientInterceptorimplements FactoryBean<Object> {//这是远端对象的代理private Object serviceProxy;@Override//在注入完成之后,设置远端对象代理public void afterPropertiesSet() {super.afterPropertiesSet();//需要配置远端调用的接口if (getServiceInterface() == null) {throw new IllegalArgumentException("Property 'serviceInterface' is required");}//这里使用ProxyFactory来生成远端代理对象,注意这个this,因为HttpInvokerProxyFactoryBean的基类是HttpInvokerClientInterceptor,所以代理类的拦截器被设置为HttpInvokerClientInterceptorthis.serviceProxy = new ProxyFactory(getServiceInterface(), this).getProxy(getBeanClassLoader());}//FactoryBean生产对象的入口。返回的是serviceProxy对象,这是一个代理对象public Object getObject() {return this.serviceProxy;}public Class<?> getObjectType() {return getServiceInterface();}public boolean isSingleton() {return true;}
//对代理对象的方法调用入口public Object invoke(MethodInvocation methodInvocation) throws Throwable {if (AopUtils.isToStringMethod(methodInvocation.getMethod())) {return "HTTP invoker proxy for service URL [" + getServiceUrl() + "]";}//创建RemoteInvocation对象,这个对象封装了对远端的调用,这些远端调用通过序列化的机制完成RemoteInvocation invocation = createRemoteInvocation(methodInvocation);RemoteInvocationResult result = null;try {//这里是对远端调用的入口result = executeRequest(invocation, methodInvocation);}catch (Throwable ex) {throw convertHttpInvokerAccessException(ex);}try {//返回远端调用的结果return recreateRemoteInvocationResult(result);}catch (Throwable ex) {if (result.hasInvocationTargetException()) {throw ex;}else {throw new RemoteInvocationFailureException("Invocation of method [" + methodInvocation.getMethod() +"] failed in HTTP invoker remote service at [" + getServiceUrl() + "]", ex);}}}
//这是HTTP调用器实现的基本过程,通过HTTP的request和reponse来完成通信,在通信的过程中传输的数据是序列化的对象protected RemoteInvocationResult doExecuteRequest(HttpInvokerClientConfiguration config, ByteArrayOutputStream baos)throws IOException, ClassNotFoundException {//打开一个标准J2SE HttpURLConnectionHttpURLConnection con = openConnection(config);prepareConnection(con, baos.size());//远端调用封装成RemoteInvocation对象,这个对象通过序列化被写到对应的HttpURLConnection中去writeRequestBody(config, con, baos);//这里取得远端服务返回的结果,然后把结果转换成RemoteInvocationResult返回validateResponse(config, con);InputStream responseBody = readResponseBody(config, con);return readRemoteInvocationResult(responseBody, config.getCodebaseUrl());}//把序列化对象输出到HttpURLConnection去protected void writeRequestBody(HttpInvokerClientConfiguration config, HttpURLConnection con, ByteArrayOutputStream baos)throws IOException {baos.writeTo(con.getOutputStream());}//为使用HttpURLConnection完成对象序列化,需要进行一系列的配置//比如配置请求方式为post,请求属性等等protected void prepareConnection(HttpURLConnection con, int contentLength) throws IOException {con.setDoOutput(true);con.setRequestMethod(HTTP_METHOD_POST);con.setRequestProperty(HTTP_HEADER_CONTENT_TYPE, getContentType());con.setRequestProperty(HTTP_HEADER_CONTENT_LENGTH, Integer.toString(contentLength));LocaleContext locale = LocaleContextHolder.getLocaleContext();if (locale != null) {con.setRequestProperty(HTTP_HEADER_ACCEPT_LANGUAGE, StringUtils.toLanguageTag(locale.getLocale()));}if (isAcceptGzipEncoding()) {con.setRequestProperty(HTTP_HEADER_ACCEPT_ENCODING, ENCODING_GZIP);}}//获得HTTP响应的IO流protected InputStream readResponseBody(HttpInvokerClientConfiguration config, HttpURLConnection con)throws IOException {//如果是通过gzip压缩,那么需要先解压if (isGzipResponse(con)) {// GZIP response found - need to unzip.return new GZIPInputStream(con.getInputStream());}else {// Plain response found.// 正常的HTTP响应输出return con.getInputStream();}}
protected Object invoke(RemoteInvocation invocation, Object targetObject)throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {if (logger.isTraceEnabled()) {logger.trace("Executing " + invocation);}try {//调用RemoteInvocationExecutor,这个执行器是DefaultRemoteInvocationExecutorreturn getRemoteInvocationExecutor().invoke(invocation, targetObject);}catch (NoSuchMethodException ex) {if (logger.isDebugEnabled()) {logger.warn("Could not find target method for " + invocation, ex);}throw ex;}catch (IllegalAccessException ex) {if (logger.isDebugEnabled()) {logger.warn("Could not access target method for " + invocation, ex);}throw ex;}catch (InvocationTargetException ex) {if (logger.isDebugEnabled()) {logger.debug("Target method failed for " + invocation, ex.getTargetException());}throw ex;}}
protected void writeRemoteInvocationResult(HttpServletRequest request, HttpServletResponse response, RemoteInvocationResult result)throws IOException {//设置Response的ContentType属性,设置为application/x-java-serialized-objectresponse.setContentType(getContentType());writeRemoteInvocationResult(request, response, result, response.getOutputStream());}//输出到HTTP的Response,然后把Response关闭protected void writeRemoteInvocationResult(HttpServletRequest request, HttpServletResponse response, RemoteInvocationResult result, OutputStream os)throws IOException {ObjectOutputStream oos = createObjectOutputStream(decorateOutputStream(request, response, os));try {doWriteRemoteInvocationResult(result, oos);oos.flush();}finally {oos.close();}}