protoc-gen-rpcx

README

安装

• 首先我们需要 protoc 编译器: protobuf。一般平台上都有编译好的二进制程序，直接下载加载PATH路径里即可。或者你也可以源代码安装。

protoc负责将proto文件编译成不同编程语言的代码，一般通过插件的方式实现。

• 安装golang官方protoc-gen-go插件或gogo protoc-gen-gofast插件，任选其一即可。

go install github.com/golang/protobuf/protoc-gen-go@latest // 支持标准库
go install github.com/gogo/protobuf/protoc-gen-gofast@latest // 支持gogo gofast

go install github.com/rpcxio/protoc-gen-go@latest // 本插件

• 编译rpcx插件:

go install github.com/rpcxio/protoc-gen-rpcx@latest

如果你到达了这一步，恭喜你，插件安装成功了，按照下面的命令你就可以将proto中定义的service编译成rpcx的服务和客户端代码了:

protobuf官方库(如果未设置GOPATH,请去掉-I${GOPATH}/src或者设置GOPAH)：

protoc -I. -I${GOPATH}/src \
   --go_out=. \
  --rpcx_out=. --rpcx_opt=paths=source_relative helloworld.proto

gogo库(如果未设置GOPATH,请去掉-I${GOPATH}/src或者设置GOPAH)：

protoc -I. -I${GOPATH}/src \
  --gofast_out=. --gofast_opt=paths=source_relative \
  --rpcx_out=. --rpcx_opt=paths=source_relative *.proto

例子

• proto文件

最简单的一个打招呼的rpc服务。

syntax = "proto3";

option go_package = "github.com/rpcxio/protoc-gen-rpcx/testdata/rpcx/helloworld";

package helloworld;

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

• 使用protoc编译器编译出Go代码

protoc -I. -I${GOPATH}/src \
  --gofast_out=. --gofast_opt=paths=source_relative \
  --rpcx_out=. --rpcx_opt=paths=source_relative helloworld.proto

上述命令生成了 helloworld.pb.go 与 helloworld.rpcx.pb.go 两个文件。 helloworld.pb.go 文件是由protoc-gen-gofast插件生成的， 当然你也可以选择官方的protoc-gen-go插件来生成。 helloworld.rpcx.pb.go 是由protoc-gen-rpcx插件生成的，它包含服务端的一个骨架， 以及客户端的代码。

• 服务端代码

服务端的代码只是一个骨架，很显然你要实现你的逻辑。比如这个打招呼的例子， 客户端传入一个名称，你可以返回一个hello <name>的字符串。

它还提供了一个简单启动服务的方法，你可以在此基础上实现服务端的代码，注册很多的服务，配置注册中心和其它插件等等。

package main

import (
	context "context"
	"fmt"

	helloworld "github.com/rpcxio/protoc-gen-rpcx/testdata/rpcx"
	server "github.com/smallnest/rpcx/server"
)

func main() {
	s := server.NewServer()
	s.RegisterName("Greeter", new(GreeterImpl), "")
	err := s.Serve("tcp", ":8972")
	if err != nil {
		panic(err)
	}
}

type GreeterImpl struct{}

// SayHello is server rpc method as defined
func (s *GreeterImpl) SayHello(ctx context.Context, args *helloworld.HelloRequest, reply *helloworld.HelloReply) (err error) {
	*reply = helloworld.HelloReply{
		Message: fmt.Sprintf("hello %s!", args.Name),
	}
	return nil
}

• 客户端代码

客户端生成的代码更友好，它包装了XClient对象，提供了符合人工美学的方法调用格式(请求参数作为方法参数，返回结果作为方法的返回值)。并且提供了客户端的配置方式。

你也可以扩展客户端的配置，提供注册中心、路由算法，失败模式、重试、熔断等服务治理的设置。　

package main

import (
	"context"
	"fmt"

	helloworld "github.com/rpcxio/protoc-gen-rpcx/testdata/rpcx"
)

func main() {
	xclient := helloworld.NewXClientForGreeter("127.0.0.1:8972")
	client := helloworld.NewGreeterClient(xclient)

	args := &helloworld.HelloRequest{
		Name: "rpcx",
	}

	reply, err := client.SayHello(context.Background(), args)
	if err != nil {
		panic(err)
	}

	fmt.Println("reply: ", reply.Message)
}