重要规范
工程开发规范
- 开发完整工程类型的项目如HTTP、微服务项目时,需要先安装GoFrame CLI开发工具,并使用CLI工具创建项目骨架,对应命令为gf init,命令的具体使用方式需参考文档项目创建-init。
- 在GoFrame工程规范中,由开发工具自动维护的代码文件,如dao、do、entity等源码文件,不允许手动创建或修改。
- 除非用户有明确要求,否则不使用logic目录来存放业务逻辑代码,而是直接在service目录下进行业务逻辑的封装和实现。
- 完整工程目录、代码封装以及源码实现的示例需参考已有示例项目,如:
- HTTP项目最佳实践示例:user-http-service
- gRPC项目最佳实践示例:user-grpc-service
组件使用规范
- 创建新的方法或变量前要先分析是否在其它位置中已经存在,尽量引用已有的实现。
- 错误处理统一使用gerror组件,确保错误信息带有完整堆栈信息以提供可追踪性。
- 在调研使用新组件时,优先考虑引用GoFrame框架中已有组件、优先参考示例代码中的最佳实践源码。
Go开发资料
完整的GoFrame开发资料,包含各类组件的设计介绍、使用说明、最佳实践、注意事项:Go开发资料
Go示例代码
丰富的GoFrame实战代码示例,涵盖HTTP服务、gRPC服务等多种项目类型:Go示例代码
Source: demozx/gf_cms — distributed by TomeVault.