Golang简单错误处理与分类原语插件库errors的使用

errors包提供了简单的Golang错误和分类原语。

Class

包定义了一个极速的分类系统。Class是一个uint32包装器，由Major、Minor和Index子分类组成。每个子分类有不同的位长度：Major占8位，Minor占10位，Index占14位，总共32位。

示例：

00000010101000101000010011001111 分解为:
00000010 - major (8 bit)
        1010001010 - minor (10 bit)
                  00010011001111 - index (14 bit)

Class可以通过三种方式组成：

• 仅Major - Class是Major单例
• Major和Minor - 不需要三重子分类
• Major、Minor和Index - 需要分解

使用NewMajor或MustNewMajor函数创建Major，NewMinor或MustNewMinor创建Minor，NewIndex或MustNewIndex创建Index。

接口

包提供了简单的错误处理接口和函数，可以创建简单和详细的分类错误。

ClassError

ClassError接口通过Class方法提供错误分类。

DetailedError

DetailedError是用于存储和处理人类可读细节、包含实例ID和运行时调用操作的错误接口。实现了ClassError、Detailer、Operationer、Indexer和error接口。

Detailer

Detailer接口允许设置和获取人类可读的细节 - 完整句子。

Operationer

OperationError接口用于获取运行时操作信息。

Indexer

Indexer接口用于获取每个错误实例的唯一’ID’。

错误处理

包包含两种错误结构实现：

• 简单错误结构
• 详细错误结构

简单错误

简单错误实现了ClassError接口。它是轻量级错误，仅包含消息和其类。

使用New和Newf函数创建。

示例：

import "github.com/neuronlabs/errors"
// 假设我们已经定义了一些ClassInvalidRequest
var ClassInvalidInput errors.Class

func createValue(input int) error {
    if input < 0 {
        return errors.New(ClassInvalidInput, "provided input lower than zero")
    }

    if input > 50 {
        return errors.Newf(ClassInvalidInput, "provided input value: '%d' is not valid", input) 
    }
    // 执行逻辑
    return nil
}

详细错误

详细错误结构(detailedError)实现了DetailedError。

它包含关于给定错误实例的许多信息：

• 人类可读的Details
• 运行时函数调用Operations
• 唯一错误实例ID

使用NewDet或NewDetf函数创建详细错误。

示例

import (
    "fmt"
    "os"

    "github.com/neuronlabs/errors"
)

var (
    ClInputInvalidValue errors.Class
    ClInputNotProvided  errors.Class
)

func init() {
    initClasses()
}

func initClasses() {
    inputMjr := errors.MustNewMajor()
    invalidValueMnr := errors.MustNewMinor(inputMjr)
    ClInputInvalidValue = errors.MustNewMinorClass(inputMjr, invalidValueMnr)
    
    inputNotProvidedMnr := errors.MustNewMinor(inputMjr)
    ClInputNotProvided = errors.MustNewMinorClass(inputMjr, inputNotProvidedMnr)
}


func main() {
    input, err := getInput()
    if err == nil {
        // 一切正常
        os.Exit(0)
    }

    if classed, ok := err.(errors.ClassError); ok {
        if classed.Class() == ClInputNotProvided {
            fmt.Println("No required integer arguments provided.")
            os.Exit(1)
        }
    }

    var details string
    detailed, ok := err.(errors.DetailedError)
    if ok {
        details = detailed.Details()
    } else {
        details = err.Error()
    }
    fmt.Printf("Invalid input value provided: '%s'\n", details)
    os.Exit(1)    
}


func checkInput(input int) error {
    if input < 0 {
        err := errors.NewDet(ClassInputInvalidValue, "provided input lower than zero")        
        err.SetDetailsf("The input value provided to the function is invalid. The value must be greater than zero.")
        return err
    }

    if input > 50 {
        err := errors.NewDetf(ClassInvalidInput, "provided input value: '%d' is not valid", input) 
        err.SetDetailsf("The input value: '%d' provided to the function is invalid. The value can't be greater than '50'.", input)
        return err
    }
    // 执行逻辑
    return nil
}

func getInput() (int, error) {
    if len(os.Args) == 0 {
        return errors.New(ClInputNotProvided, "no input provided")
    }

    input, err := strconv.Atoi(os.Args[0])
    if err != nil {
        err := errors.NewDetf(ClInputInvalidValue, "provided input is not an integer")        
        err.SetDetail(err.Error())
        return 0, err
    }

    if err = checkInput(input); err != nil {
        return 0, err
    }
    return input, nil
}