韭圈技术团队的 Go 开发规范

前言

开发规范很重要，可以提高代码的可读性、扩展性、美观性，也能减少Bug出现率，即使出现也可以很快定位问题，解决问题。

韭圈技术团队目前正在积极拥抱 Go，下面是韭圈技术团队对 Go 的开发规范

规范

1. 接口的定义，需要制定版本号，方法名全部使用小写，并使用 "-" 拼接单词，而不使用 "_"。PS：为兼容老接口。允许部分接口还使用之前的模式
   1. 示例

   GET /v3/fund/curve-list
   POST /v3/user/update-avatar
   

2. go 文件名定义，使用小写 + 下划线模式
   1. 示例

   user_book.go
   fund_list.go
   

3. 变量名的定义，遵循 Go 的规范
   1. 示例

   // 公开变量
   var PublicId = 1
   // 私有变量
   var privateId = 2
   // 公开结构体
   type PublicUser struct {}
   // 私有结构体
   type privateUser struct {}
   

4. 函数名的定义，遵循 Go 的规范
   1. 示例

   // 公开的函数
   func GetUser() 
   // 私有的函数
   func getUserList()
   

5. 不同功能的模块划分，比如 service 包，除建立名为 service 的文件夹外，包内部对于功能的代码定义应该明确，例：
   1. 示例

   package service
   
   type sUser struct{}
   var insUser = &sUser{}
   func User() *sUser {
       return insUser
   }
   
   func (u *sUser) GetUserInfo() {
       // do something...
   }
   
   // 调用方
   var userInfo = service.User().GetUserInfo()
   

结语

好的开发规范可以让我们的工程更加敏捷，开发更加便利，目前韭圈技术团队正在积极拥抱 Go，该规范也会在后面不断完善，不断更新的，敬请关注！

韭圈儿 APP

永不套路用户

永不糊弄伙伴

永不低估自己