Skip to content

Latest commit

 

History

History
122 lines (89 loc) · 7.74 KB

README.zh.md

File metadata and controls

122 lines (89 loc) · 7.74 KB
Raw

EasyRPC

巨简单，巨直接的 RPC 工具，基于 Java Socket 和 Google Gson。

简介

提前说明，这不是一个正式项目！我不建议您将此工具用于真实项目，此项目仅用于教学目的！

什么是 RPC？它是 远程过程调用（Remote Procedure Call） 的简称。意思是客户端调用服务端上的方法，然后将输出结果返回给客户端的过程。RPC 能使得网络系统更简洁明了。

了解更多有关 RPC 的知识，点击这里。

使用 RPC Server and RPC Client，可以快速构建你的 Java C-S 程序！

蕴藏在其中的，是 ServerSocket 和 Socket（当然还有 Thread），非常简单明了！

安装

你需要为你的项目引入 Gson 库。文件本身已经放在本项目的 lib/gson.jar 目录下。如果你不知道如何为你的项目引入 jar 包，请参考以下资料：

  • 如果你使用 IntelliJ Idea（推荐）：这里
  • 如果你使用 Eclipse： 这里

项目的 Java 版本是 13，不过没有这么严格，只要你的 Java 版本能够支持 Lambda 表达式特性（8 及以上）即可。

我推荐使用 IntelliJ Idea 作为你的集成开发编辑器，尤其是刚接触 Java 新手朋友们。这个项目就是用 Idea 做的。

如何使用

在 src/top/chorg/easyrpc/demo 目录下，有两个文件：ClientMain 和 ServerMain。 首先运行 ServerMain.main()，然后运行 ClientMain.main()，注意不要搞错了顺序。如果一切顺利的话，你会看到如下的输出：

// Server:
[RPC Server] Receiving new connection.
[RPC Thread 1423045330] Receiving RPC request '{"id":2,"funcName":"helloWorld","params":["1","\"233\""]}'
[RPC Thread 1423045330] Sending RPC return '{"id":2,"funcName":"helloWorld","returnValue":"\"ThisIsOutputOfHelloWorld(1, 233)\""}'
[RPC Thread 1423045330] Receiving RPC request '{"id":3,"funcName":"aloha","params":["\"芜湖\""]}'
[RPC Thread 1423045330] Sending RPC return '{"id":3,"funcName":"aloha","returnValue":"{\"strField\":\"ThisIsStrFieldOfReturn\",\"intField\":66666666}"}'
[RPC Thread 1423045330] Receiving RPC request '{"id":4,"funcName":"objTest","params":["{\"strField\":\"111\",\"intField\":233}"]}'
[RPC Thread 1423045330] Sending RPC return '{"id":4,"funcName":"objTest","returnValue":"\"Aloha! The information is(233, 111)\""}'
[RPC Thread 1423045330] Receiving RPC request '{"id":5,"funcName":"complicate","params":["[[{\"strField\":\"1.1\",\"intField\":0},{\"strField\":\"1.2\",\"intField\":0},{\"strField\":\"1.3\",\"intField\":0},{\"strField\":\"1.4\",\"intField\":0},{\"strField\":\"1.5\",\"intField\":0}],[{\"strField\":\"2.1\",\"intField\":0},{\"strField\":\"2.2\",\"intField\":0},{\"strField\":\"2.3\",\"intField\":0},{\"strField\":\"2.4\",\"intField\":0},{\"strField\":\"2.5\",\"intField\":0}]]"]}'
[RPC Thread 1423045330] Sending RPC return '{"id":5,"funcName":"complicate","returnValue":"[[\"1.1\",\"1.2\",\"1.3\",\"1.4\",\"1.5\"],[\"2.1\",\"2.2\",\"2.3\",\"2.4\",\"2.5\"]]"}'

// Client:
[RPC] Sending RPC request: '{"id":2,"funcName":"helloWorld","params":["1","\"233\""]}'
[RPC] Receiving content: '{"id":2,"funcName":"helloWorld","returnValue":"\"ThisIsOutputOfHelloWorld(1, 233)\""}'
ThisIsOutputOfHelloWorld(1, 233)
[RPC] Sending RPC request: '{"id":3,"funcName":"aloha","params":["\"芜湖\""]}'
[RPC] Receiving content: '{"id":3,"funcName":"aloha","returnValue":"{\"strField\":\"ThisIsStrFieldOfReturn\",\"intField\":66666666}"}'
Printing: TestObj{strField='ThisIsStrFieldOfReturn', intField=66666666}
[RPC] Sending RPC request: '{"id":4,"funcName":"objTest","params":["{\"strField\":\"111\",\"intField\":233}"]}'
[RPC] Receiving content: '{"id":4,"funcName":"objTest","returnValue":"\"Aloha! The information is(233, 111)\""}'
Aloha! The information is(233, 111)
[RPC] Sending RPC request: '{"id":5,"funcName":"complicate","params":["[[{\"strField\":\"1.1\",\"intField\":0},{\"strField\":\"1.2\",\"intField\":0},{\"strField\":\"1.3\",\"intField\":0},{\"strField\":\"1.4\",\"intField\":0},{\"strField\":\"1.5\",\"intField\":0}],[{\"strField\":\"2.1\",\"intField\":0},{\"strField\":\"2.2\",\"intField\":0},{\"strField\":\"2.3\",\"intField\":0},{\"strField\":\"2.4\",\"intField\":0},{\"strField\":\"2.5\",\"intField\":0}]]"]}'
[RPC] Receiving content: '{"id":5,"funcName":"complicate","returnValue":"[[\"1.1\",\"1.2\",\"1.3\",\"1.4\",\"1.5\"],[\"2.1\",\"2.2\",\"2.3\",\"2.4\",\"2.5\"]]"}'
1.1 | 1.2 | 1.3 | 1.4 | 1.5 | 
2.1 | 2.2 | 2.3 | 2.4 | 2.5 |

自定义

要为 RPC Server 添加新的函数，只需要打开 RPCServer.java 文件，找到 executeRpcCall(String name, String[] rawParams) 方法：

public class RPCServer {

    //...
    
    public Object executeRpcCall(String name, String[] rawParams) {
        switch (name)
        {
            case "helloWorld":
                return TestFunctions.helloWorld(
                        getParam(rawParams[0], int.class), getParam(rawParams[1], String.class));
            case "aloha":
                return TestFunctions.aloha(getParam(rawParams[0], String.class));
            case "objTest":
                return TestFunctions.objTest(getParam(rawParams[0], TestObj.class));
            case "complicate":
                return TestFunctions.complicate(
                        getParam(rawParams[0], new TypeToken<List<List<TestObj>>>(){}.getType())
                );
            default:
                System.out.printf("[RPC Server] No matching function name '%s'.\n", name);
        }
        return null;
    }

}

可以看到，这是一个 switch 分支结构，通过 name 参数来判断需要调用的方法。要扩展 RPC server 的功能，你可以添加更多 case 上去。

rawParams[] 数组保存了所有参数传输时的 JSON 字符串。要得到原始的对象，像例子里那样使用 getParam() 函数就好。

如果你的 RPC 函数中用到了泛型类（就像例子中的 complicate 函数一样），你可以使用 Gson 提供的 TypeToken 来获取其 Type 对象，并传入 getParam() 函数中，达到与传入 .class 相同的效果。

然后别忘了客户端：

TestObj obj = client.executeRpcCall("aloha", TestObj.class, "芜湖")

泛型类写法：

List<List<String>> result = client.executeRpcCall("complicate", new TypeToken<List<List<String>>>(){}.getType(), reqData);

在这个例子中，第二个参数填写了 TestObj.class，表明我的 RPC 函数返回值是 TestObject 类型的。这里填 .class 和 Type 都可以。

Q&As

Q: 为什么不推荐将这个工具用到真项目中？

A: 因为这项目没有经过严格的测试，也没有使用任何科学的设计模式。整个工具设计之初就不是为真实项目考虑的。

Q: RPCServer 中 public <T> T getParam(String rawParam, Class<T> classOfParam) 为什么对？

A: 我从 com.google.gson.Gson.fromJson() 里面学到的用法，可以仔细看看，这个其实与模板函数有关。

Q: 为什么没有用反射系统来注册函数？

A: 好问题。添加反射系统会导致整个项目复杂度大大提高，跟我先前的教育目的相悖。只要这个项目能告诉我的学生如何实现一个 RPC，就够了。

Q: 这个 RPC 框架能否实现双向通信呢？

A: 不行。这个系统只能实现基础的 RPC，也就是客户端调用，然后服务端处理。如果想让服务端调用客户端的方法（例如实现通知功能），那还是建议你自己用另一组 ServerSocket 和 Socket 实现。注意：千万不要在客户端上开 RPCServer ！服务端从来不应该主动连接客户端！