Code Quality Q&A With the JetBrains Qodana Team

代码质量问答 | JetBrains Qodana

Qodana

面向团队的代码质量平台

关注

• 关注：

• X X

• RSS RSS

获取 Qodana

与 JetBrains Qodana 团队的代码质量问答

Kerry Beetge

代码质量受到无数决策的影响，从开发人员如何管理复杂度到他们检测回归的速度。但诸如技术债务、认知复杂度和单元测试等常见概念并不总是被清晰理解。

在新的代码质量问答环节中，我们邀请 Qodana 团队成员回答了一些关于如何保持代码质量的常见问题。以下是他们的简洁实用解释。

目录

技术债务与差代码质量的区别是什么？

“差代码质量描述代码本身，而技术债务描述一种会产生未来工作量的妥协。例如，'让我们直接使用硬编码值而不是配置，只是因为我们需要尽快完成概念验证（POC）' 是有意为之的技术债务。相比之下，'我不知道为什么需要使用配置，这就是为什么我硬编码值' 是由于知识缺乏导致的差代码质量。技术债务可能导致差代码质量，但差代码质量并不总是由技术债务引起。” – Alexandr Kugushev

如何最小化深层嵌套循环中的认知复杂度？

“最小化嵌套循环复杂度的最佳实践是避免使用嵌套循环：提取函数、再次检查条件（也许可以通过不同的逻辑规则简化它们）、显式命名中间结果、使用迭代器、生成器、map、filter、reduce 函数，处理前尝试展平数据等。” – Anastasia Lavrenko

内聚与耦合的区别是什么？它们如何影响可维护性？

“代码覆盖率和突变测试服务于不同但相关的目的。代码覆盖率衡量单元测试执行了多少生产代码。突变测试通过故意对代码进行小幅修改并检查测试是否能检测到这些修改，来评估测试的质量。如果测试仍然通过，突变体存活下来，这表明测试套件可能存在漏洞。没有普遍理想的突变得分，因为结果因项目和测试策略而异。然而，40-60% 的得分通常被认为是合理的起始范围。更高的得分可能表明测试套件更强，但目标应是实现有意义的测试质量，而不是达到特定数值。” – Aleksander Movsesov

单元测试在维护质量标准中扮演什么角色？

“单元测试能提供对代码更改最快的反馈。通过隔离测试单个行为单元，它们能在问题出现的附近快速发现回归，使重构更安全，并确认代码继续按预期运行。” – Arman Ayvazyan

如何跟踪代码质量是否真正提升？

“我认为跟踪代码质量是否真正提升的最佳方式是观察随时间的变化趋势。静态分析可以提供信号，例如新引入的问题数量、这些问题的严重程度，以及技术债务是增加还是减少。但你也应该能够看到静态分析之外的影响。

如果代码质量在提升，你应该会发现进入生产环境的严重级别1问题越来越少，而当问题发生时平均故障修复时间（MTTR）也会更快。这能让你更清楚地了解所做的更改是否真正提升了软件的质量和可靠性。” – Alex Costa

如何消除自动化漏洞扫描流水线中的误报？

“首先，我们需要区分漏洞扫描和静态分析。Qodana所做的并不总是漏洞扫描——它发现的许多问题无法被第三方利用。当然，Qodana确实能发现漏洞，但它同样能发现普通错误、危险函数、死代码等。

话虽如此，无论问题类型如何，消除误报的方法都类似——通过为使用的工具提供更多信息来实现。最常见的误报情况是自动化工具不了解你有意以特定方式编写代码，例如当你与既定实践存在分歧时，或者当你使用语言的旧标准而该标准不支持更安全的替代方案时，或者当你因第三方依赖而被迫采用不安全的代码模式时。

所有这些问题都可以解决：对于整个仓库范围的误报，可以在qodana.yaml中排除相关检查。对于代码中的单行或代码块，可以使用注释显式静默检查，例如// NOLINT(<INSPECTION ID>)和// NOLINTNEXTLINE(<INSPECTION ID>)”。 – Anna Zhukova

保持代码质量需要的不仅仅是修复个别问题。团队需要有意识地做出技术权衡，保持代码的可理解性，并建立快速反馈机制以尽早发现问题。

自动化代码分析可以通过持续识别质量问题，并帮助团队在整个开发过程中应用一致的标准来支持这些实践。使用Qodana，团队可以将JetBrains的检查功能引入CI/CD流水线，在问题变得难以解决且成本更高之前提前处理。

不要错过下一次代码质量问答

需要解答您最紧迫的代码质量和安全问题吗？在下方评论留下问题参与下一轮讨论，或了解Qodana如何帮助您保障和提升代码库。

请求代码质量演示

• 分享

• Facebook

• Twitter

• LinkedIn

上一篇

公共部门软件项目中的代码合规性 /