RMI 與 Spring

RMI 是 Java 平臺實現遠端呼叫的一種方式，於 JDK1.1 引入 Java 平臺。“Spring 簡化了 RMI 模型，它提供了一個代理工廠 Bean ,能讓我們把 RMI 服務像本地 JavaBean 一樣裝配到我們的 Spring 應用中。”這裡再多說一句， RMI 是 RPC 在 Java 平臺的一種實現方式。

RMI 使用的注意事項

RMI 釋出服務和呼叫服務需要指定埠，這意味著需要穿越防火牆，如果需要訪問外網的話。
RMI 的服務端涉及到兩個埠，即註冊埠和服務埠，註冊埠相當於服務的接線員，服務埠是客戶端真正要找的業務人員。註冊埠預設為1099，服務埠是隨機分配的，所以在有防火牆的情況下需要自己指定。
RMI 是基於 Java 的，那麼服務端和客戶端都必須是 Java 開發的。
如果客戶端配置為快取服務端服務（即客戶端 cacheStub=true），那麼在伺服器端重啟的時候，客戶端呼叫會報錯，解決辦法有兩個:一個是客戶端設定無快取（即客戶端 cacheStub=false），再一個方法是允許快取呼叫失敗後從新發起配置呼叫（refreshStubOnConnectFailure=true）。所以到這裡，可以理解為 RMI 遠端呼叫需要通過註冊埠建立通道，然後通過服務埠訪問業務。
如果需要在遠端呼叫中傳輸物件，必須注意 Java 物件的序列化問題（

傳送門）。

RMI-Spring 測試概況

我們使用三個專案來完成整個測試。

• api :定義介面和實體資訊，內含抽象方法。
• server:實現api中的介面，並且對外提供 RMI 遠端服務。啟動方式為 main 函式啟動。
• consumer:一個web專案，通過配置將遠端服務注入到本地介面實現遠端呼叫。
• master:Maven 聚合父專案，便於clean 、install。
  

api 主要程式碼

• 實體類 Model.java

import java.io.Serializable;
public class Model implements Serializable
 
{
    private static final long serialVersionUID = 1L;
    private String userName;
    private int age;
    //get\set 方法略
}

• 介面 ApiService.java

public interface ApiService {
    String getName(String name);//輸入什麼，返回什麼
    Model getModel();//返回實體類-測試遠端傳遞物件
}

server 主要程式碼

• 介面實現類 ApiServiceImpl.java

public class ApiServiceImpl implements ApiService{

    @Override
    public String getName(String name) {
        System.out.println("服務端被呼叫");
        return name;
    }

    @Override
    public Model getModel() {
        Model m=new Model();
        m.setUserName("jecket");
        m.setAge(20);
        return m;
    }
}

• Spring Bean 註冊與遠端服務配置

可以使用註解配置

• Java 配置類

@Configuration
public class RpcBean {

    /**
     * 註冊為遠端服務
     * @return
     */
    @Bean
    public RmiServiceExporter rmiExporter(){
        RmiServiceExporter rmi=new RmiServiceExporter();
        rmi.setService(getApiService());//介面實現 Spring Bean
        rmi.setServiceName("ApiService");//遠端服務名字
        rmi.setServiceInterface(ApiService.class);//介面
        rmi.setRegistryPort(8080);//遠端服務註冊埠
        rmi.setServicePort(8082);//遠端服務業務訪問埠
        return rmi;
    }

    /**
     * 註冊為Spring Bean
     * @return
     */
    @Bean 
    public ApiService getApiService(){
        return new ApiServiceImpl();
    }

}

• Spring 配置掃描資訊

<context:component-scan base-package="com.bestcxx.stu.rpc.rmi.bean"/><!--RpcBean.java 所在包路勁 -->

也可以使用xml的配置方式

• Spring 配置檔案內容

 <bean id="apiService" class="com.bestcxx.stu.rpc.rmi.service.ApiServiceImpl" /> <!--Spring bean--> 
 <bean id="serviceExporter" class="org.springframework.remoting.rmi.RmiServiceExporter">  <!--RMI 遠端服務配置-->
      <property name="service" ref="apiService" />  
      <property name="serviceName" value="apiService" />  
      <property name="serviceInterface" value="com.bestcxx.stu.rpc.rmi.api.ApiService" />  
      <property name="registryPort" value="8080" /><!-- 註冊埠 -->
<property name="servicePort" value="8080"/><!-- 通訊埠，不指定就隨機   -->
  </bean>  

• 啟動 Server

public static void main(String[] args) {
         ApplicationContext ctx = 
         new ClassPathXmlApplicationContext("classpath:spring/applicationContext-bean.xml");  
         System.out.println("服務端啟動...");
    }

consumer 主要程式碼

• 為遠端服務設定代理服務，註冊為本地Bean
  

  可以使用註解配置
  rmi://127.0.0.1:8080/ApiService 中，127.0.0.1是遠端服務地址，8080是遠端服務註冊埠，ApiService 是遠端服務名稱

@Configuration
public class RpcBean {

    @Bean
    public RmiProxyFactoryBean apiService(){

        RmiProxyFactoryBean rmiProxy=new RmiProxyFactoryBean();

        //遠端服務地址，直接指定了具體的host、ip、服務名稱
        rmiProxy.setServiceUrl("rmi://192.168.149.1:8080/ApiService");
        //rmiProxy.setServiceUrl("rmi://127.0.0.1:8080/ApiService");

        //定義遠端服務介面，服務端是該介面對應遠端服務的實現
        rmiProxy.setServiceInterface(ApiService.class);

        //定義是否在首次配置遠端服務後快取該配置
        rmiProxy.setCacheStub(true);

        //如果遠端呼叫快取配置報錯,設定為true，允許重新呼叫
        rmiProxy.setRefreshStubOnConnectFailure(false);

        //是否在客戶端啟動的時候檢測服務端服務可用性-測試發現該屬性沒有發揮作用
        rmiProxy.setLookupStubOnStartup(false);
        return rmiProxy;

    }

}

• Spring 配置掃描資訊

<context:component-scan base-package="com.bestcxx.stu.rpc.rmi.bean"/><!--RpcBean.java 所在包路勁 -->

也可以使用xml配置

<bean id="apiService" class="org.springframework.remoting.rmi.RmiProxyFactoryBean">  
        <property name="serviceUrl" value="rmi://192.168.149.1:8080/ApiService" />  
        <property name="serviceUrl" value="rmi://localhost:8080/ApiService" />  
        <property name="refreshStubOnConnectFailure" value="true" />  
        <property name="lookupStubOnStartup" value="false" />  
        <property name="serviceInterface" value="com.bestcxx.stu.rpc.rmi.api.ApiService" />  
    </bean>  

• controller 層呼叫

@RestController
public class HomeController {

    @Autowired
    private ApiService apiService;

    /**
     * Controller 訪問案例,根據id訪問資料庫
     * @return
     */
    @RequestMapping("/home")
    public Map<String,Object> home(){
        Map<String,Object> map=new HashMap<String,Object>();

        String name=apiService.getName("jecket");//呼叫 String 型別返參方法
        Model m=apiService.getModel();//呼叫物件型別返參方法
        map.put("result", "success");
        map.put("name", name);
        map.put("model", m);
        return map; 
    }

}

結果展示

服務端在本地啟動，客戶端不知道其他網路環境訪問

• 伺服器端：

服務端啟動...
服務端被呼叫

• 瀏覽器訪問客戶端

{"result":"success","name":"jecket","model":{"userName":"jecket","age":20}}

github 地址