Skip to content

Latest commit

 

History

History
221 lines (206 loc) · 6.99 KB

README.md

File metadata and controls

221 lines (206 loc) · 6.99 KB
Raw

项目结构

- cmd
    - demo
        - main.go // demo 项目启动入口
- demo
    - schema  // type 声明
        - db.go // db 相关的 type 声明
        - api.go // api response type 声明
		- error.go   // error 信息
        - other.go // 其他模块对应的 type 声明
    - api.go    // restful 接口实现
    - demo.go   // 入口函数
    - jobs.go   // 定时任务实现
    - wdb.go   // 关系型数据库读写方法实现
    - cache.go // 缓存
    - other.go // 独立的处理方法
- example // 用例
    - xxx.go
- .drone.yml // ci/cd 配置文件
- Dockerfile 
- README.md // demo 项目 readme
- mod.go
- Makefile // make all, make test
- test.sh

project-example

基准

  • 每个 package 独立可用，对外接口尽量简洁，最好具备复用性
  • package 文件夹名称和里面的入口文件命名一致
  • 入口文件不宜有太多编码
  • 应将外部函数放在入口文件，业务自顶向下实现，入口能表现 package 的核心功能
  • 入口文件一般包含三个外部函数，分别是：New(), Run(), Close()
  • 提交代码之前必须运行 make all 和 make test 并通过之后才能提交
  • 命名风格参考之前的项目进行统一
  • cmd/main.go 中监听 signals 信号之后必须要调用 CLose() 进行安全退出

通用三方库

  • cli: github.com/urfave/cli
  • api: github.com/gin-gonic/gin
  • job: github.com/go-co-op/gocron
  • log: github.com/inconshreveable/log15
  • test: github.com/stretchr/testify
  • json: github.com/tidwall/gjson
  • http-cli: gopkg.in/h2non/gentleman.v2
  • decimal library: github.com/shopspring/decimal
  • ethereumRPC: github.com/everFinance/ethrpc
  • ethereumSDK: github.com/everFinance/goether
  • arweaveSDK: github.com/everFinance/goar
  • web-framework: github.com/gin-gonic/gin
  • redis-cli: github.com/go-redis/redis
  • mysql-cli: gorm.io/gorm

日志

封装

func NewLog(serverName string) log15.Logger {
	lg := log15.New("module", serverName)

	// 默认的 logger handle
	h := lg.GetHandler()
	// 集成 sentry 的 logger handle
	sentryHandle := log15.FuncHandler(func(r *log15.Record) error {
		if r.Lvl == log15.LvlError {
			msg := string(log15.JsonFormat().Format(r))
			go func(m string) {
				sentry.CaptureMessage(m)
			}(msg)
		}
		return nil
	})

	lg.SetHandler(log15.MultiHandler(h, sentryHandle))

	return lg
}

使用

var log = NewLog("demo")

log.Info(msg, "var1",var1,"var2",var2)
log.Debug(msg, "var1",var1,"var2",var2)
log.Warn(msg, "var1",var1,"var2",var2)
log.Error(msg, "err",err,"var1",var1)

使用规范

内容简洁

日志 msg 必须简洁明确，不相干数据严重干扰日志分析。比如在打印 tx 日志中，不要输出 tx 所有字段，只需要打印需要的字段。

重复输出

在开发过程中，经常出现日志打印重复的情况。比如如下:

func A() {
    err := b()
    if err != nil {
        log.Error("b() failed","err",err) 
      
    }
    
}

func b() error {
   _, err :=  strconv.Atoi("111")
   if err != nil {
       log.Error("strconv.Atoi("111")","err",err)
       return err
   }
   return nil
}

b() 中打印过 err msg，但是 A() 中又会打印一次 b() 返回的error, 所以出现了重复打印的情况。这种情况严重干扰对日志的分析。 正确的做法是在 b() 中不打印，只要在最外层调用函数中打印。

正确使用日志级别

在 log5 中主要使用到 Debug, Info, Warn, Error 这四个级别来打印日志。

  1. Debug 使用场景
    代码调试、输出关键信息用于判断程序状态。
  2. Info 使用场景
    程序启动打印初始化数据信息、关键状态正常改变之后的信息输出。
  3. Warn 使用场景
    对系统整体运行影响不大但是不可忽略的错误，需要通过 warn 级别输出。比如读取外部服务的定时任务某次读取失败的情况。
  4. Error 使用场景
    服务出现 Error 并影响服务正常运行都必须使用 Error 级别输出。

error 信息声明

error 信息统一在 error.go 中声明，命名方式为蛇形命名法，如：

var ERR_INVALID_SIGNATURE = "err_invalid_signature"

编码规范

参考 Uber-go 规范

补充

  • 在 demo.go 中原则上只实现三个方法 New(), Run(), Close()
  • 在 **.go 文件中，只有需要被其他文件调用的方法首字符才大写。
  • 文件中 public 方法统一写在 private 方法之前。 
    AA(){}
BB(){}
aa(){}
bb(){}
  • 方法命令必须为驼峰，并且必须简洁 
    bad:
 UpdateBlockChainStableBlock(){}
Good:
 UpdateStableBlock(){}
  • 相同属性的传参写到一起，返回值如此 
    AA(ethRpc, moonRpc, cfxRpc string, db *Db) {}
  • 存在 error 返回值，error 写在返回值最后一位 
    AA(ethRpc, moonRpc, cfxRpc string, db *Db) (string,int,error) {}
  • 函数参数避免指针类型。如果是 slice, map 传参之前可以 copy 一份
  • 避免使用多重 if- else if -else, 请替换成 switch
  • 不要使用闭包，因为你没法控制闭包中调用的外部变量是如何变化 
    bad:
    for i:=0; i <10; i ++ {
        go func() {
            t.Log(i) // 闭包中的 i 会随着 for 循环改变，最后打印的都是 10
        }()
    }
good:
    for i:=0; i <10; i ++ {
        go func(i int) { // 通过确定性的传参
            t.Log(i)
        }(i)
    }
  • 使用 locker.Lock() 之后必须立即声明 defer locker.Unlocker() 
    bad: 
func AA() {
locker.Lock()
  ... 
locker.UnLock()
 }

good:
func AA() {
locker.Lock()
defer locker.UnLock()
  ...
}
  • 尽量避免使用 init() 函数，因为加载 init() 函数中路径不可控，并且 init() 中逻辑不显式调用执行。请把 init() 中的处理放在 demo.go/New() 或者 Run() 中。
  • 使用 slice 或者 map，请在 make 的时候指定 cap, 这样 append 的时候会更高效以及节省代码运行时开辟的内存空间。 
    tokenList := make([]severSchema.TokenInfo, 0, 50)
  • 正常情况下不会使用到缓冲 channel, 如果必须要使用缓冲 channel, 请备注好为什么 cap 设置为该值。
  • 需要重命名 import package 的时候需要遵循就近原则，本模块的不需要重命名，名字冲突的其他模块命名需要加上模块名。 
    import (
    confSchema "github.com/everFinance/everpay/config/schema" // config 模块
    paySchema "github.com/everFinance/everpay/pay/schema" // pay 模块
    "github.com/everFinance/everpay/server/schema" // 同一模块
)
  • api 返回结果必须使用 struct 形式 
    bad:
c.JSON(http.StatusOK, gin.H{
	"total": total,
	"txs": txs,
})

good:
c.JSON(http.StatusOK, schema.RespTxs{
        Total: total,
        Txs:   txs,
    })
  • 代码中声明整数类型都使用 int64