Skip to content

Latest commit

 

History

History
221 lines (167 loc) · 7.61 KB

README.zh_CN.md

File metadata and controls

221 lines (167 loc) · 7.61 KB

English | 中文

trpc-cmdline

Go Reference Go Report Card LICENSE Releases Tests Coverage

trpc-cmdline 是 trpc-cpp 和 trpc-go 的命令行工具。

本项目支持 Go 最新发布的三个版本。

安装

安装 trpc-cmdline

使用 go 命令进行安装

首先将以下内容添加到你的 ~/.gitconfig 中:

[url "ssh://[email protected]/"]
    insteadOf = https://github.com/

然后执行以下命令以安装 trpc-cmdline:

go install trpc.group/trpc-go/trpc-cmdline/trpc@latest

如果在大陆报错 EOF，需配置代理，具体步骤请查看: https://goproxy.cn/

安装依赖

通过以下两种方式之一可以安装所有的依赖。

使用 trpc setup 一键安装所有依赖

只需要运行 trpc setup 便可安装所有依赖。假如有些依赖安装不成功，可以参考下一节进行手动安装。

手动安装各种依赖

Install protoc 
$ # Reference: https://grpc.io/docs/protoc-installation/
$ PB_REL="https://github.com/protocolbuffers/protobuf/releases"
$ curl -LO $PB_REL/download/v3.15.8/protoc-3.15.8-linux-x86_64.zip
$ unzip -o protoc-3.15.8-linux-x86_64.zip -d $HOME/.local
$ export PATH=~/.local/bin:$PATH # Add this to your `~/.bashrc`.
$ protoc --version
libprotoc 3.15.8
Install flatc 
$ # Reference: https://github.com/google/flatbuffers/releases
$ wget https://github.com/google/flatbuffers/releases/download/v23.5.26/Linux.flatc.binary.g++-10.zip
$ unzip -o Linux.flatc.binary.g++-10.zip -d $HOME/.bin
$ export PATH=~/.bin:$PATH # Add this to your `~/.bashrc`.
$ flatc --version
flatc version 23.5.26
Install protoc-gen-go
$ # Reference: https://grpc.io/docs/languages/go/quickstart/
$ go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
Install goimports
$ go install golang.org/x/tools/cmd/goimports@latest
Install mockgen
$ # Reference: https://github.com/uber-go/mock
$ go install go.uber.org/mock/mockgen@latest
Install protoc-gen-validate and protoc-gen-validate-go
$ # Please download the binaries in https://github.com/bufbuild/protoc-gen-validate/releases
$ # Or:
$ go install github.com/envoyproxy/protoc-gen-validate@latest
$ go install github.com/envoyproxy/protoc-gen-validate/cmd/protoc-gen-validate-go@latest

快速上手

生成完整项目

syntax = "proto3";
package helloworld;

option go_package = "github.com/some-repo/examples/helloworld";

// HelloRequest is hello request.
message HelloRequest {
  string msg = 1;
}

// HelloResponse is hello response.
message HelloResponse {
  string msg = 1;
}

// HelloWorldService handles hello request and echo message.
service HelloWorldService {
  // Hello says hello.
  rpc Hello(HelloRequest) returns(HelloResponse);
}
  • 使用 trpc-cmdline 来生成完整项目:
$ trpc create -p helloworld.proto -o out

注意: -p 用于指定 proto 文件, -o 用于指定输出目录, 更多 flag 信息可以运行 trpc -h 以及 trpc create -h 来进行查看。

  • 进入输出目录，运行服务端:
$ cd out
$ go run .
...
... trpc service:helloworld.HelloWorldService launch success, tcp:127.0.0.1:8000, serving ...
...
  • 在另一个终端中进入输出目录，运行客户端:
$ go run cmd/client/main.go 
... simple  rpc   receive:

注意: 由于生成的代码默认都是空操作，因此日志中显示的收到的数据内容也为空。

$ tree
.
|-- cmd
|   `-- client
|       `-- main.go  # Generated client code.
|-- go.mod
|-- go.sum
|-- hello_world_service.go  # Generated server service implementation.
|-- hello_world_service_test.go
|-- main.go  # Server entrypoint.
|-- stub  # Stub code.
|   `-- github.com
|       `-- some-repo
|           `-- examples
|               `-- helloworld
|                   |-- go.mod
|                   |-- helloworld.pb.go
|                   |-- helloworld.proto
|                   |-- helloworld.trpc.go
|                   `-- helloworld_mock.go
`-- trpc_go.yaml  # Configuration file for trpc-go.

仅生成桩代码

  • 只需要添加 --rpconly 选项就可以只生成桩代码:
$ trpc create -p helloworld.proto -o out --rpconly
$ tree out
out
|-- go.mod
|-- go.sum
|-- helloworld.pb.go
|-- helloworld.trpc.go
`-- helloworld_mock.go

常用的指令

下面列举了一些常用的命令行选项：

  • -f: 用于强制覆盖输出目录中的内容
  • -d some-dir: 添加 proto 文件的查找路径（包括依赖的 proto 文件），可以指定多次
  • --mock=false: 禁止生成 mock 代码
  • --nogomod=true: 在生成桩代码时不生成 go.mod 文件，只在 --rpconly=true 的时候生效, 默认为 false
  • -l cpp：生成 cpp 桩代码
  • --validate=true: 开启数据校验，详细用法见 /docs/examples/example-2/README.zh_CN.md

注意： alias/gotag/validate/swagger 这些 option 使用时的 proto import 路径通常有所不同：

  • trpc.alias: import "trpc/proto/trpc_options.proto";
  • trpc.go_tag: import "trpc/proto/trpc_options.proto";
  • validate.rules: import "validate/validate.proto";
  • trpc.swagger: import "trpc/swagger/swagger.proto";

详细用法请参考 /docs/examples/example-2/README.zh_CN.md

更多命令行选项可以执行 trpc -h 以及 trpc [subcmd] -h 来进行查看。

更多功能

请查看 文档

贡献

本开源项目欢迎任何贡献，请阅读 贡献指南 以获取更多信息。