go grpc 使用简明教程

1 protobuf 定义接口

1. 官网下载 protoc (本机为 Mac M1)

https://github.com/protocolbuffers/protobuf/releases

image-20220529155807106.png

2. 解压并添加至 PATH

image-20220529142245518.png

3. 验证是否正确安装 protoc

protoc --version

4. 编写接口文档

• manager.proto

// 指定 proto 的版本信息
syntax = "proto3";

// 指定生成的 go 文件存放位置及其包名
option go_package = "./;pb";

// 指定所在包的包名
package pb;

// 定义商品的管理员消息体
message Manager {
  int64 user_id = 1;
  string user_name = 2;
}

• ad.proto

// 指定 proto 的版本信息
syntax = "proto3";

// 指定生成的 go 文件存放位置及其包名
option go_package = "./;pb";

// 指定所在包的包名
package pb;

// 导入包，注意：这么指定的导入方式，需要 protoc 命令在文件所在目录中执行编译操作
import "manager.proto";

// 定义商品类型的枚举消息体
enum BrandType {
  General = 0;
  Standard = 1;
}

// 定义请求消息体
message GetBrandInfoReq {
  int64 brand_id = 1;
}

// 定义响应消息体
message GetBrandInfoRsp {
  int64 brand_id = 1;
  string brand_name = 2;
  repeated int64 brand_adv_list = 3;
  Manager manager = 4;
  BrandType brand_type = 5;
}

// 定义 rpc 服务
service AdService {
  // 获取商品信息接口
  rpc GetBrandInfo(GetBrandInfoReq) returns (GetBrandInfoRsp);
}

5. 下载依赖

# (旧版本的方式)
go get -u github.com/golang/protobuf/protoc-gen-go@v1.3.2
go get google.golang.org/grpc

# (新版本的方式)
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

6. 编译(下文以旧版本的方式为例)

# (旧版本的方式)
# plugins=grpc rpc服务需要的插件
protoc --go_out=plugins=grpc:./ *.proto

# (新版本的方式)注意：由于需要覆盖接口中的方法：mustEmbedUnimplementedAdServiceServer ，而该方法是私有方法，所以实现的service需要和该生成的go文件放在相同包下才可以使用
protoc --go_out=./ --go-grpc_out=./ *.proto

2 编写非安全的 rpc 服务

1. go.mod

module go_mod_testdemo

go 1.16

require (
    github.com/golang/protobuf v1.5.2
    google.golang.org/grpc v1.46.2
)

2. server.go

package main

import (
    "context"
    "fmt"
    "go_mod_testdemo/pb"
    "google.golang.org/grpc"
    "net"
)

type AdService struct {
}

func (this *AdService) GetBrandInfo(ctx context.Context, req *pb.GetBrandInfoReq) (*pb.GetBrandInfoRsp, error) {
    if req.BrandId == 10 {
        return &pb.GetBrandInfoRsp{BrandId: 10, BrandName: "ad"}, nil
    }
    return &pb.GetBrandInfoRsp{BrandId: req.BrandId, BrandName: "other"}, nil
}

func main() {
    // 1 初始化 grpc 对象
    grpcServer := grpc.NewServer()
    // 2 注册服务
    pb.RegisterAdServiceServer(grpcServer, new(AdService))
    // 3 创建监听
    listener, err := net.Listen("tcp", "127.0.0.1:8080")
    if err != nil {
        fmt.Println("net Listen err: ", err)
        return
    }
    defer listener.Close()
    // 4 绑定服务
    grpcServer.Serve(listener)
}

3. client.go

package main

import (
    "context"
    "fmt"
    "go_mod_testdemo/pb"
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
)

func main() {
    // 1 创建客户端连接
    conn, err := grpc.Dial("127.0.0.1:8080", grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {
        fmt.Println("grpc Dial err: ", err)
        return
    }
    defer conn.Close()
    // 2 创建远程服务的客户端
    grpcClient := pb.NewAdServiceClient(conn)

    req := pb.GetBrandInfoReq{BrandId: 9}
    // 3 发送 rpc 请求
    res, err := grpcClient.GetBrandInfo(context.Background(), &req)
    if err != nil {
        fmt.Println("grpcClient GetBrandInfo err: ", err)
        return
    }
    fmt.Println(res)
}

# result
brand_id:9 brand_name:"other"

4. 文件结构

image-20220529161936163.png

3 编写安全的 rpc 服务

3.1 生成证书信息

# 1 CA 证书制作
# 生成.key  私钥文件
openssl genrsa -out ca.key 2048
# 生成.csr 证书签名请求文件
openssl req -new -key ca.key -out ca.csr
# 自签名生成.crt 证书文件
openssl req -new -x509 -days 3650 -key ca.key -out ca.crt

# 2 服务端证书制作
# 找到你的 openssl 位置
sudo find / -name "openssl.cnf"
# 拷贝出来
sudo cp /System/Library/OpenSSL/openssl.cnf .
# 修改权限 将 root 改为当前用户
chown yorick:staff openssl.cnf
# 生成.key  私钥文件
openssl genrsa -out server.key 2048
# 生成.csr 证书签名请求文件 
openssl req -new -key server.key -out server.csr
# 签名生成.crt 证书文件 注意：只允许规定的域名访问
openssl x509 -req -days 3650 \
   -in server.csr -out server.crt \
   -CA ca.crt -CAkey ca.key -CAcreateserial \
   -extensions SAN \
   -extfile <(cat ./openssl@1.1/openssl.cnf <(printf "\n[SAN]\nsubjectAltName=DNS:*.yorick.com"))

image-20220529165912893.png

3.2 单向认证

1. server.go

package main

import (
    "context"
    "fmt"
    "go_mod_testdemo/pb"
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials"
    "net"
)

type AdService struct {
}

func (this *AdService) GetBrandInfo(ctx context.Context, req *pb.GetBrandInfoReq) (*pb.GetBrandInfoRsp, error) {
    if req.BrandId == 10 {
        return &pb.GetBrandInfoRsp{BrandId: 10, BrandName: "ad"}, nil
    }
    return &pb.GetBrandInfoRsp{BrandId: req.BrandId, BrandName: "other"}, nil
}

func main() {
    // 0 读取 server 的证书
    creds, err := credentials.NewServerTLSFromFile("cert/server.crt", "cert/server.key")
    if err != nil {
        fmt.Println("credentials NewServerTLSFromFile err: ", err)
        return
    }
    // 1 初始化 grpc 对象
    grpcServer := grpc.NewServer(grpc.Creds(creds))
    // 2 注册服务
    pb.RegisterAdServiceServer(grpcServer, new(AdService))
    // 3 创建监听
    listener, err := net.Listen("tcp", "127.0.0.1:8080")
    if err != nil {
        fmt.Println("net Listen err: ", err)
        return
    }
    defer listener.Close()
    // 4 绑定服务
    grpcServer.Serve(listener)
}

2. client.go

package main

import (
    "context"
    "fmt"
    "go_mod_testdemo/pb"
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials"
)

func main() {
    // 读取 ca 的证书
    creds, err := credentials.NewClientTLSFromFile("cert/ca.crt", "www.yorick.com")
    if err != nil {
        fmt.Println("credentials NewServerTLSFromFile err: ", err)
        return
    }
    // 1 创建客户端连接
    conn, err := grpc.Dial("127.0.0.1:8080", grpc.WithTransportCredentials(creds))
    if err != nil {
        fmt.Println("grpc Dial err: ", err)
        return
    }
    defer conn.Close()
    // 2 创建远程服务的客户端
    grpcClient := pb.NewAdServiceClient(conn)

    req := pb.GetBrandInfoReq{BrandId: 9}
    // 3 发送 rpc 请求
    res, err := grpcClient.GetBrandInfo(context.Background(), &req)
    if err != nil {
        fmt.Println("grpcClient GetBrandInfo err: ", err)
        return
    }
    fmt.Println(res)
}