基本介绍
基于微服务开发的工程目录采用统一的框架工程目录结构,具体请参考章节:工程目录设计🔥
我们这里以项目 https://github.com/gogf/gf-demo-grpc 为例说明。
协议文件
协议文件定义到 manifest/protobuf
目录下。目录下的协议文件路径规则: 模块名/版本号/xxx.proto
其中的版本号以 v1/v2
类似形式管理,便于维护接口兼容性。
其中,涉及到数据表数据结构通过框架开发工具生成的 protobuf
文件存放到 manifest/pbentity
目录下。
接口文件
通过 proto
协议文件编译生成的接口文档存放到统一的 api
目录下。
开发工具
生成数据表结构
我们可以通过 gf gen pbentity / make pbentity
命令自动根据数据库中的数据表结构生成对应的 protobuf
协议文件。命令介绍请参考章节: 数据表PB-gen pbentity
编译 proto
协议文件
框架提供了 gf gen pb / make pb
命令自动编译 proto
协议文件,并生成对应的接口文件以及控制器文件。