【DevOps】SonarLint + Eclipse + SonarQube集成

阳光穿透心脏的1/2处 2023-07-04 15:56 12阅读 0赞

> 在完成[SonarQube的安装][SonarQube]之后，我们开始将工作继续向前推进——将校验的工作前置到研发人员的工作机上，正如[SonarLint][]首页所宣称的"Fix issues before they exist"。本文以Eclipse为例给出SonarLint的安装指南。

### 1. 概述 ###

虽然有了SonarQube来检测和量化SVN代码库的质量，但"解决问题最好的办法就是不让它发生"、“距离错误越近，解决它的成本越低”，因此我们**强烈推荐研发人员在本地IDE上安装检测工具来实时检测代码，尽量减少不必要的二次返工**。SonarLint正是这样一款IDE扩展，可以帮助研发人员在编写代码时检测和修复质量问题。

### 2. 安装SonarLint ###

安装方式分两种，在线安装和离线安装。以下分别进行介绍。

###### a. 在线安装 ######

因为个人习惯问题，笔者这里以Eclipse演示插件的安装过程。

“Help” > “Eclipse Marketplace"下查找"sonarlint"关键字，回车：  
![Mark][]  
点击右下角的"install"按钮（笔者这里已经安装成功了，因此显示的是"Installed”），然后一路next下去即可，安装过程无需任何配置。安装成功后，eclipse需要重启。

这种方式简单、方便，而且只要安装完成，基本就能确保成功，但受限于网络等原因经常导致安装失败，因此就有了下面这种安装方式。

###### b. 离线安装 ######

这种方式属于前一种方式的后备计划。

虽然我们使用这种方式，但并不代表上一种方式就毫无用途了。通过上面的截图中我们可以看到最适配笔者IDE的SonarLint版本为4.3，因此我们可以去[SonarLint-for-Eclipse下载地址][SonarLint-for-Eclipse]找到相应的安装压缩包。

# 这里启用断点续传, 避免悲剧
    wget -c  https://binaries.sonarsource.com/SonarLint-for-Eclipse/releases/org.sonarlint.eclipse.site-4.3.0.12432.zip

等待上面下载完毕，即可继续接下来的安装工作。

“Help” > “Install New Software…”：  
![Install][]  
耐心等待安装完成，然后按照提示重启Eclipse即可。

### 3. 配置SonarLint ###

”Window“ > “Show View” > “Other…”：  
![配置 SonarQube][SonarQube 1]  
新建一个Server Connectioin：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]  
然后选择 Token 或 Username + Password 进行授权验证。待验证通过之后Eclipse会自动下载相应的校验规则等相关工作。

### 4. 使用SonarLint ###

对于SonarLint的使用分两部分：针对单个源文件，以及针对整个项目。

###### a. 针对单个文件使用SonarLint ######

1.  在源文件右键 > SonarLint > Anaylse ：  
    ![SonarLint分析单个源文件][SonarLint 1]
2.  得到如下结果：  
    ![SonarLint分析结果][SonarLint 2]

###### b. 针对整个项目使用SonarLint ######

1.  在项目右键 > SonarLint > Bind to a SonarQube project… ：  
    ![在这里插入图片描述][20200213175503746.png]
2.  为项目绑定特定的规则集：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 1]

### 5. Links ###

1.  [sonarlint官网 -1][SonarLint]
2.  [sonarlint官网 -2][sonarlint_ -2]

[SonarQube]: https://blog.csdn.net/lqzkcx3/article/details/104271332
[SonarLint]: https://www.sonarlint.org/
[Mark]: https://img-blog.csdnimg.cn/20200213172335339.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[SonarLint-for-Eclipse]: https://binaries.sonarsource.com/SonarLint-for-Eclipse/releases/
[Install]: https://img-blog.csdnimg.cn/20200213174523285.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[SonarQube 1]: https://img-blog.csdnimg.cn/20200213175642294.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200213175945516.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[SonarLint 1]: https://img-blog.csdnimg.cn/20200213175120551.png
[SonarLint 2]: https://img-blog.csdnimg.cn/2020021317540472.png
[20200213175503746.png]: https://img-blog.csdnimg.cn/20200213175503746.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200213180410486.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[sonarlint_ -2]: https://www.sonarsource.com/products/sonarlint/