1.go下载trpc
go install trpc.group/trpc-go/trpc-cmdline/trpc@latest
有报错的话尝试配置一些代理(选一个)
go env -w GOPROXY=https://goproxy.cn,direct
go env -w GOPROXY=https://goproxy.io,direct
go env -w GOPROXY=https://goproxy.baidu.com/
go env -w GOPROXY=https://mirrors.aliyun.com/goproxy/
cmd运行
trpc version
#打印版本号就是成功了
trpc-group/trpc-cmdline version: v1.0.5
2.下载protoc
下载地址:Release Protocol Buffers v25.3 · protocolbuffers/protobuf · GitHub
把protoc加入环境变量
不会加环境变量的自己百度。我都懒得写
cmd查看版本:
protoc --version
3.编写一个proto文件
syntax = "proto3"; /
option go_package="./;baomin1";
package baomin;
service Helloserver {
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
}
然后执行
trpc create -p trpcDemo.proto -o out
// -o 指定文件存放目录,proto文件中,option go_package="./;baomin1"; 已经指定了文件的存放目录,如果使用-o 指定为out,会覆盖./目录。out目录会自动创建
生成out文件,内容如下:
3.1 proto文件解释
syntax 用于制定protoc的版本,proto2或proto3,新版本proto3中必填。
option go_package = "path;name";
path 表示生成的go文件的存放地址,会自动生成目录的。
name 表示生成的go文件所属的包名。
package baomin; 指定文件包名,优先级会高于上面的name,所以报名会是baomin,不是baomin1。message: protobuf中定义一个消息类型式是通过关键字 message字段指定的。消息就是需要传输的数据格式的定义message关键字 类似于C++中的class,JAVA中的class,go中的struct。
字段规则
required: 消息体中必填字段,不设置会导致编码异常。
在protobuf2中使用,在protobuf3中被删去
optional : 消息体中可选字段。protobuf3没有了required,
optional等说明关键字,都默认为optional
repeate: 消息体中可重复字段,重复的值的顺序会被保留在go中
重复的会被定义为切片。
消息号 :在消息体的定义中,每个字段都必须要有一个唯一的标识号,
标识号是[1,2^29-1] 范国内的一个整数
必须是正整数(1 到 2^29-1)。
标签不能重复出现在同一个消息中。
标签的顺序可以是任意的。不需要连续,可以跳过一些数值。
嵌套消息 :可以在其他消息类型中定义、使用消息类型,
在下面的例子中,person消息就定义在Personlnfo消息内如
message PersonInfo{ message Person{ string name = 1; int32 height =2; repeated int32 weight = 3; } repeated Person info = 1; }
如果要在它的父消息类型的外部重用这个消息类型,需要Personlnfo.Person的形式使用它,如:
message PersonMessage{ PersonInfo.Person info = 1; }
服务定义:
service $earchService{ # rpc 服务函数名 (参》返回(返回参) rpc Search(SearchRequest) returns (SearchResponse) }
上面的proto文件是主要是给你解释用的,一般不建议代码存放用./当前位子,容易出错
改成下面
syntax = "proto3";
option go_package="tengxun/trpc/code";
package baomin;
service Helloserver {
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
}
删除生成的out文件
再次执行
trpc create -p trpcDemo.proto -o out
# 注意:本文档后续的操作只依赖上面生成完整工程的命令,
# 以下两种操作仅为使用说明,用户不必实际执行以完成后面的操作
# 只生成 rpcstub,常用于已经创建工程以后更新协议字段时,重新生成桩代码
trpc create -p helloworld.proto --rpconly
# 使用 http 协议
trpc create -p helloworld.proto --protocol=http
服务端代码修改一下
out/main.go
package main
import (
"context"
"fmt"
pb "tengxun/trpc/code"
_ "trpc.group/trpc-go/trpc-filter/debuglog"
_ "trpc.group/trpc-go/trpc-filter/recovery"
trpc "trpc.group/trpc-go/trpc-go"
"trpc.group/trpc-go/trpc-go/log"
)
type helloserver struct {
pb.UnimplementedHelloserver
}
func (s *helloserver) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloReply, error) {
fmt.Println("hello " + req.Name)
return &pb.HelloReply{Message: "SayHello::::::::::: " + req.Name}, nil
}
func main() {
s := trpc.NewServer()
pb.RegisterHelloserverService(s.Service("baomin.Helloserver"), &helloserver{})
if err := s.Serve(); err != nil {
log.Fatal(err)
}
}
cd out
运行服务端 go run main.go
运行客户端 go run cmd/client/main.go
客户端截图
服务端截图
4.tRPC-Go接口测试
注: trpc
和 trpc-cli
是两个不同的工具,前者主要用于生成 proto 对应的 stub 代码,后者主要用于作为 client 发送请求
下载
有 golang 环境:
go get git.code.oa.com/trpc-go/trpc-cli # 默认会安装到 ~/go/bin 下面
没有 golang 环境(推荐,发布到 mirrors 是经测试的最新稳定版本,go get 默认是 master 版本):
# Linux 版本
wget https://mirrors.tencent.com/repository/generic/trpc-go/trpc-cli/trpc-cli.zip
unzip trpc-cli.zip
./trpc-cli -h
# Mac版本
wget https://mirrors.tencent.com/repository/generic/trpc-go/trpc-cli/trpc-cli_mac.zip
# Windows版本
wget https://mirrors.tencent.com/repository/generic/trpc-go/trpc-cli/trpc-cli_win.zip
-
通过 tRPC-Go 提供的客户端发包工具
trpc-cli
命令行进行自测 -
简单发包拨测
./trpc-cli -func=/trpc.test.helloworld.Greeter/SayHi -body='{"msg":"trpc-cli"}' -v