Go强大的自定义错误处理


【译文】原文地址
Go提供的默认错误包有很多不足之处。 编写多层体系结构应用程序并使用API提供功能需要对错误进行更丰富的处理,而不仅仅是字符串值,还需要更多的上下文信息。 意识到这些缺点,我首先实现了一个功能更强大,更优雅的错误包。 这是一个循序渐进的过程,在此过程中,我遇到了需要随着时间的推移向程序包中引入更多功能的需求。

在这里,我们将探讨如何使用“自定义错误”数据类型在应用程序中带来更多价值,并使错误处理更加强大。首先需要明确的是Go允许使用任何自定义的数据类型来取代内置的error类型,只要实现Error()方法即可。



也就是说只要我们自定义数据类型实现了Error()方法,默认就可以使用自定义数据类型来取代Go提供的错误类型;任何方法返回的error类型都可以返回自定义数据类型而不会发生错误。

创建自定义错误类型CustomError

1、我们创建一个新的数据类型,该数据类型将在整个应用程序中被理解为错误类型。 我们将其命名为CustomError,对于初学者而言,它将包含默认错误类型。error字段将使我们能够在初始化时使用堆栈跟踪对CustomError进行注释(有关更多信息,请参见 此处)。 记录这些堆栈跟踪信息可以更轻松地在类似NewRelic APM等平台上调试错误。


2、Go内置的error类型对待错误看作string值。我总觉得这种方式是不正确的,至少说还不够全。一个错误应该伴随一种类型-发生的原因是在数据库插入/更新/获取操作吗?还是请求数据不全呢?

知道错误的类型允许我们以不同的方式对待每个错误,也可以使我们根据不同的错误类型做出业务级别的决策。现在,让我们更深入地研究ErrorCode的实际类型。

我们根据要在应用程序中捕获的每种错误类型创建各种ErrorCode常量。 现在,错误的解释将基于ErrorCode而不是字符串。
3、同时,我们希望保留对错误的字符串解释,因为这样做的目的是提高可读性,并使我们能够一目了然地了解出了什么问题。

到目前为止ErrorCode会告诉您错误的类型,而不会告诉您错误发生在代码库中的位置。 ErrorMessage用于此目的,使现有功能保持完整。
但是仅仅知道这两件事就足够了吗? 如果我们想捕获更多导致错误的上下文数据该怎么办?假设一个用户打开一个页面显示周边所有的餐馆,但是当他打开应用的时候,一个都没看到。你希望捕获一些上下文信息,例如经纬度以及其他可用于debug的信息比如周边本来就没有餐馆,或者是服务本身问题。LoggingParams参数来拯救,允许您根据上下文捕获各种参数。

例如,我将这些参数附加到在发生严重错误的情况下生成的警报消息中。 乍一看这些参数,有时可以让您找出错误的根本原因。

如果不是这样,它们肯定可以帮助过滤掉特定事件的错误日志。


5、最后,我们需要一些信息来告诉我们CustomError!= nil。

我们引入了一个名为exist的布尔字段,当创建CustomError对象时,该字段将初始化为true。
6、对于一小部分错误,我们希望向终端用户显示某种错误消息。 他们可以理解并采取措施的信息。我们维护了ErrorCode与UI友好消息的映射。

使用方式:

根据上面的示例,您将意识到,每次调用Acquire()函数时,调用方函数都希望返回类型为CustomError的错误,并且随之而来的是我们所做的所有增强功能。

总结

我们看到了如何利用CustomError在多层应用程序中使错误更有意义。 您可以在此处查看具有正确接口定义和实现的完整代码。
Github repo: https://github.com/abhinav-codealchemist/custom-error-go

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

推荐阅读更多精彩内容