这款IDEA插件让你的Java代码质量提升10倍

古城微笑少年丶 2023-01-10 05:06 33阅读 0赞

## 你知道的越多，不知道的就越多，业余的像一棵小草！ ##

你来，我们一起精进！你不来，我和你的竞争对手一起精进！

## 编辑：业余草 ##

## cnblogs.com/0201zcr/p/6722932.html ##

## 推荐：https://www.xttblog.com/?p=5144 ##

# **1、目标**    #

#  #

idea集成sonar的代码检查，实现可以在提交代码前就检查你的代码，而不是将代码提交之后，之后再去检查。

Sonar可以从以下七个维度检测代码质量，而作为开发人员至少需要处理前5种代码质量问题

1、不遵循代码标准 sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写

2、潜在的缺陷 sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检测出潜在的缺陷

3、糟糕的复杂度分布 文件、类、方法等，如果复杂度过高将难以改变，这会使得开发人员难以理解它们 且如果没有自动化的单元测试，对于程序中的任何组件的改变都将可能导致需要全面的回归测试

4、重复 显然程序中包含大量复制粘贴的代码是质量低下的，sonar可以展示源码中重复严重的地方

5、注释不足或者过多 没有注释将使代码可读性变差，特别是当不可避免地出现人员变动时，程序的可读性将大幅下降 而过多的注释又会使得开发人员将精力过多地花费在阅读注释上，亦违背初衷

6、缺乏单元测试 sonar可以很方便地统计并展示单元测试覆盖率

7、糟糕的设计 通过sonar可以找出循环，展示包与包、类与类之间相互依赖关系，可以检测自定义的架构规则 通过sonar可以管理第三方的jar包，可以利用LCOM4检测单个任务规则的应用情况， 检测耦合。

# **2、前提** #

*  已经搭建了sonarqube
 *  jdk8环境（我的是jdk7，运行也没问题）

# **3、安装插件** #

设置——>Plugins中查找sonarLint插件，并安装。 **安装完成后，要重启IDEA** 。

![format_png][]

# **4、配置项目**    #

#  #

## 1）配置服务器 ##

我这里是编辑形式打开的弹窗，第一次添加时，是需要自己添加自己使用的sonar平台地址，一般是公司内部搭建的地址

![format_png 1][]

![format_png 2][]

## 2）选择项目 ##

上面配置好服务器的信息之后，就会获取到相应项目的信息，如下:

![format_png 3][]

配置完成后，在当前项目环境下，idea的左下角就可以看到sonar扩展了：

![format_png 4][]

# **5、运行** #

![format_png 5][]

如果你们公司内部没有 Sonar 也没关系，阿里的 Alibaba Java Coding Guidelines 插件推荐给你。

Alibaba Java Coding Guidelines 插件是阿里巴巴在首次发布java开发手册后，时隔一年终于推出了IDEA的代码检查插件。

下面我简单说一下它的安装步骤。打开 IDEA，选择 File - Settings - Plugins - Browse repositories 后，输入 alibaba 选中 Alibaba Java Coding Guidelines，点击 Install。（MacOs系统：选择 IntelliJ IDEA- Preferences …  - Plugins - Browse repositories）

![format_png 6][]

此处 第4步，因为我已经安装了，所以没显示 install。

然后我们重启IDEA，开始使用扫描   Tools - 阿里编码规约。

(1)  Tools - 阿里编码规约

![format_png 7][]

如果需要对某个文件夹或者类进行扫描,  选择类或文件夹右击。

![format_png 8][]

扫描结果分析显示的是中文内容，而且还有纠正案例。

![format_png 9][]

![format_png 10][]

[format_png]: /images/20221119/ae61a229564f41fbad4e85f438dbae48.png
[format_png 1]: /images/20221119/6fcb379bd35c477ca750a50c8cf7e88b.png
[format_png 2]: /images/20221119/9e4d808db73044479b7e46dc202371d3.png
[format_png 3]: /images/20221119/4a0e4ffa606f450482f158e6327a7487.png
[format_png 4]: /images/20221119/7e14c2dfdbd64c7d87aace626825286d.png
[format_png 5]: /images/20221119/f9e5ddfa34ab4dce936609d743729d24.png
[format_png 6]: /images/20221119/dbdbda80ff064f9291dd933b8bcb334a.png
[format_png 7]: /images/20221119/7470d951fc00480287587ba0fc1b8fda.png
[format_png 8]: /images/20221119/7ad9bdfdf683463e887a303bc17e7a07.png
[format_png 9]: /images/20221119/228ad395f01241e6952c1c2118b4e4e3.png
[format_png 10]: /images/20221119/1df69dc1462145de942d86e7e8e4f8fe.png