在Go项目中管理自定义错误码和错误描述

一 说明

1.1 当前软件环境,Windows10,VSCode

二 步骤

2.1 目的,建立统一的错误码-错误描述入口,方便前端或用户反馈时候查找问题

2.2 实现,大体想法就是,建立一套错误码,然后每个错误码,对应一个错误描述,使用map映射他们的对应关系。

err_id.go文件

/*
功能:错误码
时间:2022-5-1
*/
package ERROR

type ID int

const (
    SUCCESS ID = 0 //成功

    AUTH_FAILURE ID = 100 //认证失败

    //注册,从1000开始
    REGISTER_ACCOUNT_ERROR ID = 1000 //账号错误
    REGISTER_PWD_ERROR     ID = 1001 //密码错误

    //登录,从2000开始
    LOGIN_ACCOUNT_ERROR ID = 2000 //账号错误
    LOGIN_PWD_ERROR     ID = 2001 //密码错误

    //
)

//-----------------------------------------------
//                  the end
//-----------------------------------------------

err_msg.go文件
/*
功能:错误描述
时间:2022-5-1
*/
package ERROR

type Message string

//错误项
type error_item struct {
    id  ID
    msg Message
}

//-----------------------------------------------
//类
type ErrorManager struct {
    err_map map[ID]Message
}

var instance_error_manager *ErrorManager

//-----------------------------------------------
//函数定义
func GetInstance() *ErrorManager {
    if instance_error_manager == nil {
        instance_error_manager = &ErrorManager{}
        instance_error_manager.bind()
    }
    return instance_error_manager
}

//查找错误消息
func (e *ErrorManager) Find(err_id ID) Message {
    err_msg, ok := e.err_map[err_id]
    if !ok {
        panic("错误码需要配置")
    }
    return err_msg
}

//绑定关系
func (e *ErrorManager) bind() {
    //配置
    error_configs := []error_item{
        {SUCCESS, "成功"},

        {AUTH_FAILURE, "认证失败"},

        //注册
        {REGISTER_ACCOUNT_ERROR, "注册失败,账号不合法或重复"},
        {REGISTER_PWD_ERROR, "注册失败,密码不合法"},

        //登录
        {LOGIN_ACCOUNT_ERROR, "登录失败,账号错误"},
        {LOGIN_PWD_ERROR, "登录失败,密码错误"},
    }

    e.err_map = make(map[ID]Message)
    for i := 0; i < len(error_configs); i++ {
        config := error_configs[i]
        key := config.id
        e.err_map[key] = config.msg
    }
}

//-----------------------------------------------
//测试
func test_error() {
    e := GetInstance()
    t := e.Find(SUCCESS)

    print(t)
}

//引入测试
func Import_test_error() {
    //test_error()
}

//-----------------------------------------------
//                  the end
//-----------------------------------------------

包外部使用,只需要关注 错误码,错误描述通过查询获取:
err_id := ERROR.LOGIN_ACCOUNT_ERROR
err_msg := ERROR.GetInstance().Find(err_id)

学海无涯,错误难免,如有发现,尽请指正。

--the end

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容