项目背景#

在开发微服务时，我们经常需要同时提供 gRPC 和 HTTP RESTful 两种接口。传统做法是分别编写两套代码，这不仅增加了开发工作量，还容易造成接口不一致。受 B 站开源的 Kratos 框架启发，我开发了 protoc-gen-gin，一个专门为 Gin 框架生成 HTTP 处理代码的 protoc 插件。

项目地址：https://github.com/JarrettGuo/protogin

核心特性#

1
service UserService {
2
  rpc GetUser(GetUserRequest) returns (GetUserResponse) {
3
    option (google.api.http) = {
4
      get: "/api/v1/users/{user_id}"
5
    };
6
  }
7
}

1
// 使用默认错误处理
2
pb.RegisterUserServiceHTTPServer(srv, r)
3

4
// 或自定义错误处理
5
pb.RegisterUserServiceHTTPServer(srv, r,
6
    pb.WithErrorHandler(customHandler))

技术实现#

项目采用 protogen 包实现代码生成，核心流程：

1. 解析 proto 文件中的 google.api.http 注解
2. 转换路径参数格式（{param} → :param）
3. 根据 HTTP 方法生成对应的参数绑定代码
4. 使用 Go template 生成最终代码

使用方式#

安装插件：

1
go install github.com/JarrettGuo/protogin/cmd/protoc-gen-gin@latest

生成代码：

1
protoc --gin_out=. --gin_opt=paths=source_relative api.proto

项目价值#

• 提高开发效率：减少重复代码编写
• 保证接口一致性：从同一 proto 定义生成
• 架构灵活性：支持从单体到微服务的演进
• 降低维护成本：修改 proto 即可更新所有接口

未来规划#

• 支持流式 RPC
• 生成 OpenAPI 文档
• 添加请求验证
• 支持中间件链式调用