Grpc工具buf.build使用

Grpc工具 buf.build 使用

转载请注明来源:https://janrs.com/iclb


目录结构

文件以及目录的总体结构如下:

userservice
├── Makefile
├── buf.gen.yaml
├── buf.work.yaml
├── cmd
│   ├── main.go
│   └── server
│       ├── grpc.go
│       ├── http.go
│       ├── run.go
│       ├── wire.go
│       └── wire_gen.go
├── config
│   ├── config.go
│   ├── config.yaml
│   ├── database.go
│   ├── grpc.go
│   ├── http.go
│   └── logger.go
├── genproto
│   └── go
│       └── v1
│           ├── userservice.pb.go
│           ├── userservice.pb.gw.go
│           ├── userservice.pb.validate.go
│           └── userservice_grpc.pb.go
├── go.mod
├── go.sum
├── migrate
│   ├── migrate.go
│   └── user.go
├── pkg
│   ├── db.go
│   ├── encrypt.go
│   ├── interceptor.go
│   └── response.go
├── proto
│   ├── buf.lock
│   ├── buf.yaml
│   └── v1
│       ├── userservice.proto
│       └── userservice.yaml
├── service
│   ├── client.go
│   ├── repository.go
│   └── server.go
└── storage
    └── grpc.log

12 directories, 35 files

安装各类工具

go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/envoyproxy/protoc-gen-validate@latest

创建proto

proto/v1 目录下创建 userservice.proto 文件,示例代码如下:

syntax = "proto3";

package proto.v1;

option go_package = "userservice/genproto/v1;userV1";

import "google/protobuf/empty.proto";
import "validate/validate.proto";

service UserService {
  rpc Register(RegisterRequest) returns(google.protobuf.Empty){}
  rpc Login(LoginRequest) returns (LoginResponse){}
  rpc Logout(google.protobuf.Empty) returns (google.protobuf.Empty){}
}

//*****************Register
message RegisterRequest {
  string username = 1 [(validate.rules).string = {
    pattern: "^[a-zA-Z0-9_]*$",
    min_len: 6,
    max_len: 16
  }
  ];
  string password = 2 [(validate.rules).string = {
    pattern: "^[a-zA-Z0-9]*$",
    min_len: 6,
    max_len: 16
  }];
}

message RegisterResponse {
  string result = 1;
}

//*****************Login
message LoginRequest {
  string username = 1;
  string password = 2 ;
}

message LoginResponse {
  string username = 1;
  string accessToken = 2;
}

proto/v1 目录下创建 userservice.yaml 接口描述文件,代码如下:

type: google.api.Service
config_version: 3
name: User service apis

http:
  rules:
    # user register
    - selector: proto.v1.UserService.Register
      post: /user.v1.register
      body: "*"
    - selector: proto.v1.UserService.Login
      post: /user.v1.login
      body: "*"
    - selector: proto.v1.UserService.Logout
      post: /user.v1.logout
      body: "*"

进入到 proto 文件夹执行以下命令:

buf mod init

执行命令后在会在 proto 目录下生成一个 buf.yaml 文件,代码如下:

version: v1
deps:
  - buf.build/envoyproxy/protoc-gen-validate
breaking:
  use:
    - FILE
lint:
  use:
    - DEFAULT

最后在 proto 目录下再执行以下命令生成锁定版本号的文件:

buf mod update

创建 buf.gen.yaml

在根目录 userservice 目录下创建 buf.gen.yaml 文件,代码如下:

version: v1
plugins:
  - plugin: go
    out: genproto/go
    opt:
      - paths=source_relative
  - plugin: go-grpc
    out: genproto/go
    opt:
      - paths=source_relative
  - plugin: grpc-gateway
    out: genproto/go
    opt:
      - paths=source_relative
      - grpc_api_configuration=proto/v1/userservice.yaml
  - plugin: validate
    out: genproto/go
    opt:
      - lang=go
      - paths=source_relative

在根目录 userservice 目录下创建 buf.work.yaml 文件定一个工作区,代码如下:

version: v1
directories:
  - proto

最后在 userservice 目录下执行以下命令生成 grpc 代码:

buf generate

执行命令后会在 userservice 根目录下多了一个 genproto 目录。里面放着各类 proto 文件。


转载请注明来源:https://janrs.com/iclb