你错误处理错误:可预测和标准化响应的案例
简介:固执己见的立场
JavaScript 中的错误处理是一个引起强烈意见的话题,我在这里分享我的观点:传统的 try–catch 方法笨重、不方便且过时。在 garmingo,我们构建了 garmingo status(一种用于正常运行时间和基础设施监控的 saas 解决方案),我们已经放弃了 try-catch 块。相反,我们采用了基于 typescript 的方法,为异步操作提供可预测的标准化响应。
本文分享了为什么我们相信这种范例可以改变开发人员生产力,以及它如何帮助简化我们的代码库。虽然这是一个固执己见的观点,但我希望它能激励您重新思考如何处理自己项目中的错误。
try-catch 的问题
让我们面对现实:javascript 中的错误处理可能会变得混乱。传统的 try-catch 块面临着许多挑战:
- 冗长:将每个异步函数调用包装在 try-catch 中会添加不必要的样板。它会使您的代码变得混乱并降低可读性。
- 不一致的错误对象:javascript 错误对象的结构和内容可能会有很大差异。如果没有标准化,处理这些错误通常就像玩猜谜游戏。
- 嵌套逻辑地狱:在处理可能失败的多个操作时,嵌套的 try-catch 块会使您的代码变得一团乱麻。
这是一个强调这些问题的简单示例:
try { const user = await fetchuser(); try { const account = await fetchaccount(user.id); console.log(account); } catch (accountError) { console.error('error fetching account:', accounterror); } } catch (usererror) { console.error('error fetching user:', usererror); }
结果?代码更难阅读、调试和维护。
输入 typescript 类型化响应范式
在 garmingo status,我们放弃了 try-catch,转而为所有异步操作采用标准化响应结构。其工作原理如下:
结构
每个异步函数都会返回一个具有预定义联合类型的 promise:
promise< | { success: false; error: String } | { success: true; result: t } >;
此方法可确保:
- 如果操作失败,结果始终是 { success: false, error: string }.
- 如果成功,则为 { success: true, result: t }.
- 如果 success 为 true,则有一个结果对象并且没有错误对象,反之亦然。您甚至无法使用失败响应的结果。
这是与上面相同的示例,用此模式重写:
const userresponse = await fetchuser(); if (!userresponse.success) { console.error('error fetching user:', userresponse.error); return; } const accountresponse = await fetchaccount(userresponse.result.id); if (!accountresponse.success) { console.error('error fetching account:', accountresponse.error); return; } console.log(accountresponse.result);
如您所见,它不会为您的应用程序的主要逻辑引入任何嵌套。它只是添加了这些用于错误处理的小检查,但主要流程保持不间断并且可以继续,就像一开始就不需要错误处理一样。
可预测和标准化错误处理的优点
1. 可预测性
最大的好处是确切地知道会发生什么。无论操作成功还是失败,结构都是一致的。这消除了错误对象经常带来的歧义。
2. 易于使用
深度嵌套的 try-catch 块的时代已经一去不复返了。使用类型化方法,您可以内联处理错误,而不会破坏代码流程。
3. 提高可读性
结构化方法使您的代码更清晰且更易于遵循。每个操作都清楚地定义了成功和失败场景中会发生什么。
4. 增强类型安全
typescript 的静态分析可确保您永远不会忘记处理错误。如果您不小心忽略了成功检查,typescript 编译器将对其进行标记。
平衡的观点
没有一种方法是没有缺点的。类型化响应范例要求您显式检查每个操作的成功状态,即使您确信它会成功。与传统方法相比,这会增加少量开销,您可以完全避免错误处理(尽管风险由您自己承担)。
然而,这个“缺点”也是它的优点之一:它迫使您批判性地思考潜在的失败,从而产生更健壮的代码。
我们如何在 garmingo status 使用它
在 garmingo,这种方法改变了我们构建异步实用程序和库的方式。每个 api 调用和数据库查询都遵循此标准化响应结构,确保我们的代码库的一致性。
事实上,每个在项目中重复使用并且可能失败的单个异步函数都使用这种方法。
结果呢?更流畅(更快)的开发体验和更少的深夜调试会话。
例如,获取函数可能如下所示:
async function fetchSomething(): Promise< | { success: false; error: string } | { success: true; result: Status } > { try { const response = await api.get('https://exampleapi.com/'); return { success: true, result: response.data }; } catch (error) { return { success: false, error: 'Failed to fetch status' }; } }
这种可预测性改变了我们团队的游戏规则,使我们能够专注于构建功能,而不是理清错误处理逻辑。
结论
传统的 try-catch 块有其用武之地,但对于现代 javascript 开发——尤其是在 typescript 密集的代码库中——它们通常带来的麻烦超过了它们的价值。通过采用类型化响应范例,您可以获得可预测性、可读性和安心。
在 garmingo,我们亲眼目睹了这种方法如何简化开发并增强我们交付 garmingo status 等精美产品的能力。虽然它可能并不适合所有人,但我坚信这是更多开发人员应该考虑的方法。
那么,您准备好重新考虑错误处理了吗?让我知道你的想法!