在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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,039评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,426评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,417评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,868评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,892评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,692评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,416评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,326评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,782评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,957评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,102评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,790评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,442评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,996评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,113评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,332评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,044评论 2 355

推荐阅读更多精彩内容