工程师专属 | 技术影响力之代码审查

▌ 技术引导 代码审查是工程师必须掌握的技能，不是形式主义的流程，是技术决策的直接体现。我在多个项目中发现，代码审查的深度决定系统质量，而浅层走流程反而掩盖真实问题。比如，使用`git blame`快速定位代码历史，配合`diff`工具对比修改内容，可以精准找到问题源头。审查时要关注`commit message`是否清晰，是否包含`fix`、`enhance`等关键词，避免模糊表述。另外，`eslint`和`pre-commit`钩子可以自动拦截格式错误，但不是万能的，需要人工校验关键逻辑。例如，`eslint --fix`只能解决格式问题，逻辑错误仍需人工检查。 在实际操作中，我见过团队因为未审查`import`语句导致依赖冲突，最终需要重写模块。还有因为忽略`type annotations`引发类型错误，浪费数小时排查。审查时要强制检查`static type checking`，比如使用`TypeScript`的`tsconfig.json`中设置`strict`为`true`，确保类型安全。另外，`SonarQube`这样的静态分析工具可以标记`code smells`和`bugs`，但只能作为参考，不能替代人工判断。 我常用`git diff --cached`来审查即将提交的更改，而不是`git diff`。前者只显示已经暂存的修改，后者包括工作目录的更改，容易被无关内容干扰。针对复杂逻辑，可以使用`coverage`工具检查代码覆盖率，比如`nyc --reporter=text-summary`输出简洁结果。审查时要关注`branch coverage`和`statement coverage`，确保关键路径被测试覆盖。 在团队协作中，我坚持`code review`必须由不同人完成，比如前端开发者审查后端逻辑，反之亦然。这样能发现跨团队的潜在问题。另外，审查时要强制要求`PR description`必须包含`what`、`why`、`how`三个维度说明。例如：`what`是变更内容，`why`是解决的问题，`how`是实现方式。这能避免不必要的讨论。 代码审查的核心是减少未来维护成本，而不是单纯找错。我见过很多项目因为未审查`code duplication`导致后续修改时反复出错。使用`jscpd`检查重复代码，能在`10秒内`输出重复块，效率极高。另外，`Prettier`配合`husky`能自动格式化代码，避免格式问题，但某些`ESLint`规则可能与`Prettier`冲突，需要手动调整配置。 ▌ 技术参考 代码审查是工程师必备技能，直接决定系统稳定性与可维护性。我在实际项目中发现，审查流程不规范会导致严重问题，如`dependency version mismatch`或`memory leak`。使用`git blame`快速定位代码变更历史，配合`diff`工具对比修改内容，能精准找到问题源头。例如，`git blame -L 10,20 filename.js`可以只审查第10到20行代码，提升效率。 审查时要强制检查`commit message`是否清晰，是否包含`fix`、`enhance`等关键词。模糊的`commit message`如`Update something`无法指导后续维护。使用`git log --oneline`快速查看提交历史，确保每个`commit`都有明确目标。此外，设置`husky`的`pre-commit`钩子，可以拦截格式错误，例如`npx husky add .husky/pre-commit "npx eslint --fix"`。但`eslint --fix`只能处理格式问题，逻辑错误仍需人工检查。 在实际操作中，我见过团队因为未审查`import`语句导致依赖冲突。例如，使用`npm install`时未检查`package-lock.json`，造成`version mismatch`。审查时应确保`import`路径正确，且依赖版本符合`package.json`。使用`npx nx affected`检查受影响文件，能快速定位需要审查的部分。另外，`TypeScript`的`tsconfig.json`中设置`strict`为`true`，能有效拦截类型错误，例如`strict: true`启用`strictNullChecks`、`strictFunctionTypes`等规则。 审查过程中，`static type checking`是关键环节。我见过很多项目因为未使用`TypeScript`导致`type errors`，例如`Array`被误用为`Array`。使用`TypeScript`的`type inference`和`type annotations`能显著减少此类错误。例如，在`tsconfig.json`中设置`strict: true`，确保类型安全。此外，使用`SonarQube`这样的工具，可以标记`code smells`和`bugs`，例如`SonarQube`会指出`unused variables`或`dead code`，但只能作为参考，不能替代人工判断。 针对复杂逻辑，使用`coverage`工具检查代码覆盖率是有效手段。例如，`nyc --reporter=text-summary`输出简洁结果，但需确保`branch coverage`和`statement coverage`达到`90%`以上。在`nyc`配置中，设置`exclude`排除`test`文件，避免干扰结果。例如，`exclude: ['/.test.ts', '/.spec.ts']`可以过滤测试代码。此外，审查时应关注`edge cases`，例如`null`或`undefined`的处理，避免运行时错误。 在团队协作中，我坚持`code review`必须由不同人完成，例如前端开发者审查后端逻辑，反之亦然。这样能发现跨团队的潜在问题。使用`GitHub`或`GitLab`的`pull request`功能，设置`required reviews`和`approval rules`，确保多人参与。例如，`required reviews`设置为`2`，避免单人决策。此外，`PR description`必须包含`what`、`why`、`how`三个维度说明，例如`what`是变更内容，`why`是解决的问题，`how`是实现方式。这能避免不必要的讨论。 我常用`git diff --cached`来审查即将提交的更改，而不是`git diff`。后者包括工作目录更改，容易被无关内容干扰。例如，在`git commit`前运行`git diff --cached`，检查所有暂存文件是否符合规范。此外，使用`git diff HEAD~1`对比上一次提交，确保修改内容准确。审查时要关注`code structure`是否合理，例如`function`是否封装得当，`logic flow`是否清晰。 使用`jscpd`检查重复代码是高效手段。例如，`jscpd --config jscpd.json`能快速发现重复块，命令输出包含`file`、`start`、`end`位置信息。在`jscpd.json`中设置`min-lines`为`5`，避免误报。此外，`Prettier`配合`husky`能自动格式化代码，例如`npx husky add .husky/pre-commit "npx prettier --write ."`。但某些`ESLint`规则可能与`Prettier`冲突，需要手动调整配置，例如在`.eslintrc.js`中设置`overrides`，排除`prettier`规则。 审查时要强制检查`code duplication`，例如使用`jscpd --config jscpd.json`输出报告，重点关注`duplicate blocks`。在`jscpd.json`中设置`max-lines`为`10`，确保只处理有意义的重复。此外，使用`eslint --fix`只能处理格式问题，逻辑错误仍需人工检查。例如，`eslint --fix`可能无法识别`TypeScript`中的类型错误，需要手动调整。 代码审查的核心是减少未来维护成本，而不是单纯找错。我见过很多项目因为未审查`code duplication`导致后续修改时反复出错。例如，一个模块被`copy-paste`到多个文件，最终修改时遗漏一处，引发`bug`。使用`jscpd`检查重复代码，能快速发现此类问题。例如，`jscpd --config jscpd.json`输出重复块信息，定位到具体位置。此外，使用`TypeScript`的`tsconfig.json`设置`strict`为`true`，能有效拦截类型错误，例如`strict: true`启用`strictNullChecks`、`strictFunctionTypes`等规则。 针对复杂逻辑，我建议使用`coverage`工具检查代码覆盖率。例如，`nyc --reporter=text-summary`输出简洁结果，但需确保`branch coverage`和`statement coverage`达到`90%`以上。在`nyc`配置中，设置`exclude`排除`test`文件，避免干扰结果。例如，`exclude: ['/.test.ts', '/.spec.ts']`可以过滤测试代码。此外，审查时应关注`edge cases`，例如`null`或`undefined`的处理，避免运行时错误。 在团队协作中，我坚持`code review`必须由不同人完成，例如前端开发者审查后端逻辑，反之亦然。这样能发现跨团队的潜在问题。使用`GitHub`或`GitLab`的`pull request`功能，设置`required reviews`和`approval rules`，确保多人参与。例如，`required reviews`设置为`2`，避免单人决策。此外，`PR description`必须包含`what`、`why`、`how`三个维度说明，例如`what`是变更内容，`why`是解决的问题，`how`是实现方式。这能避免不必要的讨论。 我常用`git diff --cached`来审查即将提交的更改，而不是`git diff`。后者包括工作目录更改，容易被无关内容干扰。例如，在`git commit`前运行`git diff --cached`，检查所有暂存文件是否符合规范。此外，使用`git diff HEAD~1`对比上一次提交，确保修改内容准确。审查时要关注`code structure`是否合理，例如`function`是否封装得当，`logic flow`是否清晰。 使用`jscpd`检查重复代码是高效手段。例如，`jscpd --config jscpd.json`能快速发现重复块，命令输出包含`file`、`start`、`end`位置信息。在`jscpd.json`中设置`min-lines`为`5`，避免误报。此外，`Prettier`配合`husky`能自动格式化代码，例如`npx husky add .husky/pre-commit "npx prettier --write ."`。但某些`ESLint`规则可能与`Prettier`冲突，需要手动调整配置，例如在`.eslintrc.js`中设置`overrides`，排除`prettier`规则。 代码审查时，`static analysis`工具是重要辅助。比如，`SonarQube`可以标记`code smells`和`bugs`，例如`unused variables`或`dead code`。但要注意`SonarQube`的`false positives`问题，例如`unused variables`可能因为`type inference`误报。使用`SonarQube`时，需手动验证`issue`是否真实存在。此外，`TypeScript`的`type inference`能减少`type annotations`的冗余，但需注意`strictTypeChecking`可能导致`type errors`，需要人工调整。 针对复杂逻辑，我建议使用`coverage`工具检查代码覆盖率。例如，`nyc --reporter=text-summary`输出简洁结果，但需确保`branch coverage`和`statement coverage`达到`90%`以上。在`nyc`配置中，设置`exclude`排除`test`文件，避免干扰结果。例如，`exclude: ['/.test.ts', '/.spec.ts']`可以过滤测试代码。此外，审查时应关注`edge cases`，例如`null`或`undefined`的处理，避免运行时错误。 在团队协作中，我坚持`code review`必须由不同人完成，例如前端开发者审查后端逻辑，反之亦然。这样能发现跨团队的潜在问题。使用`GitHub`或`GitLab`的`pull request`功能，设置`required reviews`和`approval rules`，确保多人参与。例如，`required reviews`设置为`2`，避免单人决策。此外，`PR description`必须包含`what`、`why`、`how`三个维度说明，例如`what`是变更内容，`why`是解决的问题，`how`是实现方式。这能避免不必要的讨论。 我常用`git diff --cached`来审查即将提交的更改，而不是`git diff`。后者包括工作目录更改，容易被无关内容干扰。例如，在`git commit`前运行`git diff --cached`，检查所有暂存文件是否符合规范。此外，使用`git diff HEAD~1`对比上一次提交，确保修改内容准确。审查时要关注`code structure`是否合理，例如`function`是否封装得当，`logic flow`是否清晰。 使用`jscpd`检查重复代码是高效手段。例如，`jscpd --config jscpd.json`能快速发现重复块，命令输出包含`file`、`start`、`end`位置信息。在`jscpd.json`中设置`min-lines`为`5`，避免误报。此外，`Prettier`配合`husky`能自动格式化代码，例如`npx husky add .husky/pre-commit "npx prettier --write ."`。但某些`ESLint`规则可能与`Prettier`冲突，需要手动调整配置，例如在`.eslintrc.js`中设置`overrides`，排除`prettier`规则。 代码审查时，`static analysis`工具是重要辅助。比如，`SonarQube`可以标记`code smells`和`bugs`，例如`unused variables`或`dead code`。但要注意`SonarQube`的`false positives`问题，例如`unused variables`可能因为`type inference`误报。使用`SonarQube`时，需手动验证`issue`是否真实存在。此外，`TypeScript`的`type inference`能减少`type annotations`的冗余，但需注意`strictTypeChecking`可能导致`type errors`，需要人工调整。 针对复杂逻辑，我建议使用`coverage`工具检查代码覆盖率。例如，`nyc --reporter=text-summary`输出简洁结果，但需确保`branch coverage`和`statement coverage`达到`90%`以上。在`nyc`配置中，设置`exclude`排除`test`文件，避免干扰结果。例如，`exclude: ['/.test.ts', '/.spec.ts']`可以过滤测试代码。此外，审查时应关注`edge cases`，例如`null`或`undefined`的处理，避免运行时错误。