根据proto一键生成rpc golang微服务

转自go-zero点击查看原文
go-zero微服务库地址https://github.com/tal-tech/go-zero

Rpc Generation

goctl

特性

• 简单易用
• 快速提升开发效率
• 出错率低
• 支持基于main proto作为相对路径的import
• 支持map、enum类型
• 支持any类型

快速开始

方式一：快速生成greet服务

goctl rpc new ${servieName}

如生成greet rpc服务：

goctl rpc new greet

执行后代码结构如下:

└── greet
  ├── etc
  │   └── greet.yaml
  ├── go.mod
  ├── go.sum
  ├── greet
  │   ├── greet.go
  │   ├── greet_mock.go
  │   └── types.go
  ├── greet.go
  ├── greet.proto
  ├── internal
  │   ├── config
  │   │   └── config.go
  │   ├── logic
  │   │   └── pinglogic.go
  │   ├── server
  │   │   └── greetserver.go
  │   └── svc
  │       └── servicecontext.go
  └── pb
      └── greet.pb.go

rpc一键生成常见问题解决见 常见问题解决

方式二：通过指定proto生成rpc服务

goctl rpc template -o=user.proto

syntax = "proto3";

package remote;

message Request {
  // 用户名
  string username = 1;
  // 用户密码
  string password = 2;
}

message Response {
  // 用户名称
  string name = 1;
  // 用户性别
  string gender = 2;
}

service User {
  // 登录
  rpc Login(Request)returns(Response);
}

goctl rpc proto -src=user.proto

user
    ├── etc
    │   └── user.json
    ├── internal
    │   ├── config
    │   │   └── config.go
    │   ├── handler
    │   │   ├── loginhandler.go
    │   ├── logic
    │   │   └── loginlogic.go
    │   └── svc
    │       └── servicecontext.go
    ├── pb
    │   └── user.pb.go
    ├── shared
    │   ├── mockusermodel.go
    │   ├── types.go
    │   └── usermodel.go
    ├── user.go
    └── user.proto

准备工作

• 安装了go环境
• 安装了protoc&protoc-gen-go，并且已经设置环境变量
• 更多问题请见 注意事项

用法

rpc服务生成用法

goctl rpc proto -h

NAME:
   goctl rpc proto - generate rpc from proto

USAGE:
   goctl rpc proto [command options] [arguments...]

OPTIONS:
   --src value, -s value         the file path of the proto source file
   --dir value, -d value         the target path of the code,default path is "${pwd}". [option]
   --service value, --srv value  the name of rpc service. [option]
   --idea                        whether the command execution environment is from idea plugin. [option]

参数说明

user
    ├── cmd
    │   └── rpc
    │       └── user.proto

开发人员需要做什么

关注业务代码编写，将重复性、与业务无关的工作交给goctl，生成好rpc服务代码后，开饭人员仅需要修改

• 服务中的配置文件编写(etc/xx.json、internal/config/config.go)
• 服务中业务逻辑编写(internal/logic/xxlogic.go)
• 服务中资源上下文的编写(internal/svc/servicecontext.go)

注意事项

replace google.golang.org/grpc => google.golang.org/grpc v1.26.0

    // Code generated by goctl. DO NOT EDIT!
    // Source: xxx.proto

的标识，请注意不要将也写业务性代码写在里面。

any和import支持

google/protobuf/any.proto

⚠️注意： 不支持proto嵌套import，即：被import的proto文件不支持import。

import书写格式

import书写格式

// @{package_of_pb} 
import {proto_omport}

@{package_of_pb}：pb文件的真实import目录。
{proto_omport}：proto import

如：demo中的

// @greet/base
import "base/base.proto";

工程目录结构如下

greet
│   ├── base
│   │   ├── base.pb.go
│   │   └── base.proto
│   ├── demo.proto
│   ├── go.mod
│   └── go.sum

demo

syntax = "proto3";
import "google/protobuf/any.proto";
// @greet/base
import "base/base.proto";
package stream;


enum Gender{
  UNKNOWN = 0;
  MAN = 1;
  WOMAN = 2;
}

message StreamResp{
  string name = 2;
  Gender gender = 3;
  google.protobuf.Any details = 5;
  base.StreamReq req = 6;
}
service StreamGreeter {
  rpc greet(base.StreamReq) returns (StreamResp);
}

常见问题解决(go mod工程)

pb/xx.pb.go:220:7: undefined: grpc.ClientConnInterface
pb/xx.pb.go:224:11: undefined: grpc.SupportPackageIsVersion6
pb/xx.pb.go:234:5: undefined: grpc.ClientConnInterface
pb/xx.pb.go:237:24: undefined: grpc.ClientConnInterface

# go.etcd.io/etcd/clientv3/balancer/picker
../../../go/pkg/mod/go.etcd.io/etcd@v0.0.0-20200402134248-51bdeb39e698/clientv3/balancer/picker/err.go:25:9: cannot use &errPicker literal (type *errPicker) as type Picker in return argument:*errPicker does not implement Picker (wrong type for Pick method)
  have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
  want Pick(balancer.PickInfo) (balancer.PickResult, error)
  ../../../go/pkg/mod/go.etcd.io/etcd@v0.0.0-20200402134248-51bdeb39e698/clientv3/balancer/picker/roundrobin_balanced.go:33:9: cannot use &rrBalanced literal (type *rrBalanced) as type Picker in return argument:
  *rrBalanced does not implement Picker (wrong type for Pick method)
      have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
  want Pick(balancer.PickInfo) (balancer.PickResult, error)
  #github.com/tal-tech/go-zero/zrpc/internal/balancer/p2c
  ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/zrpc/internal/balancer/p2c/p2c.go:41:32: not enough arguments in call to base.NewBalancerBuilder
  have (string, *p2cPickerBuilder)
want (string, base.PickerBuilder, base.Config)
../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/zrpc/internal/balancer/p2c/p2c.go:58:9: cannot use &p2cPicker literal (type *p2cPicker) as type balancer.Picker in return argument:
  *p2cPicker does not implement balancer.Picker (wrong type for Pick method)
      have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
      want Pick(balancer.PickInfo) (balancer.PickResult, error)

replace google.golang.org/grpc => google.golang.org/grpc v1.26.0