go generate

go generate是 Go 自带的工具。使用命令go generate执行。go generate是利用源代码中的注释工作的。格式如下：

  1. //go:generate command arg1 arg2

这样在同一个目录下执行命令go generate就会自动运行命令command arg1 arg2。command可以是在PATH中的任何命令，应用非常广泛。官网提供了几种示例，见文档。
stringer命令可以为给定类型生成String方法。

  1. go:generate前面只能使用//注释，注释必须在行首，前面不能有空格且//与go:generate之间不能有空格！！！

makefile 中：

  1. all:
  2.     go generate && go build .

错误码处理

通过hash保存错误码和错误描述的

  1. package err
  3. import "fmt"
  5. const (
  6.     ERR_CODE_OK             = 0 // success
  7.     ERR_CODE_INVALID_PARAMS = 1 // 参数无效
  8.     ERR_CODE_TIMEOUT        = 2 // 请求超时
  9.     // ...
  10. )
  12. // 定义错误码与描述信息的映射
  13. var mapErrDesc = map[int]string{
  14.     ERR_CODE_OK:             "success",
  15.     ERR_CODE_INVALID_PARAMS: "参数无效",
  16.     ERR_CODE_TIMEOUT:        "请求超时",
  17.     // ...
  18. }
  20. func GetErrDescByCode(code int) string {
  21.     if desc, ok := mapErrDesc[code]; ok {
  22.         return desc
  23.     }
  24.     return fmt.Sprintf("未知错误：%d", code)
  25. }
  1. package err
  3. import (
  4.     "fmt"
  5. )
  7. type ErrCode int
  9. const (
  10.     ERR_CODE_OK             ErrCode = 0 // success
  11.     ERR_CODE_INVALID_PARAMS ErrCode = 1 // 参数无效
  12.     ERR_CODE_TIMEOUT        ErrCode = 2 // 请求超时
  13.     // ...
  14. )
  16. // 定义错误码与描述信息的映射
  17. var mapErrDesc = map[ErrCode]string{
  18.     ERR_CODE_OK:             "success",
  19.     ERR_CODE_INVALID_PARAMS: "参数无效",
  20.     ERR_CODE_TIMEOUT:        "请求超时",
  21.     // ...
  22. }
  24. func getErrDescByCode(code ErrCode) string {
  25.     if desc, ok := mapErrDesc[code]; ok {
  26.         return desc
  27.     }
  28.     return fmt.Sprintf("未知错误：%d", code)
  29. }
  31. func (err ErrCode) String() string {
  32.     return getErrDescByCode(err)
  33. }

stringer

  1.  go get -u golang.org/x/tools/cmd/stringer
  1. package errcode
  3. type ErrCode int
  5. //go:generate stringer -type ErrCode -linecomment
  6. const (
  7.      ERR_CODE_OK ErrCode=0 //OK
  8.      ERR_CODE_INVALID_PARAMS ErrCode=1 //参数错误
  9.      ERR_CODE_TIMEOUT ErrCode =2 //请求超时
  11. )

执行命令

  1. go generate

会生成下面的文件

  1. // Code generated by "stringer -type ErrCode -linecomment"; DO NOT EDIT.
  3. package errcode
  5. import "strconv"
  7. func _() {
  8.     // An "invalid array index" compiler error signifies that the constant values have changed.
  9.     // Re-run the stringer command to generate them again.
  10.     var x [1]struct{}
  11.     _ = x[ERR_CODE_OK-0]
  12.     _ = x[ERR_CODE_INVALID_PARAMS-1]
  13.     _ = x[ERR_CODE_TIMEOUT-2]
  14. }
  16. const _ErrCode_name = "OK参数错误请求超时"
  18. var _ErrCode_index = [...]uint8{0, 2, 14, 26}
  20. func (i ErrCode) String() string {
  21.     if i < 0 || i >= ErrCode(len(_ErrCode_index)-1) {
  22.         return "ErrCode(" + strconv.FormatInt(int64(i), 10) + ")"
  23.     }
  24.     return _ErrCode_name[_ErrCode_index[i]:_ErrCode_index[i+1]]
  25. }