一、环境
确保环境已经配置完成,效果如下。不同环境可能导致后续生成的效果不一。
go version
protoc --version
protoc-gen-go --version
二、编写protobuf文件
新建go_grpc_study
目录项目,新建hello.proto
文件
目录结构如下
编写hello.proto
文件,内容如下:
// 指定proto版本
syntax = "proto3";
// 指定默认包名
package hello_grpc;
// 指定golang包名
option go_package = "/hello_grpc";
//定义rpc服务
service HelloService {
// 定义函数
rpc SayHello (HelloRequest) returns (HelloResponse) {}
}
// HelloRequest 请求内容
message HelloRequest {
string name = 1;
string message = 2;
}
// HelloResponse 响应内容
message HelloResponse{
string name = 1;
string message = 2;
}
在go_grpc_study/grpc_proto
目录下新建Terminal,执行生成文件,命令如下
protoc --go_out=. --go-grpc_out=. hello.proto
目录结构变更后为
三、编写server服务端
新建server
目录,新建main.go
文件
目录结构如下
编写server/main.go
文件
package main
import (
"context"
"fmt"
"go_grpc_study/grpc_proto/hello_grpc"
"google.golang.org/grpc"
"google.golang.org/grpc/grpclog"
"net"
)
// 得有一个结构体,需要实现这个服务的全部方法,叫什么名字不重要
// 新版本 gRPC 要求必须嵌入 UnimplementedGreeterServer 结构体
type HelloServer struct {
hello_grpc.UnimplementedHelloServiceServer
}
func (HelloServer) SayHello(ctx context.Context, request *hello_grpc.HelloRequest) (pd *hello_grpc.HelloResponse, err error) {
fmt.Println("入参:", request.Name, request.Message)
pd = new(hello_grpc.HelloResponse)
pd.Name = "你好"
pd.Message = "ok"
return
}
func main() {
// 监听端口
listen, err := net.Listen("tcp", ":8080")
if err != nil {
grpclog.Fatalf("Failed to listen: %v", err)
}
// 创建一个gRPC服务器实例。
s := grpc.NewServer()
// 将server结构体注册为gRPC服务。
hello_grpc.RegisterHelloServiceServer(s, &HelloServer{})
fmt.Println("grpc server running :8080")
// 开始处理客户端请求。
err = s.Serve(listen)
}
具体步骤如下:
- 1)定义一个结构体,必须包含pb.UnimplementedGreeterServer 对象
- 2)实现 .proto文件中定义的API
- 3)将服务描述及其具体实现注册到 gRPC 中
四、编写Client客户端
新建client
目录,新建main.go
文件
目录结构如下
编写clinet/main.go
文件
package main
import (
"context"
"fmt"
"go_grpc_study/grpc_proto/hello_grpc"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"log"
)
func main() {
addr := ":8080"
// 使用 grpc.Dial 创建一个到指定地址的 gRPC 连接。
// 此处使用不安全的证书来实现 SSL/TLS 连接
conn, err := grpc.Dial(addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
log.Fatalf(fmt.Sprintf("grpc connect addr [%s] 连接失败 %s", addr, err))
}
defer conn.Close()
// 初始化客户端
client := hello_grpc.NewHelloServiceClient(conn)
result, err := client.SayHello(context.Background(), &hello_grpc.HelloRequest{
Name: "Donkor",
Message: "hello",
})
fmt.Println(result, err)
}
具体步骤如下:
- 1)首先使用 grpc.Dial() 与 gRPC 服务器建立连接
- 2)使用 hello_grpc.NewHelloServiceClient(conn)初始化客户端
- 3)通过客户端调用ServiceAPI方法client.SayHello
五、测试
在server
目录下,启动服务端
go run main.go
在clinet
目录下,启动客户端
go run main.go
服务端运行结果
客户端运行结果
六、示例代码
完成ヾ(◍°∇°◍)ノ゙