侯体宗的博客
  • 首页
  • Hyperf版
  • beego仿版
  • 人生(杂谈)
  • 技术
  • 关于我
  • 更多分类
    • 文件下载
    • 文字修仙
    • 中国象棋ai
    • 群聊
    • 九宫格抽奖
    • 拼图
    • 消消乐
    • 相册

在go语言中对Grpc工具buf.build使用流程步骤

Go  /  管理员 发布于 2年前   753

go项目目录结构

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

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

安装各类工具

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:
      -
      - paths=source_relative


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

version: v1
directories:
  - proto


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

buf generate

执行命令后会在 userservice 根目录下多了一个 genproto 目录。

里面放着各类 proto 文件。


  • 上一条:
    宝塔面板Nginx开启Brotli压缩流程步骤,提升网站加载速度
    下一条:
    使用dcat-xlswriter扩展实现表格文件自定义列宽导出流程步骤
  • 昵称:

    邮箱:

    0条评论 (评论内容有缓存机制,请悉知!)
    最新最热
    • 分类目录
    • 人生(杂谈)
    • 技术
    • linux
    • Java
    • php
    • 框架(架构)
    • 前端
    • ThinkPHP
    • 数据库
    • 微信(小程序)
    • Laravel
    • Redis
    • Docker
    • Go
    • swoole
    • Windows
    • Python
    • 苹果(mac/ios)
    • 相关文章
    • 在go中实现一个常用的先进先出的缓存淘汰算法示例代码(0个评论)
    • 在go+gin中使用"github.com/skip2/go-qrcode"实现url转二维码功能(0个评论)
    • 在go语言中使用api.geonames.org接口实现根据国际邮政编码获取地址信息功能(1个评论)
    • 在go语言中使用github.com/signintech/gopdf实现生成pdf分页文件功能(0个评论)
    • 在go语言中使用github.com/signintech/gopdf实现生成pdf文件功能(0个评论)
    • 近期文章
    • 智能合约Solidity学习CryptoZombie二课:让你的僵尸猎食(0个评论)
    • 智能合约Solidity学习CryptoZombie第一课:生成一只你的僵尸(0个评论)
    • 在go中实现一个常用的先进先出的缓存淘汰算法示例代码(0个评论)
    • 在go+gin中使用"github.com/skip2/go-qrcode"实现url转二维码功能(0个评论)
    • 在go语言中使用api.geonames.org接口实现根据国际邮政编码获取地址信息功能(1个评论)
    • 在go语言中使用github.com/signintech/gopdf实现生成pdf分页文件功能(0个评论)
    • gmail发邮件报错:534 5.7.9 Application-specific password required...解决方案(0个评论)
    • 欧盟关于强迫劳动的规定的官方举报渠道及官方举报网站(0个评论)
    • 在go语言中使用github.com/signintech/gopdf实现生成pdf文件功能(0个评论)
    • Laravel从Accel获得5700万美元A轮融资(0个评论)
    • 近期评论
    • 122 在

      学历:一种延缓就业设计,生活需求下的权衡之选中评论 工作几年后,报名考研了,到现在还没认真学习备考,迷茫中。作为一名北漂互联网打工人..
    • 123 在

      Clash for Windows作者删库跑路了,github已404中评论 按理说只要你在国内,所有的流量进出都在监控范围内,不管你怎么隐藏也没用,想搞你分..
    • 原梓番博客 在

      在Laravel框架中使用模型Model分表最简单的方法中评论 好久好久都没看友情链接申请了,今天刚看,已经添加。..
    • 博主 在

      佛跳墙vpn软件不会用?上不了网?佛跳墙vpn常见问题以及解决办法中评论 @1111老铁这个不行了,可以看看近期评论的其他文章..
    • 1111 在

      佛跳墙vpn软件不会用?上不了网?佛跳墙vpn常见问题以及解决办法中评论 网站不能打开,博主百忙中能否发个APP下载链接,佛跳墙或极光..
    • 2016-10
    • 2017-09
    • 2020-03
    • 2020-05
    • 2020-06
    • 2020-07
    • 2020-12
    • 2021-01
    • 2021-05
    • 2021-06
    • 2021-07
    • 2021-08
    • 2021-10
    • 2021-11
    • 2021-12
    • 2022-01
    • 2022-02
    • 2022-03
    • 2022-04
    • 2022-05
    • 2022-06
    • 2022-07
    • 2022-08
    • 2022-09
    • 2022-10
    • 2022-11
    • 2022-12
    • 2023-01
    • 2023-02
    • 2023-03
    • 2023-04
    • 2023-05
    • 2023-06
    • 2023-07
    • 2023-08
    • 2023-09
    • 2023-10
    • 2023-11
    • 2023-12
    • 2024-01
    • 2024-02
    • 2024-03
    • 2024-04
    • 2024-05
    • 2024-06
    • 2024-07
    • 2024-08
    • 2024-11
    • 2025-02
    • 2025-04
    • 2025-05
    • 2025-06
    Top

    Copyright·© 2019 侯体宗版权所有· 粤ICP备20027696号 PHP交流群

    侯体宗的博客