java代码审查过关的一次总结

不念不忘少年蓝@ 2023-10-13 11:22 48阅读 0赞

1.  \*\*1.for循环中的逻辑都抽出一个方法并且把重要逻辑抽出一个方法 ![在这里插入图片描述][bd51a73eeaad47ceb81b16c9c4820a45.png]  
    2.参数比较多合并成一个对象 ![在这里插入图片描述][0de7e0922e084d5f833cb830832370fd.png]  
    3.避免没必要的if else 例如if判断能直接return就return,避免没必要的else
    
    4.检查代码中是否包含适当的注释，解释代码的目的、实现细节和注意事项。  
    5.代码格式和命名规范： 检查代码的缩进、空格、换行等格式是否符合规范。变量、方法和类的命名是否清晰、易懂且符合命名约定  
    6.注入的@Resource从短到长对齐 让人看着的舒服\*\*

**说的再好也没有用组件排查一下规范在哪,这里介绍一下两个比较强大的组件**  
**SonarLint**是一款由SonarSource提供的插件，可与IDE集成，用于实时检查Java、JavaScript、Python等多种编程语言的代码。它使用SonarSource团队开发的规则集，检查代码中的代码质量、安全性和可维护性等方面的问题。SonarLint会根据代码的质量规则和建议，给出实时的反馈和建议，以帮助开发人员改进代码。

**阿里巴巴组件扫描**（也称为P3C规约）是阿里巴巴Java开发团队提供的一套代码规范和检查工具。它包含了一系列针对Java开发的最佳实践和规约，旨在提高代码的可读性、可维护性和可靠性。阿里巴巴组件扫描工具可以通过在构建过程中执行静态分析来检查代码，并提供有关潜在问题和违规的警告和建议。

以下是一些常见的固定格式示例，用于在SonarLint和阿里巴巴组件扫描中检查和修复代码问题：

命名规范：

使用有意义和清晰的变量、方法和类命名。  
遵循驼峰命名法或其他约定。  
避免使用缩写或不明确的命名。  
代码格式：

使用一致的缩进和空格，例如使用4个空格进行缩进。  
每行代码应适当换行，避免过长的行。  
在代码块、方法和类之间使用适当的空行来提高可读性。  
注释规范：

在关键代码处添加注释，解释其目的和实现细节。  
使用清晰、简洁的注释，避免冗长的注释。  
使用Javadoc注释来描述类、方法和参数。  
异常处理：

在合适的地方捕获和处理异常。  
避免空的catch块，应该至少记录或抛出异常。  
尽量使用特定的异常类型，避免捕获通用的Exception类型。  
安全性和漏洞修复：

避免使用不安全的函数或方法，如直接执行SQL查询、拼接SQL语句等。  
防止跨站脚本攻击（XSS）和跨站请求伪造（CSRF）等

[bd51a73eeaad47ceb81b16c9c4820a45.png]: https://img-blog.csdnimg.cn/bd51a73eeaad47ceb81b16c9c4820a45.png
[0de7e0922e084d5f833cb830832370fd.png]: https://img-blog.csdnimg.cn/0de7e0922e084d5f833cb830832370fd.png