【译文】原文地址
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