golang学习笔记27——golang 实现 RPC 模块

推荐学习文档
- golang应用级os框架，欢迎star
- golang应用级os框架使用案例，欢迎star
- 案例：基于golang开发的一款超有个性的旅游计划app经历
- golang实战大纲
- golang优秀开发常用开源库汇总
- 想学习更多golang知识，这里有免费的golang 学习笔记专栏

文章目录

- 引言
- Go 中 RPC 的基础知识
- - 1.RPC 服务端
  - 2.RPC 客户端
- 代码示例
- - 1.定义 RPC 服务
  - 2.实现 RPC 客户端
- 使用 JSON-RPC
- 总结

引言

RPC（Remote Procedure Call）远程过程调用，它允许不同的进程在网络上进行通信，就像调用本地函数一样。在 Go 语言中，实现 RPC 模块相对简洁且高效。本文将详细介绍在 Go 语言中如何实现 RPC 模块。

Go 中 RPC 的基础知识

Go 标准库中的net/rpc包提供了对 RPC 的基本支持。

1.RPC 服务端

在服务端，我们需要定义一个对象，该对象的方法可以被远程调用。这些方法必须满足特定的规则：它们必须是公开的方法（首字母大写），并且必须有两个参数，第一个参数是接收请求的结构体指针，第二个参数是用于返回结果的结构体指针。

2.RPC 客户端

客户端可以像调用本地方法一样调用远程服务端的方法，只需要通过rpc.Dial建立连接后调用Call方法即可。

代码示例

1.定义 RPC 服务

首先，我们定义一个简单的服务，用于执行数学运算。

golang">package main

import (
    "errors"
    "net/http"
    "net/rpc"
)

// Args 用于传递请求参数
type Args struct {
    A, B int
}

// MathService 数学运算服务
type MathService struct{}

// Add 加法运算
func (m *MathService) Add(args *Args, reply *int) error {
    if args == nil {
        return errors.New("invalid arguments")
    }
    *reply = args.A + args.B
    return nil
}

func main() {
    // 注册服务
    mathService := new(MathService)
    rpc.Register(mathService)

    // 开启 HTTP 服务
    rpc.HandleHTTP()
    err := http.ListenAndServe(":1234", nil)
    if err!= nil {
        panic(err)
    }
}

在上述代码中，我们定义了一个MathService结构体，其中Add方法用于执行加法运算。这个方法接收一个Args结构体指针作为参数，将运算结果通过reply指针返回。在main函数中，我们注册了这个服务，并开启了一个 HTTP 服务来处理 RPC 请求。

2.实现 RPC 客户端

golang">package main

import (
    "fmt"
    "log"
    "net/rpc"
)

func main() {
    // 连接到 RPC 服务端
    client, err := rpc.DialHTTP("tcp", "localhost:1234")
    if err!= nil {
        log.Fatal("dialing:", err)
    }

    // 准备请求参数
    args := Args{A: 3, B: 4}
    var reply int

    // 调用远程方法
    err = client.Call("MathService.Add", &args, &reply)
    if err!= nil {
        log.Fatal("arith error:", err)
    }

    // 输出结果
    fmt.Printf("The result of addition is: %d\n", reply)
}

在客户端代码中，我们首先通过rpc.DialHTTP连接到服务端。然后创建了一个Args结构体并设置了参数值。接着，我们调用client.Call方法来执行远程的Add方法，并将结果存储在reply变量中。

使用 JSON-RPC

除了使用 Go 标准的 RPC 编码，我们还可以使用 JSON-RPC。只需要将rpc.Register替换为rpc.RegisterName并指定编码为jsonrpc。

golang">package main

import (
    "errors"
    "log"
    "net/http"
    "net/rpc"
    "net/rpc/jsonrpc"
)

// Args 用于传递请求参数
type Args struct {
    A, B int
}

// MathService 数学运算服务
type MathService struct{}

// Add 加法运算
func (m *MathService) Add(args *Args, reply *int) error {
    if args == nil {
        return errors.New("invalid arguments")
    }
    *reply = args.A + args.B
    return nil
}

func main() {
    // 注册服务
    mathService := new(MathService)
    rpc.RegisterName("MathService", mathService)

    // 开启 HTTP 服务
    http.HandleFunc("/rpc", func(w http.ResponseWriter, r *http.Request) {
        jsonrpc.ServeRequest(rpc.DefaultServer, w, r)
    })

    // 启动服务
    log.Fatal(http.ListenAndServe(":1234", nil))
}

客户端的调用方式需要稍作修改：

golang">package main

import (
    "fmt"
    "log"
    "net/rpc/jsonrpc"
)

func main() {
    // 连接到 RPC 服务端
    client, err := jsonrpc.Dial("tcp", "localhost:1234")
    if err!= nil {
        log.Fatal("dialing:", err)
    }

    // 准备请求参数
    args := Args{A: 3, B: 4}
    var reply int

    // 调用远程方法
    err = client.Call("MathService.Add", &args, &reply)
    if err!= nil {
        log.Fatal("arith error:", err)
    }

    // 输出结果
    fmt.Printf("The result of addition is: %d\n", reply)
}