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

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。

           

安装方式一:在线安装

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


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

Java代码规范和质量检查插件-SonarLint安装与使用_第1张图片

 


 


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

Java代码规范和质量检查插件-SonarLint安装与使用_第2张图片 

安装方式二:离线安装

1)下载离线安装包:

https://bintray.com/sonarsource/SonarLint-for-Eclipse/releases/2.0.0/view(这是官网下载地址)


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


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


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

Java代码规范和质量检查插件-SonarLint安装与使用_第3张图片

 

Java代码规范和质量检查插件-SonarLint安装与使用_第4张图片

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


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

   使用

    • 打开java文件,soanrlint会自动进行检测,对于不规范或有问题的代码会在下方划蓝色波浪线,如图:

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

        点击“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”,如果显示失败可进行手动填写,如图:

  结果同步SonarQube显示

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

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

IDEA中使用

  安装

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

  使用

    • 在左下角点击隐藏面板,可以看到sonarLint,打开;

    • 打开java文件,soanrlint会自动进行检测,对于不规范或有问题的代码会添加暗金色的背景色,鼠标放上去会有如图提示:

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

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

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

   Server

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

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

    • 从File -> settings -> OtherSettings中找到“SonarLint General Settings”打开;

    • 点击加号,输入一个name,如lego;选择SonarQube,Url为http://localhost9000;选择Login/Password,输入账号与密码(如lego账户);finish。

    • 在OtherSettings中找到“SonarLint Project Settings”进行项目bind,如图所示:

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

 结果同步SonarQube显示

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


参考: http://www.onstepr.com/posts/77/

             https://www.cnblogs.com/liguangsunls/p/7365840.html

            

你可能感兴趣的:(插件,代码优化)