在分布式系統開發中，不同編程語言之間進行通信是一個常見的需求。通過遠程過程調用（RPC）技術，我們可以讓不同的程序像調用本地方法一樣調用遠程的服務。本文將介紹如何使用Go語言編寫一個簡單的JSON-RPC服務，并使用Java作為客戶端來跨語言調用這個服務。

一、背景介紹

在之前的文章中，我們已經了解了如何使用Go語言構建一個基本的RPC服務。然而，默認情況下，Go語言的net/rpc包使用的是一種名為Gob的序列化格式，這限制了它只能與支持Gob編碼的語言進行交互。為了實現跨語言的RPC調用，我們可以采用更通用的數據交換格式——如JSON。Go語言的net/rpc/jsonrpc包就提供了這樣的功能，允許我們在不修改服務邏輯的情況下，輕松地與其他語言進行交互。

二、Go服務端實現

首先，我們需要創建一個Go服務端，該服務端將提供一個簡單的“Hello”服務。以下是完整的代碼示例：

package mainimport ("fmt""net""net/rpc""net/rpc/jsonrpc"
)// 定義一個服務結構體
type HelloService struct{}// 定義一個遠程可調用的方法
func (s *HelloService) Hello(request string, reply *string) error {fmt.Printf("Received request: %s\n", request)*reply = "hello " + requestreturn nil
}func main() {// 監聽本地 1234 端口listen, err := net.Listen("tcp", ":1234")if err != nil {panic(err)}defer listen.Close()// 注冊服務err = rpc.RegisterName("HelloService", new(HelloService))if err != nil {panic(err)}// 接受連接并處理for {conn, err := listen.Accept()if err != nil {continue}go jsonrpc.ServeConn(conn)}
}

關鍵點解釋：

• 服務定義：我們定義了一個HelloService結構體，并為其添加了一個Hello方法。這個方法接收一個字符串參數，并返回一個經過處理后的字符串。
• 注冊服務：使用rpc.RegisterName函數將服務注冊到RPC框架中，這里我們指定了服務名稱為"HelloService"。
• 啟動服務：監聽指定端口并接受連接，然后使用jsonrpc.ServeConn來處理每一個新的連接。

代碼解析

代碼片段	作用說明
type HelloService	自定義的服務結構體，用于封裝遠程方法
func (s *HelloService) Hello(...)	這是一個“導出方法”，可以被外部調用
net.Listen("tcp", ":1234")	創建 TCP 監聽器，監聽本地 1234 端口
rpc.RegisterName("HelloService", ...)	將服務注冊為 RPC 框架的一部分，服務名是?"HelloService"
jsonrpc.ServeConn(conn)	使用 JSON-RPC 協議處理每個連接，自動解析請求、調用方法并返回結果

? 總結：Go 服務端本質上是一個 TCP 服務器，使用 JSON-RPC 協議與客戶端通信。客戶端發送 JSON 請求，服務端執行對應方法后，返回 JSON 響應。

三、Java客戶端實現

接下來，我們將編寫一個Java客戶端來調用上述Go服務端提供的“Hello”服務。以下是完整的Java代碼示例：

import org.json.JSONObject;import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;public class GoJsonRpcClient {
import org.json.JSONObject;import java.io.*;
import java.net.Socket;public class GoJsonRpcClient {public static void main(String[] args) throws IOException {String hostname = "127.0.0.1"; // Go服務端IP地址int port = 1234; // Go服務端監聽端口try (Socket socket = new Socket(hostname, port)) {OutputStream output = socket.getOutputStream();PrintWriter writer = new PrintWriter(output, true);InputStream input = socket.getInputStream();BufferedReader reader = new BufferedReader(new InputStreamReader(input));JSONObject jsonRequest = new JSONObject();jsonRequest.put("jsonrpc", "2.0");jsonRequest.put("method", "HelloService.Hello");jsonRequest.put("params", new String[]{"Bob"});jsonRequest.put("id", 1);writer.println(jsonRequest.toString());String jsonResponse = reader.readLine();if (jsonResponse != null && !jsonResponse.isEmpty()) {JSONObject jsonObject = new JSONObject(jsonResponse);System.out.println("Received response: " + jsonObject.toString());if (jsonObject.has("result")) {System.out.println("Result: " + jsonObject.getString("result"));}} else {System.out.println("No response or empty response.");}} catch (IOException e) {throw new RuntimeException(e);}}
}public static void main(String[] args) {String hostname = "127.0.0.1"; // Go服務端IP地址int port = 1234; // Go服務端監聽端口try (Socket socket = new Socket(hostname, port)) {PrintWriter writer = new PrintWriter(socket.getOutputStream(), true);BufferedReader reader = new BufferedReader(new InputStreamReader(socket.getInputStream()));JSONObject jsonRequest = new JSONObject();jsonRequest.put("jsonrpc", "2.0");jsonRequest.put("method", "HelloService.Hello");jsonRequest.put("params", new String[]{"Bob"}); // 請求參數jsonRequest.put("id", 1); // 請求IDwriter.println(jsonRequest.toString());String jsonResponse = reader.readLine();if (jsonResponse != null && !jsonResponse.isEmpty()) {JSONObject jsonObject = new JSONObject(jsonResponse);System.out.println("Received response: " + jsonObject.toString());if (jsonObject.has("result")) {System.out.println("Result: " + jsonObject.getString("result"));}} else {System.out.println("No response or empty response.");}} catch (Exception e) {throw new RuntimeException(e);}}
}

關鍵點解釋：

• 請求構建：我們使用org.json.JSONObject來構造符合JSON-RPC規范的請求對象。在這個例子中，我們的請求包含了一個方法名（對應于Go服務端的Hello方法）、一組參數以及一個唯一的請求ID。
• 發送請求：通過套接字連接向Go服務端發送構造好的請求。
• 接收響應：從輸入流中讀取服務端返回的響應，并解析其中的結果字段。

代碼解析

代碼片段	作用說明
Socket socket = new Socket(hostname, port)	創建一個 TCP 連接到 Go 服務端
PrintWriter writer = new PrintWriter(output, true)	獲取輸出流，用于向服務端發送請求
BufferedReader reader = new BufferedReader(...)	獲取輸入流，用于接收服務端響應
JSONObject jsonRequest = new JSONObject()	構造 JSON 請求對象
jsonRequest.put("method", "HelloService.Hello")	設置要調用的服務方法
jsonRequest.put("params", new String[]{"Bob"})	設置參數列表
writer.println(jsonRequest.toString())	發送請求
String jsonResponse = reader.readLine()	讀取服務端返回的 JSON 響應
jsonObject.getString("result")	提取返回值中的?result?字段

? 總結：Java 客戶端通過 Socket 建立 TCP 連接，構造符合 JSON-RPC 規范的請求，發送給 Go 服務端，并等待響應。

四、測試與驗證

確保Go服務端正在運行后，執行Java客戶端程序。如果一切配置正確，你應該能夠看到類似以下的輸出結果：

Received response: {"jsonrpc":"2.0","result":"hello Bob","id":1}
Result: hello Bob

這表明Java客戶端成功地調用了Go服務端的“Hello”方法，并收到了預期的響應。

五、總結

JSON-RPC 的核心思想

角色	功能
服務端（Go）	監聽 TCP 端口，接收 JSON-RPC 請求，調用本地方法，返回 JSON-RPC 響應
客戶端（Java）	建立 TCP 連接，構造 JSON-RPC 請求，發送并讀取響應
關鍵點	使用 JSON 作為數據格式，TCP 作為傳輸層，實現跨語言通信

通過這篇文章，我們學習了如何使用Go語言構建一個JSON-RPC服務端，并使用Java作為客戶端進行跨語言調用。這種方法不僅打破了語言之間的界限，還利用了JSON這種輕量級的數據交換格式，使得不同平臺和語言之間的集成變得更加簡單高效。

關于使用JSON-RPC替換RPC原本的序列化協議Gob的目的和優點可以看上一篇內容。

希望這篇博客能幫助你在實際項目中更好地應用RPC技術。