创建带错误码的error

NewCode/NewCodef

  • 说明:功能同New/Newf方法,用于创建一个自定义错误信息的error对象,并包含堆栈信息,并增加错误码对象的输入。
  • 格式:

    1. NewCode(code gcode.Code, text ...string) error
    2. NewCodef(code gcode.Code, format string, args ...interface{}) error
  • 实例:

    1. func ExampleNewCode() {
    2. err := gerror.NewCode(gcode.New(10000, "", nil), "My Error")
    3. fmt.Println(err.Error())
    4. fmt.Println(gerror.Code(err))
    5. // Output:
    6. // My Error
    7. // 10000
    8. }
    9. func ExampleNewCodef() {
    10. err := gerror.NewCodef(gcode.New(10000, "", nil), "It's %s", "My Error")
    11. fmt.Println(err.Error())
    12. fmt.Println(gerror.Code(err).Code())
    13. // Output:
    14. // It's My Error
    15. // 10000
    16. }

WrapCode/WrapCodef

  • 说明:功能同Wrap/Wrapf方法,用于包裹其他错误error对象,构造成多级的错误信息,包含堆栈信息,并增加错误码参数的输入。
  • 格式:

    1. WrapCode(code gcode.Code, err error, text ...string) error
    2. WrapCodef(code gcode.Code, err error, format string, args ...interface{}) error
  • 示例:

    1. func ExampleWrapCode() {
    2. err1 := errors.New("permission denied")
    3. err2 := gerror.WrapCode(gcode.New(10000, "", nil), err1, "Custom Error")
    4. fmt.Println(err2.Error())
    5. fmt.Println(gerror.Code(err2).Code())
    6. // Output:
    7. // Custom Error: permission denied
    8. // 10000
    9. }
    10. func ExampleWrapCodef() {
    11. err1 := errors.New("permission denied")
    12. err2 := gerror.WrapCodef(gcode.New(10000, "", nil), err1, "It's %s", "Custom Error")
    13. fmt.Println(err2.Error())
    14. fmt.Println(gerror.Code(err2).Code())
    15. // Output:
    16. // It's Custom Error: permission denied
    17. // 10000
    18. }

NewCodeSkip/NewCodeSkipf

  • 说明:高级方法,开发者一般很少会用到。功能同NewSkip/NewSkipf,用于创建一个自定义错误信息的error对象,并且忽略部分堆栈信息(按照当前调用方法位置往上忽略),并增加错误参数输入。
  • 格式:

    1. func NewCodeSkip(code, skip int, text string) error
    2. func NewCodeSkipf(code, skip int, format string, args ...interface{}) error

获取error中的错误码接口

  1. func Code(err error) gcode.Code

当给定的error参数不带有错误码信息时,该方法返回预定义的错误码gcode.CodeNil