基本介绍

框架提供了默认的错误码组件gcode,错误码使用接口化设计,以实现高扩展性。

接口定义

  1. // Code is universal error code interface definition.
  2. type Code interface {
  3. // Code returns the integer number of current error code.
  4. Code() int
  5. // Message returns the brief message for current error code.
  6. Message() string
  7. // Detail returns the detailed information of current error code,
  8. // which is mainly designed as an extension field for error code.
  9. Detail() interface{}
  10. }

默认实现

框架提供了默认实现gcode.Code的结构体,开发者可以直接通过New/WithCode方法创建错误码:

  • 格式:

    1. // New creates and returns an error code.
    2. // Note that it returns an interface object of Code.
    3. func New(code int, message string, detail interface{}) Code
  • 示例:

    1. func ExampleNew() {
    2. c := gcode.New(1, "custom error", "detailed description")
    3. fmt.Println(c.Code())
    4. fmt.Println(c.Message())
    5. fmt.Println(c.Detail())
    6. // Output:
    7. // 1
    8. // custom error
    9. // detailed description
    10. }

如果开发者觉得框架默认实现gcode.Code的结构体不满足需求,可以自行定义,只需实现gcode.Code即可。