Preface abstract

This article will introduce ：GoFrame Common methods of error handling & Use of error codes . How to customize error objects 、 How to ignore some stack information 、 How to customize the return of error codes 、 How to get error Object .

Error creating

New/Newf

For creating a custom error message error object , And contains stack information .

New(text string) errorNewf(format string, args ...interface{}) error

Wrap/Wrapf

For wrapping other errors error object , Construct a multi-level error message , Contains stack information .

func Wrap(err error, text string) errorfunc Wrapf(err error, format string, args ...interface{}) error

NewSkip/NewSkipf

For creating a custom error message error object , And ignore some stack information （ Ignore up according to the current calling method position ）. Advanced features , The average developer rarely uses .

func NewSkip(skip int, text string) error func NewSkipf(skip int, format string, args ...interface{}) error

Error code use

Overview of error code related methods

func NewCode(code int, text string) errorfunc NewCodef(code int, format string, args ...interface{}) errorfunc NewCodeSkip(code, skip int, text string) errorfunc NewCodeSkipf(code, skip int, format string, args ...interface{}) errorfunc WrapCode(code int, err error, text string) errorfunc WrapCodef(code int, err error, format string, args ...interface{}) error

NewCode/NewCodef

Same function New/Newf Method , For creating a custom error message error object , And contains stack information , And add the input of error code object .

NewCode(code gcode.Code, text ...string) errorNewCodef(code gcode.Code, format string, args ...interface{}) error

Sample code

func ExampleNewCode() {    err := gerror.NewCode(gcode.New(101, "", nil), "My Error")    fmt.Println(err.Error())    // My Error    fmt.Println(gerror.Code(err))    //101}func ExampleNewCodef() {    err := gerror.NewCodef(gcode.New(101, "", nil), "It's %s", "My Error")    fmt.Println(err.Error()) //It's My Error    fmt.Println(gerror.Code(err).Code()) //101}

WrapCode/WrapCodef

Same function Wrap/Wrapf Method , For wrapping other errors error object , Construct a multi-level error message , Contains stack information , And add the input of error code parameters .

WrapCode(code gcode.Code, err error, text ...string) errorWrapCodef(code gcode.Code, err error, format string, args ...interface{}) error

Sample code

func ExampleWrapCode() {    err1 := errors.New("permission denied")    err2 := gerror.WrapCode(gcode.New(403, "", nil), err1, "Custom Error")    fmt.Println(err2.Error())     // Custom Error: permission denied    fmt.Println(gerror.Code(err2).Code())    // 403}func ExampleWrapCodef() {    err1 := errors.New("permission denied")    err2 := gerror.WrapCodef(gcode.New(403, "", nil), err1, "It's %s", "Custom Error")    fmt.Println(err2.Error())    // It's Custom Error: permission denied    fmt.Println(gerror.Code(err2).Code())    // 403}

NewCodeSkip/NewCodeSkipf

Same function NewSkip/NewSkipf, For creating a custom error message error object , And ignore some stack information （ Ignore up according to the current calling method position ）, And add error parameter input .

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

obtain error Error code interface in

func Code(err error) gcode.Code

When given error When the parameter does not contain error code information , This method returns a predefined error code gcode.CodeNil