代码写的垃圾被嫌弃？

蔚落 2021-09-07 15:32 281阅读 0赞

今天推荐三个插件，它们都是代码质量检测的神器。可以扫描检测出你项目中不符合规范的代码，他们分别是 SonarLint、SonarQube、Alibaba代码规约插件。

**1.  SonarLint**

SonarLint是一个代码质量检测插件，可以帮助我们检测出代码中的**坏味道。**

![60510767411a57833bad7a4aba8205f3.png][]

**下载与安装**

![d5fc6987d3f1434d5d891a447368ba82.png][]

在需要检测的单个文件或者单个项目上右键 -> Analyze -> Analyze with SonarLint

或者选中文件或目录，点击菜单栏 Analyze -> Analyze with SonarLint

![cee74ecc03b8c37b03ceb917923621ea.png][]

我们还可以禁用某些规则

![2711fb31554218b2d0df60dfdb49283f.png][]

如果需要同步自定义的规则时，可以绑定到 SonarQube

![97ff36f6747a81ada82a9620d89d6d1c.png][]

![26e2bdd187e1db83a248380dd3a8f0c2.png][]

![23c1ee906d61d8f37ed4a405bdd5e6fe.png][]

查看检测的结果

![5f4f84658a2906fc48fa637dad1c26a6.png][]

对于代码中的警告我们不能视而不见

![a834520b25158738c07a515368744d50.png][]

有了代码质量检测工具以后，在一定程度上可以保证代码的质量，对于每一个问题，SonarLint 都给出了示例，还有相应的解决方案，教我们怎么修改，极大的方便了我们的开发。

比如，对于日期类型尽量用 LocalDate、LocalTime、LocalDateTime，还有重复代码、潜在的空指针异常、循环嵌套等等问题。

有了代码规范与质量检测工具以后，很多东西就可以**量化**了，比如bug率、代码重复率等，还可以自定义各种指标，方便管理人员查看。

为此，我们需要一个平台来记录每次检测分析的结果，这样就可以进行分析和统计，并且可以直观的看到这一切

于是，**SonarQube** 闪亮登场！

**2.  SonarQube**

SonarQube 是一个开源的代码质量管理平台

![8c495db6dcf6abf6aae5fe6a42e9dec2.png][]

![a39f2347a06aaafb23feab865b153711.png][]

![8d7450bba7c19a2d0a7da94ca1e7b0c8.png][]

![e81919c1c2970c33cb06fc372726b329.png][]

**解压&本地启动**

具体开始参考文档：

https://docs.sonarqube.org/latest/setup/get-started-2-minutes/

下载下来这个工具，进行解压执行：

unzip sonarqube-7.7.zip
    cd sonarqube-7.7
    bin/[OS]/sonar.sh consol

![74e4e2af5d424ba0f4c5d619730ae704.png][]

启动成功后，访问 http://localhost:9000  用管理员账号（admin/admin）登录

![edd22eb146defb92b04c0769e4a26d8f.png][]

接下来，为了把检测的结果传到服务器，我们需要配置一个Scanner，具体参考文档：

https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Maven

这里我在项目中添加 sonar-maven-plugin 插件

<build>
        <plugins>
            <plugin>
                <groupId>org.sonarsource.scanner.maven</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
                <version>3.6.0.1398</version>
            </plugin>
        </plugins>
    </build>

命令行执行：mvn clean compile **sonar:sonar**

成功后，可以在控制台中看到这样的输出：

![f3fba5cf87cfd6e07a10d0f04d313564.png][]

再次刷新 http://localhost:9000/ 会看到跟刚才不一样了

![2ead40096898d126abc340bde444fc78.png][]

![bf898f2016242c7638b7d94e75400d2a.png][]

![4202b04eb4b0e5a9f0f567135086f413.png][]

以上只是本地演示，在正式环境中这些数据当然要保存到数据库中，具体安装就不演示了，下面是文档：

https://docs.sonarqube.org/latest/setup/install-server/

**3.  Alibaba代码规约插件**

阿里代码规范，相信大家都不陌生。IDEA 中安装这个插件即可，同时如果需要更多优质 IDEA 插件推荐可以关注公众号「Java后端」搜索「IDEA」就可以找到相关的插件推荐文章了。

这是代码规约插件安装方式：

![3375cc865ad2b77577e218060fd59bb5.png][]

安装了此插件，就可以进行扫描，检测出你写的 "坏"代码。

![c0b84d11873976203563f436a7a4f8d1.png][]

看看效果：

![8d383803caa4bb892b658c46c7815385.png][]

作者：废物大师兄

链接：cnblogs.com/cjsblog/p/10735800.html

**4.  文档**

https://www.sonarqube.org/

https://www.sonarsource.com/plans-and-pricing/community/

https://www.sonarlint.org/

https://docs.sonarqube.org/latest/setup/overview/

https://docs.sonarqube.org/latest/

https://github.com/SonarSource/sonar-scanning-examples/tree/master/sonarqube-scanner-maven

https://github.com/SonarSource

[60510767411a57833bad7a4aba8205f3.png]: /images/20210730/5f892e07abfe41c99b7a82d485cadd26.png
[d5fc6987d3f1434d5d891a447368ba82.png]: /images/20210730/bae4afd317804268ab1f2da4d84b3c7b.png
[cee74ecc03b8c37b03ceb917923621ea.png]: /images/20210730/e8994e55341d47dabbcc346821775a74.png
[2711fb31554218b2d0df60dfdb49283f.png]: /images/20210730/e69196ce2da84845bc8e84dee987cdae.png
[97ff36f6747a81ada82a9620d89d6d1c.png]: /images/20210730/2c9a781d6f3d44738654131f7f89b3fd.png
[26e2bdd187e1db83a248380dd3a8f0c2.png]: /images/20210730/5586a7733789430fa08190f401100c5f.png
[23c1ee906d61d8f37ed4a405bdd5e6fe.png]: /images/20210730/234f91af19d74bc3b76cdcc2ddf3823c.png
[5f4f84658a2906fc48fa637dad1c26a6.png]: /images/20210730/ea4dc0c647a549cb83304e73f4d70748.png
[a834520b25158738c07a515368744d50.png]: /images/20210730/e4619a6920704ff786d31632fdc39185.png
[8c495db6dcf6abf6aae5fe6a42e9dec2.png]: /images/20210730/a11261c061cc436a882980218d61d253.png
[a39f2347a06aaafb23feab865b153711.png]: /images/20210730/94797390627c420a96deb3a75dd131ed.png
[8d7450bba7c19a2d0a7da94ca1e7b0c8.png]: /images/20210730/3b06c9f4956640279191febad26d0381.png
[e81919c1c2970c33cb06fc372726b329.png]: /images/20210730/9b91d4a00415466886a6c56420dbe573.png
[74e4e2af5d424ba0f4c5d619730ae704.png]: /images/20210730/96ceb19806014730bfea3bedc79d101c.png
[edd22eb146defb92b04c0769e4a26d8f.png]: /images/20210730/cc2c285523824b65ba2895f0aa9a808f.png
[f3fba5cf87cfd6e07a10d0f04d313564.png]: /images/20210730/77faa2e6beee49c4b335ed4add6681cf.png
[2ead40096898d126abc340bde444fc78.png]: /images/20210730/89b208703067476e83b5de72f633d09b.png
[bf898f2016242c7638b7d94e75400d2a.png]: /images/20210730/7442651830c8459f8eb445c1b12eee8f.png
[4202b04eb4b0e5a9f0f567135086f413.png]: /images/20210730/07db82889da94b96ada4ac68df41a270.png
[3375cc865ad2b77577e218060fd59bb5.png]: /images/20210730/1fa4e61eb8c54206979323383b181630.png
[c0b84d11873976203563f436a7a4f8d1.png]: /images/20210730/081164e916fc45eca3992755e9e42090.png
[8d383803caa4bb892b658c46c7815385.png]: /images/20210730/ae35a84a4e744d5783ad5328953d3ecd.png