本章开始在Jenkins中集成代码质量检查工具,主要包括checkstyle、PMD、Findbugs等。Jenkins能够实现在构建前自动进行工具的调用,进行代码检查。
(一)在ideal中增加checkstyle配置
checkstyle是在上传至GIT服务器中的代码中进行配置的,具体是在项目的pom.xml文件中。
参考配置如下:
<!--Checkstyle-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<linkXRef>false</linkXRef>
<consoleOutput>false</consoleOutput>
<configLocation>fcm-cs-check.xml</configLocation>
<outputFileFormat>xml</outputFileFormat>
</configuration>
</plugin>
配置修改好后提交至远程GIT服务器,可以通过Gogs进行查看。
其中 fcm-cs-check.xml是对checkstyle的检查规则进行设定的配置文件。具体的配置方法见后文。
(二)安装checkstyle插件
- 安装checkstyle插件
按照图示操作后,等待插件安装完成。
1.1增加插件.jpg 1.2管理插件.jpg 1.3安装插件.jpg
点击安装后,等待插件安装完成。
(三)配置Jenkins全局参数
要Jenkins对代码进行编译,需要告诉Jenkins系统内Maven和Jdk安装在哪里。在上一章我们已经设置了MAVEN_HOME和JAVA_HOME,那么在Jenkins里面,需要告诉Jenkins几个HOME的位置。
具体操作见下图。
1.4增加全局配置.jpg 1.5增加全局配置.jpg
新增两个配置文件。
(四)创建一个Jenkins任务
Jenkins能够对整个作业流进行自动配置管理,是通过Jenkins任务来实现的。
我们需要在Jenkins中实现代码的自动检查、构建,就需要创建Jenkins任务。Jenkins任务有几类,包括自由模式、流水线、maven项目等,我们先选择自由风格模式。
需要在Jenkins编译代码前实现对checkstyle的调用,那么在Jenkins中做如下的设置,包括设置源代码库地址,编译参数,以及编译后的检查结果的显示。
具体步骤见下图。
2.建立任务.jpg 3.添加源码库.jpg 4.添加源码库用户名和密码.jpg 5.增加构建步骤.jpg 6.增加构建步骤2.jpg
(五)执行构建
配置完成后,回到任务界面,手动执行构建操作,可以看到构建的结果。特别对于checkstyle的代码检查结果,在侧边栏可以选择进行查看。
7.构建运行结果.jpg 8.checkstyle检查结果.jpg
至此,配置和运行checkstyle的操作步骤已完成,后续章节我们将安装PMD和Findbugs两个常用的代码检查工具。
网友评论