Java代码规范和质量检查插件-SonarLint安装与使用

小咪咪 2022-06-02 09:49 1085阅读 0赞

# sonarlint介绍： #

代码质量管理的开源平台，用于管理源代码的质量 通过插件形式，可以支持包括java,C\#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测。集成了CheckStyle，PMD，Findbugs等工具校验规则，具有重复代码发现，代码测试覆盖率，代码注释率，及所有的检测率变化追踪的功能特性。

## **特点** ##

SonarQube:开源的代码质量管控平台，我们使用的http://localhost:9000即为SonarQube。

SonarLint:一个扩展插件，可以安装在idea与eclipse等开发工具中

*   *  当打开java文件时可自动分析静态文件，也可以手动对整个项目做分析；
     *  可连接到SonarQube同步分析规则、质量规则与自定义设置；
     *  目前eclipse为3.2.0版本，Idea为3.0.0版本，**要求JDK为1.8版本。（1.8以下会导致）**

注：

*   *  sonarLint要求JDK 1.8主要是在使用mvn sonar:sonar运行解析时需要，为SonarQube服务；
     *  如果只为检测静态代码可使用JDK任意版本，sonarLint向下兼容；
     *  建议本地JDK与运行服务器保持一致，sonarLint针对不同版本JDK有不同的检验规则；
     *  IDEA自带分析结合sonarLint能够使代码更加规范。

# Eclipse中的安装与使用 #

##   安装 ##

help -> eclipse marketplace...，搜索sonarlint,Install。

### **安装方式一：在线安装** ###

1）Eclipse工具栏选择Help->Eclipse MarketPlace

![Center][]

2）弹出EclipseMarketPlace界面，在Find栏输入sonar就能够搜索出sonar相关的插件，选择SonarLint2.0.0,Install->Confirm->选择允许协议\->Finish

![Center 1][]

![Center 2][]

![Center 3][]

3）成功安装后，会弹出“Software Updates”界面提示须要重新启动Eclipse使安装生效，点击“Yes”。重新启动之后就能够使用了。

![Center 4][]

### **安装方式二：离线安装** ###

1）下载离线安装包：

[https://bintray.com/sonarsource/SonarLint-for-Eclipse/releases/2.0.0/view(这是官网下载地址)][https_bintray.com_sonarsource_SonarLint-for-Eclipse_releases_2.0.0_view]

![Center 5][]

2）在Eclipse菜单条中找到Help栏，选择Help->InstallNew Software

![Center 6][]

3）弹出Install界面，点击“Add”，弹出“AddRepository”界面，自己定义一个name。点击Archive。选择已下载的zip文件，点击OK进行安装。

![Center 7][]

4）选择选择所有组件，点击next会进行对应的检查。

![Center 8][]

![Center 9][]

5）选择允许协议，点击“Finish”开始安装

![Center 10][]

6）等待一段时间。成功安装后，会弹出“Software Updates”界面提示须要重新启动Eclipse使安装生效。点击“Yes”，重新启动之后就能够使用了。

![Center 11][]

##    使用 ##

*   *  打开java文件，soanrlint会自动进行检测，对于不规范或有问题的代码会在下方划蓝色波浪线，如图：
    
    ![sonarlint在eclipse中的错误提示.png][sonarlint_eclipse_.png]

鼠标放在蓝色部分会有弹框显示错误信息或建议修改信息

点击“open description of rule”可以查看具体的错误描述，错误示例及修改示例。

*   *  在项目或单个java文件上右键 -> sonarlint -> Analyze 进行手动操作分析。这样SonarLint Report面板中查看所有的异常信息。

##   Server ##

非必须，无特殊自定义检验规则不需此操作。

连接SonarQube的主要目的是同步分析规则、质量规则与自定义设置。操作如下：

*   *  从Window -> show view 中找到SonarQube Servers打开；
     *  在该面板空白处 右键创建 server连接，选择SonarQube，url为：http://localhost:9000；使用UserName+Password登陆（如 admin账户）。
     *  在项目上右键 SonarLint -> bind to a SonarQube project，选择对应的SonarQube,选择需要绑定的项目，然后点击“Auto bind selected projects”，如果显示失败可进行手动填写，如图：
        
        ![sonarlint在eclipse中项目绑定.png][sonarlint_eclipse_.png 1]

##   结果同步SonarQube显示 ##

在maven的settings.xml中配置如下：

![maven的settings.xml中配置.png][maven_settings.xml_.png]

配置完成后，使用soanr:sonar命令运行项目，此部分要求JDK为1.8。

# **IDEA中使用** #

##   安装 ##

File -> settings -> plugins 搜索sonarLint，目前IDEA中最新版本为3.0.0,Install。

##   使用 ##

*   *  在左下角点击隐藏面板，可以看到sonarLint，打开；
     *  打开java文件，soanrlint会自动进行检测，对于不规范或有问题的代码会添加暗金色的背景色，鼠标放上去会有如图提示：
        
        ![sonarlint在idea中错误提示.png][sonarlint_idea_.png]

点击“more”可以查看具体的错误描述，错误示例及修改示例。

另外在sonarLint面板中会同步显示该文件中的所有问题，可通过双击问题查看具体信息和定位错误代码。如图：

![sonarlint在idea中错误查看.png][sonarlint_idea_.png 1]

也可以通过点击上图的绿色倒三角手动执行分析。

##    Server ##

非必须，无特殊自定义检验规则不需此操作

连接SonarQube的主要目的是同步分析规则、质量规则与自定义设置。操作如下：

*   *  从File -> settings -> OtherSettings中找到“SonarLint General Settings”打开；
     *  点击加号，输入一个name，如lego;选择SonarQube，Url为http://localhost9000；选择Login/Password，输入账号与密码（如lego账户）；finish。
     *  在OtherSettings中找到“SonarLint Project Settings”进行项目bind，如图所示：
        
        ![sonarlint在idea中项目绑定.png][sonarlint_idea_.png 2]

勾选“Enable binding to remote SonarQube Server”,选择添加的server,搜索到你需要绑定的项目，然后选择确认。

##  结果同步SonarQube显示 ##

同Eclipse部分，此部分要求JDK为1.8。

参考： [http://www.onstepr.com/posts/77/][http_www.onstepr.com_posts_77]

[  https://www.cnblogs.com/liguangsunls/p/7365840.html][_https_www.cnblogs.com_liguangsunls_p_7365840.html]

[Center]: /images/20220602/d8f879f98e4c4a8281a92af8c64a471c.png
[Center 1]: /images/20220602/4b49317e4be848afbf01ab0daeac88b1.png
[Center 2]: /images/20220602/b6f87703cc074cfdb8623ee5fa89c983.png
[Center 3]: /images/20220602/61361cd6e66d4bf988e67202b2502236.png
[Center 4]: /images/20220602/e4b096b3db094ec1aefa45048df7f834.png
[https_bintray.com_sonarsource_SonarLint-for-Eclipse_releases_2.0.0_view]: https://bintray.com/sonarsource/SonarLint-for-Eclipse/releases/2.0.0/view%28%E8%BF%99%E6%98%AF%E5%AE%98%E7%BD%91%E4%B8%8B%E8%BD%BD%E5%9C%B0%E5%9D%80%29
[Center 5]: /images/20220602/46713955bfff421ca43e09f21ef23231.png
[Center 6]: /images/20220602/15c51942a9044341940c6a624c99d102.png
[Center 7]: /images/20220602/0c3ff16567564d549d9343258d9c9c74.png
[Center 8]: /images/20220602/a96d37406406486190483a136084ab0d.png
[Center 9]: /images/20220602/cd6ee9c4bfa64001b60c4cde996d5725.png
[Center 10]: /images/20220602/486ab8f83e15437083a2fd2bdb81fc0b.png
[Center 11]: /images/20220602/928949b6e77b4bc0942ccc50996a4f56.png
[sonarlint_eclipse_.png]: http://www.onstepr.com/post/uploads/2017/09/sonarlint%E5%9C%A8eclipse%E4%B8%AD%E7%9A%84%E9%94%99%E8%AF%AF%E6%8F%90%E7%A4%BA.png
[sonarlint_eclipse_.png 1]: http://www.onstepr.com/post/uploads/2017/09/sonarlint%E5%9C%A8eclipse%E4%B8%AD%E9%A1%B9%E7%9B%AE%E7%BB%91%E5%AE%9A.png
[maven_settings.xml_.png]: http://www.onstepr.com/post/uploads/2017/11/maven%E7%9A%84settings.xml%E4%B8%AD%E9%85%8D%E7%BD%AE.png
[sonarlint_idea_.png]: http://www.onstepr.com/post/uploads/2017/09/sonarlint%E5%9C%A8idea%E4%B8%AD%E9%94%99%E8%AF%AF%E6%8F%90%E7%A4%BA.png
[sonarlint_idea_.png 1]: http://www.onstepr.com/post/uploads/2017/09/sonarlint%E5%9C%A8idea%E4%B8%AD%E9%94%99%E8%AF%AF%E6%9F%A5%E7%9C%8B.png
[sonarlint_idea_.png 2]: http://www.onstepr.com/post/uploads/2017/09/sonarlint%E5%9C%A8idea%E4%B8%AD%E9%A1%B9%E7%9B%AE%E7%BB%91%E5%AE%9A.png
[http_www.onstepr.com_posts_77]: http://www.onstepr.com/posts/77/
[_https_www.cnblogs.com_liguangsunls_p_7365840.html]: https://www.cnblogs.com/liguangsunls/p/7365840.html