Spring 远程调用

一、Spring 远程调用概览

远程调用是客户端应用和服务端之间的会话。
远程过程调用(remote procedure call, RPC)。vong表面上看，RPC 类似于调用一个本地对象的一个方法。这两者都是同步操作，会阻塞调用代码的执行，直到被调用的过程执行完毕。
Spring 支持多种不同的 RPC 模型：

RPC 模型	使用场景
远程方法调用(RMI)	不考虑网络限制时（例如防火墙），访问/发布 基于 Java 的服务
Hessian 或 Burlap	考虑网络限制时，通过 HTTP 访问/发布 基于 java 的服务。Hessian 是二进制协议，Burlap 是基于 xml 的
HTTP invoker(Spring 自带)	考虑网络限制，并希望使用基于 xml 或专有的序列化机制实现 Java 序列化时，访问/发布基于 Spring 的服务
JAX-RPC 和 JAX-WS	访问/发布平台独立的、基于 SOAP 的 Web 服务

在所有的模型中，服务都作为 Spring 所管理的 bean 配置到应用中。这是通过一个带工厂bean 实现的，这个 bean 能够把远程服务像本地对象一样转配到其他 bean 的属性中。客户端向代理发起调用，代理代表客户端与远程服务进行通信，它负责处理连接的细节并向远程服务发起调用。
可以使用远程导出器将 bean 发布为远程服务。在 Spring 中，使用远程服务纯粹是一个配置问题，无需编写代码就可以支持远程调用，服务 bean 也无需关心是否参与了一个 RPC。

二、使用 RMI

RMI 是Java最初的远程调用技术。

1、导出 RMI 服务

原始步骤：

1. 编写一个服务实现类，类中的方法必须抛出 java.rmi.RemoteException 异常
2. 创建一个继承于 java.rmi.Remote 的服务接口
3. 运行 RMI 编译器(rmic)，创建客户端 stub 类 和服务端 skeleton 类
4. 启动一个 RMI 注册表，以便持有这些服务
5. 在 RMI 注册表中注册服务

在 Spring 中配置 RMI 服务
使用 Spring 的 RmiServiceExporter 把需要发布的类转变为 RMI 服务。例如将 UserServiceImpl 发布为 RMI 服务：

    /**
     * @author Cedar
     * @DESCRIPTION:将 UserService 导出为 RMI 服务
     * @params: [userService]
     * @return: org.springframework.remoting.rmi.RmiServiceExporter
     * @Date: 2019/3/6 17:26
    */
    @Bean
    public RmiServiceExporter rmiServiceExporter(UserService userService){
        RmiServiceExporter rmiServiceExporter = new RmiServiceExporter();
        rmiServiceExporter.setService(userService);
        rmiServiceExporter.setServiceName("UserService");
        rmiServiceExporter.setServiceInterface(UserService.class);
        return  rmiServiceExporter;
    }

默认 RmiServiceExporter 会尝试绑定到本机 1099 端口上的 RMI 注册表。如果这个端口没有发现 RMI 注册表，RmiServiceExporter 将会启动一个注册表。如果希望绑定到不同端口或主机上的 RMI 注册表，则可以如下设置。

rmiServiceExporter.setRegistryHost("127.0.1.1");
rmiServiceExporter.setRegistryPort(1199);

2、装配 RMI 服务

传统上，RMI 客户端必须使用 RMI API 的 Naming 类从 RMI 注册表中查找服务。例如：

try {
 String serviceUrl = "rmi:/user/UserService";
 UserService userService = (UserService) Naming.lookup(serviceUrl);
 ···
}
catch(){}

Spring 的 RmiProxyFactoryBean 是一个工厂bean ，该 bean 可以为 RMI 服务创建代理。只需要 再客户端的 Spring 配置中增加 如下 @Bean 方法：

	@Bean
    public RmiProxyFactoryBean userService(){
        RmiProxyFactoryBean rmiProxyFactoryBean = new RmiProxyFactoryBean();
        rmiProxyFactoryBean.setServiceUrl("rmi://localhost/UserService");
        rmiProxyFactoryBean.setServiceInterface(UserService.class);
        return  rmiProxyFactoryBean;
    }

这样就可以将它作为依赖装配进另一个 bean 中，就像本地的 bean一样：

@Autowired
UserService userService;

三、使用 Spring 的 HttpInvoker

HTTP Invoker 是一个新的远程调用模型，作为 Spring 框架的一部分，能够执行基于 HTTP 的远程调用，并使用 Java 的序列化机制。

1、将 bean 导出为 HTTP 服务

使用 HttpInvockerServiceExporter，例如：

    /**
     * @author Cedar
     * @DESCRIPTION: 导出为基于 HTTP Invoker 的服务
     * @params: [userService]
     * @return: org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter
     * @Date: 2019/3/8 15:01
    */
    @Bean
    public HttpInvokerServiceExporter httpExporterUserService(UserService userService){
        HttpInvokerServiceExporter httpInvokerServiceExporter = new HttpInvokerServiceExporter();
        httpInvokerServiceExporter.setService(userService);
        httpInvokerServiceExporter.setServiceInterface(UserService.class);
        return httpInvokerServiceExporter;
    }

HttpInvockerServiceExporter 是一个 MVC 控制器，它通过 DispatcherServlet 接收来自于客户端的请求，并将这些请求转换成对实现服务的 POJO 的方法调用。还需要建立一个 URL 处理器，映射 HTTP URL 到对应的服务上

	@Bean
    public HandlerMapping httpInvokerMapping(){
        SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
        Properties mappings = new Properties();
        mappings.setProperty("/user.service","httpExporterUserService");
        mapping.setMappings(mappings);
        return  mapping;
    }

2、通过 HTTP 访问服务

配置代理 bean :

    @Bean
    public HttpInvokerProxyFactoryBean httpInvokerUserService(){
        HttpInvokerProxyFactoryBean invokerProxyFactoryBean = new HttpInvokerProxyFactoryBean();
        invokerProxyFactoryBean.setServiceUrl("http://localhost:8080/User/user.service");
        invokerProxyFactoryBean.setServiceInterface(UserService.class);
        return  invokerProxyFactoryBean;
    }

HttpInvoker 是 Spring 框架所提供的远程调用，客户端和服务端必须都是 Spring 应用。另外，因为是用来 Java 的序列化机制，客户端和服务端必须使用相同版本的类(类似 RMI )。

四、发布和使用 WEB 服务

近几年，最流行的一个 TLA （三个字母缩写）就是 SOA (面向服务的架构)。SOA 的核心理念是，应用程序可以并且应该被设计成依赖于一组公共的核心服务，而不是为每个应用都重新实现相同的功能。
Spring 为使用 Java API for XML Web Service (JAX-WS) 来发布和使用 SOAP Web 服务提供了支持。

1、创建基于 Spring 的JAX-WS 的端点

Spring 提供了一个 JAX-WS 服务导出器，SimpleJaxWsWerviceExpoter，它要求 JAX-WS 运行时支持将端点发布到指定地址上。Sun JDK 1.6 自带的 JAX-WS 可以符合要求，但是其他的 JAX-WS 可能不满足此需求。
如果将要部署的 JAX-WS 运行时不支持将其发布的指定地址上，就要以更传统的方式编写 JAX-WS 端点。这意味着端点的生命周期由 JAX-WS 运行时来进行管理，而不是Spring。但是它依然可以装配为上下文中bean。

在 Spring 中自动装配 JAX-WS 端点
JAX-WS 编程模型使用注解类和类的方法声明为 Web 服务的操作。使用 @WebService 注解所标注的类被认为 web 服务的端点，使用 @WebMethord 标注的方法被认为是操作。
如果端点的声明周期由 JAX-WS 运行时管理，这似乎不能把 Spring 管理的 bean 装配进 JAX-WS 管理的端点实例中。关键在于SpringBeanAutowiringSupport，通过继承它可以使用 @Autowired注解标注端点的属性。

@WebService(serviceName = "UserService")
public class UserServiceEndpoint extends SpringBeanAutowiringSupport {
    @Autowired
    UserService userService;  //自动装配UserService

    @WebMethod
    public User saveUser(User user) {
        return userService.saveUser(user); //委托给 UserService
    }

    @WebMethod
    public List<User> findAll() {
        return userService.listAllUser();
    }
}

导出独立的 JAX-WS 端点
Spring SimpleJaxWsWerviceExpoter 把 Spring 管理的bean 发布为 JAX-WS 运行时中的端点，与其他服务导出器不同，不需要为它指定一个被导出 bean 的引用，它会将使用 JAX-WS 注解所标注的所有bean发布为 JAX-WS 服务。

    @Bean
    public SimpleJaxWsServiceExporter jaxWsServiceExporter(){
        SimpleJaxWsServiceExporter simpleJaxWsServiceExporter = new SimpleJaxWsServiceExporter();
        //默认
        simpleJaxWsServiceExporter.setBaseAddress("http://localhost:8080/");
        return simpleJaxWsServiceExporter;
    }

SimpleJaxWsServiceExporter 会搜索Spring 应用上下文来查找使用 @WebService 注解的bean ，使用 http://localhost:8080/ 将bean 发布为 JAX-WS 端点。serviceName = "UserService" ，则形成的web服务地址为：http://localhost:8080/UserService 。 例如：

@Component
@WebService(serviceName = "UserService")
public class UserServiceEndpointExporter {
    @Autowired
    UserService userService;  //自动装配UserService

    @WebMethod
    public User saveUser(User user) {
        return userService.saveUser(user); //委托给 UserService
    }

    @WebMethod
    public List<User> findAll() {
        return userService.listAllUser();
    }
}

无需继承任何类，但是它只支持将端点发布到指定地址的 JAX-WS 运行时中。

2、在客户端代理 JAX-WS 服务

使用 JaxWsProxyFactoryBean装配 web 服务，它能生成一个知道如何与 SOAP Web 服务交互的代理。

 	@Bean
    public JaxWsPortProxyFactoryBean jaxWsUserService() throws MalformedURLException {
        JaxWsPortProxyFactoryBean proxyFactoryBean = new JaxWsPortProxyFactoryBean();
        URL url = new URL("http://localhost:8080");
        proxyFactoryBean.setWsdlDocumentUrl(url);
        proxyFactoryBean.setServiceName("userService");
        proxyFactoryBean.setPortName("userServiceHttpPort");
        proxyFactoryBean.setServiceInterface(UserService.class);
        proxyFactoryBean.setNamespaceUri("http://user.com");
        return  proxyFactoryBean;
    }

WsdlDocumentUrl属性标识了远程 web 服务定义文件的位置，ServiceInterface属性指定代理实现的接口。剩下的属性通过查看服务的 WSDL 来确定，假如是这样的：

<wsdl:definitions tagetNamespace="http://user.com">
···
	<wsdl:service name="userService">
		<wsdl:port name="userServiceHttpPort" binding="tns:userServiceHttpBinding">
		···
		</wsdl:port>
	</wsdl:port>
</wsdl:definitions>

namespaceUri属性指定了服务的命名空间，它有助于 JaxWsPortProxyFactoryBean 去定位WSDL 中的服务定义。