ESLint no-unsafe-finally 规则详解阻止 finally 块中的控制流语句破坏异常处理【免费下载链接】eslintFind and fix problems in your JavaScript code.项目地址: https://gitcode.com/GitHub_Trending/es/eslint本文基于 ESLint 核心规则no-unsafe-finally的官方文档docs/src/rules/no-unsafe-finally.md及其在仓库中的实现源码、测试用例与推荐配置系统讲解该规则的触发原理、JavaScript 中try/catch/finally的控制流语义、规则源码的 AST 检测算法以及配置与关闭该规则的适用场景。读完本文你将能准确识别finally块中return、throw、break、continue导致的问题理解该规则为何被列入eslint:recommended并能结合源码深入理解其边界情况处理。问题背景finally 中的控制流语句会覆盖 try/catch 的结果JavaScript 规范规定try和catch块中的控制流语句return、throw、break、continue会被挂起suspend直到finally块执行完毕后才继续。因此如果在finally块中直接使用了这四类语句就会覆盖try/catch中已经做出的控制流决策产生与直觉相悖的行为。官方文档用以下四个典型示例揭示了这一语义陷阱。示例一finally 中的 return 覆盖 try 中的 return// 我们期望该函数返回 1 (() { try { return 1; // 1 被返回但被挂起直到 finally 块执行结束 } catch(err) { return 2; } finally { return 3; // 3 先于 1 被返回出乎意料 } })(); // 3示例二finally 中的 return 吞掉 try 中抛出的异常// 我们期望该函数先抛错然后再返回 (() { try { throw new Error(Try); // 错误被抛出但被挂起直到 finally 块执行结束 } finally { return 3; // 3 先于错误被返回出乎意料 } })(); // 3示例三finally 中的 throw 替换 catch 中重新抛出的异常// 我们期望该函数从 catch 块抛出 Try(...) 错误 (() { try { throw new Error(Try) } catch(err) { throw err; // try 块抛出的错误被捕获并重新抛出 } finally { throw new Error(Finally); // 实际抛出的是 Finally(...)出乎意料 } })(); // Uncaught Error: Finally(...)示例四finally 中的 break 打断带标签的 try-finally// 我们期望该函数从 try 块返回 0 (() { label: try { return 0; // 0 被返回但被挂起直到 finally 块执行结束 } finally { break label; // 在 0 被返回之前直接跳出 try-finally 块 } return 1; })(); // 1从以上四个例子可以看出无论try/catch原本打算做什么返回值、抛出异常、重新抛出异常、返回特定值只要finally块中存在直接的控制流语句最终结果都会被finally覆盖。这正是no-unsafe-finally规则要拦截的不安全用法。规则详情禁止哪些写法放行哪些写法no-unsafe-finally规则禁止在finally块中直接使用return、throw、break、continue语句。与此同时规则文档明确说明它允许间接用法——例如嵌套在finally块内部声明的function或class定义中的控制流语句因为这些语句的返回、抛出只影响嵌套函数自身不会覆盖外层try/catch的控制流。错误的代码incorrect/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { return 3; // 错误覆盖了 try/catch 中的 return } };/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { throw new Error; // 错误覆盖了 try/catch 中的控制流 } };正确的代码correct/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { console.log(hola!); // 正确finally 中只做清理工作 } };/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { let a function() { return hola!; // 正确return 位于嵌套函数内部不影响外层 } } };/*eslint no-unsafe-finally: error*/ let foo function(a) { try { return 1; } catch(err) { return 2; } finally { switch(a) { case 1: { console.log(hola!) break; // 正确break 作用于 switch不跳出 try-finally } } } };第三个正确示例值得特别说明finally中的break如果作用于嵌套的循环或 switch 语句并不构成对try/catch控制流的覆盖因此是被允许的。规则是否报错取决于控制流语句的目标作用域是否就是finally块本身详见下文源码分析。Options无配置项no-unsafe-finally没有任何配置选项。在源码 lib/rules/no-unsafe-finally.js 中规则的schema被声明为空数组[]这意味着它只能以error、warn、off三种严重级别开启或关闭无法传入任何参数做行为定制。使用方式非常直接// eslint.config.jsflat config export default [ { rules: { no-unsafe-finally: error, }, }, ];源码实现剖析AST 遍历与哨兵节点算法要理解规则如何区分直接使用与间接使用需要阅读规则的完整实现 lib/rules/no-unsafe-finally.js。规则作者为 Onur Temizkan规则元数据声明其type为problemdocs/src/_data/rules_meta.jsonrecommended为true表明它被列入推荐规则集。三个哨兵节点正则规则定义了一组哨兵节点类型正则lib/rules/no-unsafe-finally.js用于在向上遍历 AST 时确定安全边界const SENTINEL_NODE_TYPE_RETURN_THROW /^(?:Program|(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression)$/u; const SENTINEL_NODE_TYPE_BREAK /^(?:Program|(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression|DoWhileStatement|WhileStatement|ForOfStatement|ForInStatement|ForStatement|SwitchStatement)$/u; const SENTINEL_NODE_TYPE_CONTINUE /^(?:Program|(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression|DoWhileStatement|WhileStatement|ForOfStatement|ForInStatement|ForStatement)$/u;这三组正则对应三种语句的合法作用范围return/throw的合法目标是一个函数体或Program顶层所以遇到Function*、Class*、ArrowFunctionExpression即视为到达安全边界break的合法目标除了函数体外还包括switch和各类循环语句for、while、do-while、for-in、for-ofcontinue的合法目标则只能是循环语句不含switch。向上爬升的 isInFinallyBlock 算法核心函数isInFinallyBlock(node, label)lib/rules/no-unsafe-finally.js从当前语句节点出发沿 AST 的parent链逐级向上遍历根据节点类型是否带label的BreakStatement、ContinueStatement或其他语句选择对应的哨兵正则在遍历过程中若发现某个父节点的label与传入的 label 同名则置labelInside true——表示该break/continue的目标标签位于finally之内因此不构成越界控制流通过isFinallyBlock(currentNode)lib/rules/no-unsafe-finally.js判断当前节点是否为TryStatement的finalizer即 finally 块若命中 finally 块当存在标签且标签目标在 finally 内部时返回false放行否则返回true判定不安全若先遇到哨兵节点则停止爬升并返回false。check 与报告check(node)lib/rules/no-unsafe-finally.js对所有ReturnStatement、ThrowStatement、BreakStatement、ContinueStatement四个节点类型调用isInFinallyBlock一旦确认不安全就通过context.report报告消息Unsafe usage of {{nodeType}}.消息 ID 为unsafeUsage定义于 lib/rules/no-unsafe-finally.js并在报告中附带节点类型、行号与列号。这些 visitor 的注册位于 lib/rules/no-unsafe-finally.js。这套算法巧妙地复用了哨兵节点思想任何嵌套在 finally 内部函数/类/循环/switch 中的控制流语句都会在爬升过程中先撞到自己的合法目标边界从而被判定为安全而直接作用于 finally 块自身的控制流语句则必然在撞到哨兵之前先命中 finally 块的finalizer被判定为不安全。规则在项目中的注册与推荐配置该规则通过 lib/rules/index.js 中的no-unsafe-finally: () require(./no-unsafe-finally)惰性注册为 ESLint 核心规则在 packages/js/src/configs/eslint-recommended.js 中它以no-unsafe-finally: error的形式被纳入eslint:recommended推荐集即使用 ESLint 推荐配置的用户无需额外配置即可获得该检查其规则类型为problem见 docs/src/_data/rules_meta.json表示这类问题极有可能导致运行时 bug属于应优先修复的类别。测试用例验证边界情况的完备覆盖规则的边界行为在测试文件 tests/lib/rules/no-unsafe-finally.js 中被系统性验证其中valid 用例tests/lib/rules/no-unsafe-finally.js覆盖了finally 中仅console.log、嵌套函数声明内的return/throw、嵌套while循环内的break/continue、带标签循环内的break label/continue、switch内的break、do-while内的break、箭头函数与class内的控制流等场景invalid 用例tests/lib/rules/no-unsafe-finally.js覆盖了finally 中直接return、if分支内的return、throw、嵌套try-finally的 finally 中的return、带标签try中的break label、循环包裹的try中 finally 里的break/continue、switch内 finally 的break、跨作用域带标签的break a与continue等场景并精确断言了每条错误消息的messageId、nodeType、行号和列号。从测试断言可以看出规则对带标签语句的处理非常精细例如a: while (true) try {} finally { switch (true) { case true: break a; } }中break a的目标标签a位于 finally 之外指向外层 while因此被判定为不安全而若标签目标在 finally 内部labelInside为 true则会放行。When Not To Use It何时关闭该规则官方文档指出如果你希望允许在finally块中使用控制流语句可以直接关闭此规则。需要特别关注的一个例外场景是生成器函数generator function在生成器中使用return与try/finally配合即Generator.prototype.return()的语义可以用于覆盖生成器即将返回的值——这是一种刻意利用finally覆盖语义的合法特性。如果你确实需要这一生成器特性可以通过在对应代码上方添加eslint-disable注释来局部关闭该规则/* eslint-disable no-unsafe-finally */ function* generator() { try { yield 1; } finally { return 2; // 刻意覆盖生成器的返回值 } } /* eslint-enable no-unsafe-finally */总结no-unsafe-finally是 ESLint 内置的problem类型规则从规则引入CHANGELOG 中记录其由 Onur Temizkan 实现并修复 issue #5808到如今始终面向同一核心问题finally块中的直接控制流语句会静默覆盖try/catch的意图制造难以排查的隐蔽 bug。其源码通过哨兵节点 向上爬升的 AST 算法精确区分了直接作用于 finally 的控制流与嵌套在函数、类、循环、switch 内部的合法控制流并被纳入eslint:recommended默认开启。在日常开发中请坚持finally只做清理、不做决策的编码习惯配合本规则在 CI 阶段拦截不安全的控制流用法。【免费下载链接】eslintFind and fix problems in your JavaScript code.项目地址: https://gitcode.com/GitHub_Trending/es/eslint创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
ESLint no-unsafe-finally 规则详解：阻止 finally 块中的控制流语句破坏异常处理
ESLint no-unsafe-finally 规则详解阻止 finally 块中的控制流语句破坏异常处理【免费下载链接】eslintFind and fix problems in your JavaScript code.项目地址: https://gitcode.com/GitHub_Trending/es/eslint本文基于 ESLint 核心规则no-unsafe-finally的官方文档docs/src/rules/no-unsafe-finally.md及其在仓库中的实现源码、测试用例与推荐配置系统讲解该规则的触发原理、JavaScript 中try/catch/finally的控制流语义、规则源码的 AST 检测算法以及配置与关闭该规则的适用场景。读完本文你将能准确识别finally块中return、throw、break、continue导致的问题理解该规则为何被列入eslint:recommended并能结合源码深入理解其边界情况处理。问题背景finally 中的控制流语句会覆盖 try/catch 的结果JavaScript 规范规定try和catch块中的控制流语句return、throw、break、continue会被挂起suspend直到finally块执行完毕后才继续。因此如果在finally块中直接使用了这四类语句就会覆盖try/catch中已经做出的控制流决策产生与直觉相悖的行为。官方文档用以下四个典型示例揭示了这一语义陷阱。示例一finally 中的 return 覆盖 try 中的 return// 我们期望该函数返回 1 (() { try { return 1; // 1 被返回但被挂起直到 finally 块执行结束 } catch(err) { return 2; } finally { return 3; // 3 先于 1 被返回出乎意料 } })(); // 3示例二finally 中的 return 吞掉 try 中抛出的异常// 我们期望该函数先抛错然后再返回 (() { try { throw new Error(Try); // 错误被抛出但被挂起直到 finally 块执行结束 } finally { return 3; // 3 先于错误被返回出乎意料 } })(); // 3示例三finally 中的 throw 替换 catch 中重新抛出的异常// 我们期望该函数从 catch 块抛出 Try(...) 错误 (() { try { throw new Error(Try) } catch(err) { throw err; // try 块抛出的错误被捕获并重新抛出 } finally { throw new Error(Finally); // 实际抛出的是 Finally(...)出乎意料 } })(); // Uncaught Error: Finally(...)示例四finally 中的 break 打断带标签的 try-finally// 我们期望该函数从 try 块返回 0 (() { label: try { return 0; // 0 被返回但被挂起直到 finally 块执行结束 } finally { break label; // 在 0 被返回之前直接跳出 try-finally 块 } return 1; })(); // 1从以上四个例子可以看出无论try/catch原本打算做什么返回值、抛出异常、重新抛出异常、返回特定值只要finally块中存在直接的控制流语句最终结果都会被finally覆盖。这正是no-unsafe-finally规则要拦截的不安全用法。规则详情禁止哪些写法放行哪些写法no-unsafe-finally规则禁止在finally块中直接使用return、throw、break、continue语句。与此同时规则文档明确说明它允许间接用法——例如嵌套在finally块内部声明的function或class定义中的控制流语句因为这些语句的返回、抛出只影响嵌套函数自身不会覆盖外层try/catch的控制流。错误的代码incorrect/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { return 3; // 错误覆盖了 try/catch 中的 return } };/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { throw new Error; // 错误覆盖了 try/catch 中的控制流 } };正确的代码correct/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { console.log(hola!); // 正确finally 中只做清理工作 } };/*eslint no-unsafe-finally: error*/ let foo function() { try { return 1; } catch(err) { return 2; } finally { let a function() { return hola!; // 正确return 位于嵌套函数内部不影响外层 } } };/*eslint no-unsafe-finally: error*/ let foo function(a) { try { return 1; } catch(err) { return 2; } finally { switch(a) { case 1: { console.log(hola!) break; // 正确break 作用于 switch不跳出 try-finally } } } };第三个正确示例值得特别说明finally中的break如果作用于嵌套的循环或 switch 语句并不构成对try/catch控制流的覆盖因此是被允许的。规则是否报错取决于控制流语句的目标作用域是否就是finally块本身详见下文源码分析。Options无配置项no-unsafe-finally没有任何配置选项。在源码 lib/rules/no-unsafe-finally.js 中规则的schema被声明为空数组[]这意味着它只能以error、warn、off三种严重级别开启或关闭无法传入任何参数做行为定制。使用方式非常直接// eslint.config.jsflat config export default [ { rules: { no-unsafe-finally: error, }, }, ];源码实现剖析AST 遍历与哨兵节点算法要理解规则如何区分直接使用与间接使用需要阅读规则的完整实现 lib/rules/no-unsafe-finally.js。规则作者为 Onur Temizkan规则元数据声明其type为problemdocs/src/_data/rules_meta.jsonrecommended为true表明它被列入推荐规则集。三个哨兵节点正则规则定义了一组哨兵节点类型正则lib/rules/no-unsafe-finally.js用于在向上遍历 AST 时确定安全边界const SENTINEL_NODE_TYPE_RETURN_THROW /^(?:Program|(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression)$/u; const SENTINEL_NODE_TYPE_BREAK /^(?:Program|(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression|DoWhileStatement|WhileStatement|ForOfStatement|ForInStatement|ForStatement|SwitchStatement)$/u; const SENTINEL_NODE_TYPE_CONTINUE /^(?:Program|(?:Function|Class)(?:Declaration|Expression)|ArrowFunctionExpression|DoWhileStatement|WhileStatement|ForOfStatement|ForInStatement|ForStatement)$/u;这三组正则对应三种语句的合法作用范围return/throw的合法目标是一个函数体或Program顶层所以遇到Function*、Class*、ArrowFunctionExpression即视为到达安全边界break的合法目标除了函数体外还包括switch和各类循环语句for、while、do-while、for-in、for-ofcontinue的合法目标则只能是循环语句不含switch。向上爬升的 isInFinallyBlock 算法核心函数isInFinallyBlock(node, label)lib/rules/no-unsafe-finally.js从当前语句节点出发沿 AST 的parent链逐级向上遍历根据节点类型是否带label的BreakStatement、ContinueStatement或其他语句选择对应的哨兵正则在遍历过程中若发现某个父节点的label与传入的 label 同名则置labelInside true——表示该break/continue的目标标签位于finally之内因此不构成越界控制流通过isFinallyBlock(currentNode)lib/rules/no-unsafe-finally.js判断当前节点是否为TryStatement的finalizer即 finally 块若命中 finally 块当存在标签且标签目标在 finally 内部时返回false放行否则返回true判定不安全若先遇到哨兵节点则停止爬升并返回false。check 与报告check(node)lib/rules/no-unsafe-finally.js对所有ReturnStatement、ThrowStatement、BreakStatement、ContinueStatement四个节点类型调用isInFinallyBlock一旦确认不安全就通过context.report报告消息Unsafe usage of {{nodeType}}.消息 ID 为unsafeUsage定义于 lib/rules/no-unsafe-finally.js并在报告中附带节点类型、行号与列号。这些 visitor 的注册位于 lib/rules/no-unsafe-finally.js。这套算法巧妙地复用了哨兵节点思想任何嵌套在 finally 内部函数/类/循环/switch 中的控制流语句都会在爬升过程中先撞到自己的合法目标边界从而被判定为安全而直接作用于 finally 块自身的控制流语句则必然在撞到哨兵之前先命中 finally 块的finalizer被判定为不安全。规则在项目中的注册与推荐配置该规则通过 lib/rules/index.js 中的no-unsafe-finally: () require(./no-unsafe-finally)惰性注册为 ESLint 核心规则在 packages/js/src/configs/eslint-recommended.js 中它以no-unsafe-finally: error的形式被纳入eslint:recommended推荐集即使用 ESLint 推荐配置的用户无需额外配置即可获得该检查其规则类型为problem见 docs/src/_data/rules_meta.json表示这类问题极有可能导致运行时 bug属于应优先修复的类别。测试用例验证边界情况的完备覆盖规则的边界行为在测试文件 tests/lib/rules/no-unsafe-finally.js 中被系统性验证其中valid 用例tests/lib/rules/no-unsafe-finally.js覆盖了finally 中仅console.log、嵌套函数声明内的return/throw、嵌套while循环内的break/continue、带标签循环内的break label/continue、switch内的break、do-while内的break、箭头函数与class内的控制流等场景invalid 用例tests/lib/rules/no-unsafe-finally.js覆盖了finally 中直接return、if分支内的return、throw、嵌套try-finally的 finally 中的return、带标签try中的break label、循环包裹的try中 finally 里的break/continue、switch内 finally 的break、跨作用域带标签的break a与continue等场景并精确断言了每条错误消息的messageId、nodeType、行号和列号。从测试断言可以看出规则对带标签语句的处理非常精细例如a: while (true) try {} finally { switch (true) { case true: break a; } }中break a的目标标签a位于 finally 之外指向外层 while因此被判定为不安全而若标签目标在 finally 内部labelInside为 true则会放行。When Not To Use It何时关闭该规则官方文档指出如果你希望允许在finally块中使用控制流语句可以直接关闭此规则。需要特别关注的一个例外场景是生成器函数generator function在生成器中使用return与try/finally配合即Generator.prototype.return()的语义可以用于覆盖生成器即将返回的值——这是一种刻意利用finally覆盖语义的合法特性。如果你确实需要这一生成器特性可以通过在对应代码上方添加eslint-disable注释来局部关闭该规则/* eslint-disable no-unsafe-finally */ function* generator() { try { yield 1; } finally { return 2; // 刻意覆盖生成器的返回值 } } /* eslint-enable no-unsafe-finally */总结no-unsafe-finally是 ESLint 内置的problem类型规则从规则引入CHANGELOG 中记录其由 Onur Temizkan 实现并修复 issue #5808到如今始终面向同一核心问题finally块中的直接控制流语句会静默覆盖try/catch的意图制造难以排查的隐蔽 bug。其源码通过哨兵节点 向上爬升的 AST 算法精确区分了直接作用于 finally 的控制流与嵌套在函数、类、循环、switch 内部的合法控制流并被纳入eslint:recommended默认开启。在日常开发中请坚持finally只做清理、不做决策的编码习惯配合本规则在 CI 阶段拦截不安全的控制流用法。【免费下载链接】eslintFind and fix problems in your JavaScript code.项目地址: https://gitcode.com/GitHub_Trending/es/eslint创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
