Jenkins与Sonarqube实现代码自动检查

转载自：https://www.jianshu.com/p/e111eb15da90

前言

在项目的开发过程中，为了保证代码的质量便于后期的代码维护，需要遵循统一的代码规范。但是通过人工逐一查看代码去检查费时费力，使用jenkins结合sonarqube可以实现代码的自动检查。

 

安装部署

一，部署jenkins

没有教程

 

二，部署SonarQube

1,参考部署连接：Kubernetes中部署代码质量检测工具SonarQube

2,访问 http://localhost:9000 地址，等待出现下面界面。点击“log in”，并使用默认用户和密码 admin / admin登录。

3,注意访问的地址是否正常，根据自己环境的地址进行访问

 

4，登录后按照下图中步骤，生成访问token。

 

三，配置jenkins任务

安装sonarqube插件，并创建jenkins任务。

jenkins中安装sonarqube插件

jenkins中要实现代码扫描，需要在jenkins中安装SonarQube Scanner插件。从jenkins的“系统管理”-“管理插件”中找到SonarQube Scanner插件并下载安装，重启jenkins后生效。

jenkins中配置sonarqube插件

在jenkins中，进入“系统管理”-“系统设置”-“SonarQube servers”配置。勾上“Enable injection of SonarQube server configuration ...”选项，输入“Name”、“Server URL”以及“Server authentication token”。token为前面部署sonarqube服务器时创建的token。

注意访问的地址是否正常，根据自己环境的地址进行填写，注意加上协议。

 

进入“系统管理”-“全局工具配置”-“SonarQube Scanner”，点击“SonarQube Scanner 安装”并配置SonarQube Scanner。

同样如果未配置maven，进入“系统管理”-“全局工具配置”-“Maven”，配置maven。

 

 

新建maven任务

点击“新建任务”，输入名称并选择“maven项目”，然后点击确定。如果没有“maven项目”可以选择，请先至插件管理中安装“Maven Integration”插件。

 

 

配置maven任务

进入任务的配置界面，在源码管理设置部分，选择“Git”，配置好工程的git地址以及获取代码的凭证信息。然后在“Additional Behaviours”中添加“Clean before checkout”。可以根据自己的需要在“Branches to build”中设置所需要获取的代码分支。

在“构建环境”配置中勾选“Prepare SonarQube Scanner environment”。

 

在“Post Steps”中点击“Add post-build step”，添加“Execute SonarQube Scanner”。

在“Task to run”中输入scan，即分析代码。在“Analysis properties”中输入下面内容。sonar.language 指定了要分析的开发语言（特定的开发语言对应了特定的规则），sonar.sources 定义了需要分析的源代码位置（示例中的$WORKSPACE 所指示的是当前 Jenkins 项目的目录），sonar.java.binaries 定义了需要分析代码的编译后 class 文件位置；sonar.java.source 指定java版本。

sonar.projectKey=${JOB_NAME}
sonar.projectName=${JOB_NAME}
sonar.language=java
sonar.projectVersion=1.0
sonar.sourceEncoding=UTF-8
sonar.sources=${WORKSPACE}
sonar.java.binaries=${WORKSPACE}
sonar.java.source=1.8

 

 

测试jenkins任务

在创建的jenkins任务中，点击“立即构建”即可立即执行sonar任务。

执行成功后，打开sonarqube的地址，即可看到代码检查结果。