Java 中 RMI 的使用

RMI 介紹

RMI (Remote Method Invocation) 模型是一種分佈式對象應用，使用 RMI 技術可以使一個 JVM 中的對象，調用另一個 JVM 中的對象方法並獲取調用結果。這裡的另一個 JVM 可以在同一台計算機也可以是遠程計算機。因此，RMI 意味着需要一個 Server 端和一個 Client 端。

Server 端通常會創建一個對象，並使之可以被遠程訪問。

  • 這個對象被稱為遠程對象。
  • Server 端需要註冊這個對象可以被 Client 遠程訪問。

Client 端調用可以被遠程訪問的對象上的方法，Client 端就可以和 Server 端進行通信並相互傳遞信息。

說到這裡，是不是發現使用 RMI 在構建一個分佈式應用時十分方便，它和 RPC 一樣可以實現分佈式應用之間的互相通信，甚至和現在的微服務思想都十分類似。

RMI 工作原理

正所謂 「知其然知其所以然」，在開始編寫 RMI 代碼之前，有必要了解一下 RMI 的工作原理，RMI 中 Client 端是和 Server 端是如何通信的呢？

下圖的可以幫助我們理解RMI 的工作流程。

從圖中可以看到，Client 端有一個被稱 Stub 的東西，有時也會被成為存根，它是 RMI Client 的代理對象，Stub 的主要功能是請求遠程方法時構造一個信息塊，RMI 協議會把這個信息塊發送給 Server 端。

這個信息塊由幾個部分組成：

  • 遠程對象標識符。
  • 調用的方法描述。
  • 編組後的參數值（RMI協議中使用的是對象序列化）。

既然 Client 端有一個 Stub 可以構造信息塊發送給 Server 端，那麼 Server 端必定會有一個接收這個信息快的對象，稱為 Skeleton 。

它主要的工作是：

  • 解析信息快中的調用對象標識符和方法描述，在 Server 端調用具體的對象方法。
  • 取得調用的返回值或者異常值。
  • 把返回值進行編組，返回給客戶端 Stub.

到這裡，一次從 Client 端對 Server 端的調用結果就可以獲取到了。

RMI 開發

通過上面的介紹，知道了 RMI 的概念以及 RMI 的工作原理，下面介紹 RMI 的開發流程。

這裡會通過一個場景進行演示，假設 Client 端需要查詢用戶信息，而用戶信息存在於 Server 端，所以在 Server 端開放了 RMI 協議接口供客戶端調用查詢。

RMI Server

Server 端主要是構建一個可以被傳輸的類 User，一個可以被遠程訪問的類 UserService，同時這個對象要註冊到 RMI 開放給客戶端使用。

  1. 定義服務器接口（需要繼承 Remote 類，方法需要拋出 RemoteException）。

    package com.wdbyte.rmi.server;

import java.rmi.Remote;
import java.rmi.RemoteException;


/**
 * RMI Server
 *
 * @author www.wdbyte.com
 * @date 2021/05/08
 */
public interface UserService extends Remote {

    /**
     * 查找用戶
     * 
     * @param userId
     * @return
     * @throws RemoteException
     */
    User findUser(String userId) throws RemoteException;
}

    User 對象在步驟 3 中定義。

  2. 實現服務器接口（需要繼承 UnicastRemoteObject 類，實現定義的接口）。

    package com.wdbyte.rmi.server;

import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;

/**
 * @author www.wdbyte.com
 * @date 2021/05/08
 */
public class UserServiceImpl extends UnicastRemoteObject implements UserService {

    protected UserServiceImpl() throws RemoteException {
    }

    @Override
    public User findUser(String userId) throws RemoteException {
        // 加載在查詢
         if ("00001".equals(userId)) {
            User user = new User();
            user.setName("金庸");
            user.setAge(100);
            user.setSkill("寫作");
            return user;
        }
        throw new RemoteException("查無此人");
    }
}

  3. 定義傳輸的對象，傳輸的對象需要實現序列化（Serializable）接口。

    需要傳輸的類一定要實現序列化接口，不然傳輸時會報錯。IDEA 中如何生成 serialVersionUID，在文章末尾也附上了簡單教程。

    package com.wdbyte.rmi.server;

import java.io.Serializable;

/**
 *
 * @author www.wdbyte.com
 * @date 2021/05/08
 */
public class User implements Serializable {

    private static final long serialVersionUID = 6490921832856589236L;

    private String name;
    private Integer age;
    private String skill;

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getSkill() {
        return skill;
    }

    public void setSkill(String skill) {
        this.skill = skill;
    }
    
    @Override
    public String toString() {
        return "User{" +
            "name='" + name + '\'' +
            ", age=" + age +
            ", skill='" + skill + '\'' +
            '}';
    }
}

  4. 註冊（ rmiregistry）遠程對象，並啟動服務端程序。

    服務端綁定了 UserService 對象作為遠程訪問的對象，啟動時端口設置為 1900。

    package com.wdbyte.rmi.server;

import java.rmi.Naming;
import java.rmi.registry.LocateRegistry;

/**
 * RMI Server 端
 *
 * @author //www.wdbyte.com
 * @date 2021/05/08
 */
public class RmiServer {

    public static void main(String[] args) {
        try {
            UserService userService = new UserServiceImpl();
            LocateRegistry.createRegistry(1900);
            Naming.rebind("rmi://localhost:1900/user", userService);
            System.out.println("start server,port is 1900");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

RMI Client

相比 Server 端，Client 端就簡單的多。直接引入可遠程訪問和需要傳輸的類，通過端口和 Server 端綁定的地址，就可以發起一次調用。

package com.wdbyte.rmi.client;

import java.rmi.Naming;

import com.wdbyte.rmi.server.User;
import com.wdbyte.rmi.server.UserService;

/**
 * @author //www.wdbyte.com
 * @date 2021/05/08
 */
public class RmiClient {
    public static void main(String args[]) {
        User answer;
        String userId = "00001";
        try {
            // lookup method to find reference of remote object
            UserService access = (UserService)Naming.lookup("rmi://localhost:1900/user");
            answer = access.findUser(userId);
            System.out.println("query:" + userId);
            System.out.println("result:" + answer);
        } catch (Exception ae) {
            System.out.println(ae);
        }
    }
}

RMI 測試

啟動 Server 端。

start server,port is 1900

啟動 Client 端。

query:00001
result:User{name='金庸', age=100, skill='寫作'}

如果 Client 端傳入不存在的 userId。

java.rmi.ServerException: RemoteException occurred in server thread; nested exception is: 
	java.rmi.RemoteException: 查無此人

serialVersionUID 的生成

IDEA 中生成 serialVersionUID，打開設置，如下圖所示勾選。

選中要生成 serialVersionUID 的類，按智能提示快捷鍵。

參考

[1] //docs.oracle.com/javase/tutorial/rmi/overview.html

訂閱

可以關注未讀代碼博客或者微信搜索「 未讀代碼 」。

文章會在博客和公眾號同步更新。

Tags:

VirMach 便宜 VPS

QNews

QNews