Skip to content

Latest commit

 

History

History
187 lines (137 loc) · 5.4 KB

rpc.md

File metadata and controls

187 lines (137 loc) · 5.4 KB
Raw

RPC

RPC（Remote Procedure Call）是跨网络的通讯方式，允许程序在远程服务器上执行另一程序或方法。

  1. 透明性：对于调用者来说，远程过程调用看起来就像是本地过程调用，隐藏了底层的通信细节。
  2. 通信：RPC 需要请求和响应。当客户端发起请求时，它会将参数打包并发送到服务器。服务器解包参数，执行请求的过程，然后将结果打包并返回给客户端。
  3. 数据序列化：为了在网络上发送数据，RPC 使用了数据序列化和反序列化技术。这意味着它会将数据结构或对象转换为可传输的格式，如 JSON 或 XML。
  4. 多种语言支持：许多 RPC 系统允许不同的客户端和服务器使用不同的编程语言。例如，一个用 Python 编写的客户端可能调用一个用 Java 编写的远程服务。
  5. 同步和异步：RPC 可以是同步的，也可以是异步的。在同步RPC中，客户端发送请求并等待响应。在异步RPC中，客户端可以在没有等待响应的情况下继续执行其他任务。
  6. 应用案例：RPC 常用于分布式系统、云计算、微服务架构等领域。

以下示例使用的是 JSON-RPC，它是一种轻量级的 RPC 协议，使用 JSON 作为数据格式。

定义一个 RPC 客户端

package main

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

const HelloServiceName = "HelloService"

type HelloServiceClient struct {
        *rpc.Client
}

func DialHelloService(network, address string) (*HelloServiceClient, error) {
        client, err := rpc.Dial(network, address)
        if err != nil {
                return nil, err
        }
        return &HelloServiceClient{Client: client}, nil
}

func (p *HelloServiceClient) Hello(request string, reply *string) error {
        return p.Client.Call(HelloServiceName+".Hello", request, reply)
}

在 main 函数中调用 RPC 服务：

func main() {
        conn, err := net.Dial("tcp", "localhost:1234")
        if err != nil {
                log.Fatal("dialing:", err)
        }
       
        client := rpc.NewClientWithCodec(jsonrpc.NewClientCodec(conn))
        var reply string
        client.Call("HelloService.Hello", "World", &reply)
       
        if err != nil {
                log.Fatal(err)
        }
        log.Println(reply)
}

首先启动一个 TCP 服务器，并监听 1234 端口：

nc -l 1234
# {"method":"HelloService.Hello","params":["hello"],"id":0}

定义一个 RPC 服务端

package main

import (
        "io"
        "net/http"
        "net/rpc"
        "net/rpc/jsonrpc"
)

type HelloService struct{}

type HelloServiceInterface interface {
        Hello(request string, reply *string) error
}

func RegisterHelloService(svc HelloServiceInterface) error {
        return rpc.RegisterName("HelloService", svc)
}

func (p *HelloService) Hello(request string, reply *string) error {
        *reply = "hello:" + request
        return nil
}

在 main 函数中调用 RPC 服务：

func main() {
        RegisterHelloService(new(HelloService))

        listener, err := net.Listen("tcp", ":1234")
        if err != nil {
                log.Fatal("ListenTCP error:", err)
        }

        for {
                conn, err := listener.Accept()
                if err != nil {
                        log.Fatal("Accept error:", err)
                }

                go rpc.ServeCodec(jsonrpc.NewServerCodec(conn))
        }
}

启动一个 TCP 客户端，并连接到 1234 端口：

echo -e '{"method":"HelloService.Hello","params":["hello"],"id":1}' | nc localhost 1234
# {"id":1,"result":"hello:World","error":null}

grpc

grpc 是 Google 开源的一款 rpc 库，它使用 protobuf 作为接口定义语言，可以用于多种语言，包括 C、C++、Java、Go、Python、Ruby、Node.js、Android Java、Objective-C、PHP、C# 等。

  1. 在 Mac 上下载 protobuf 编译器

    brew install protobuf
protoc

  2. 安装 Go 语言的 protobuf 编译器插件，参考 golang/protobuf

    go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]

  3. 为本项目安装 go 的 protobuf 库，并且 GitHub 中的 golang 版本已经停止更新

    go get -u google.golang.org/protobuf

  4. 生成 go 代码

    protoc --proto_path src/ --go_out=src/ src/first/person.proto

注意事项：在编写 proto 文件时，需要注意 option go_package 指定的包名。The import path must contain at least one period ('.') or forward slash ('/') character.

option go_package = "example.first";

如果没有在暴露 go bin 的 PATH，需要指定

echo 'export PATH="$PATH:$(go env GOPATH)/bin"' >> ~/.zshrc

生成服务端和客户端的代码

protoc --proto_path ./protos ./protos/*.proto \
      --go_out=./pb \
      --go-grpc_out=./pb

此时，在 pb 目录下会生成 *.pb.go 以及 *_grpc.pb.go 文件，第一个文件是 Protocol Buffers 的消息定义，第二个是 gRPC 的客户端和服务端代码。

生成证书文件

openssl req -x509 -newkey rsa:4096 -nodes -sha256 -config openssl.cnf -keyout private.pem -out cert.pem

参考：https://chai2010.cn/advanced-go-programming-book/ch4-rpc/ch4-01-rpc-intro.html