checkstyle+eclipse/jenkins对代码规范检查的应用

怼烎@ 2022-05-17 06:59 196阅读 0赞

**一、checkstyle+eclipse**

**1.** **认识****Checkstyle**

CheckStyle是SourceForge下的一个项目，提供了一个帮助[**Java**][Java]开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，方法体的最大行数，重复代码检查等等。

**2. Checkstyle****插件安装**

![70][]

安装完成后，根据提示重启eclipse，checkstyle即安装完成。

**3.Checkstyle****全局配置**

Window -->Preferences,选择checkstyle菜单，增加项目组统一的规则文件，并设置为默认规则。如下图：

![70 1][]

到此全局配置已经完成。

**4. Checkstyle****项目配置**

项目 --> 右键Properties

![70 2][]

![70 3][]

到此项目配置已经完成。成功的话，checkstyle已经开始工作了。

此次发现项目上有很多红叉叉，说明是代码不符合规范造成的。

![70 4][]

根据提示信息修改后，则没有有红色的提示。

![70 5][]

**5. ****其它操作**

在项目右键菜单中，checkstyle还有一些快捷操作，如下图所示：

![70 6][]

**6.checkStyle** **使用**

选中工程，右键选择checkstyle->check code withcheckstyle,检查错误即可

**Checkstyle****的结果输出**

序号     输出内容意义

1 Type is missing a javadoc commentClass 缺少类型说明

2“\{” should be on the previous line “\{” 应该位于前一行

3Methos is missing a javadoc comment方法前面缺少javadoc注释

4Expected @throws tag for “Exception”在注释中希望有@throws的说明

5“.” Is preceeded with whitespace “.” 前面不能有空格

6“.” Is followed by whitespace“.” 后面不能有空格

7“=” is not preceeded with whitespace“=” 前面缺少空格

8“=” is not followed with whitespace“=” 后面缺少空格

9“\}” should be on the same line“\}” 应该与下条语句位于同一行

10Unused @param tag for “unused”没有参数“unused”，不需注释

11Variable “CA” missing javadoc变量“CA”缺少javadoc注释

12Line longer than 80characters行长度超过80

13Line contains a tab character行含有”tab” 字符

14Redundant “Public” modifier冗余的“public” modifier

15Final modifier out of order with the JSL suggestionFinalmodifier的顺序错误

16Avoid using the “.\*” form of importImport格式避免使用“.\*”

17Redundant import from the same package从同一个包中Import内容

18Unusedimport-java.util.listImport进来的java.util.list没有被使用

19Duplicate import to line 13重复Import同一个内容

20Import from illegal package从非法包中 Import内容

21“while” construct must use “\{\}”“while” 语句缺少“\{\}”

22Variable “sTest1” must be private and have accessormethod变量“sTest1”应该是private的，并且有调用它的方法

23Variable “ABC” must match pattern“^\[a-z\]\[a-zA-Z0-9\]\*$”变量“ABC”不符合命名规则“^\[a-z\]\[a-zA-Z0-9\]\*$”

24“(” is followed by whitespace“(” 后面不能有空格 25“)” is proceededby whitespace“)” 前面不能有空格

**二、checkstyle+jenkins 基于Linux**

1、jdk的安装与配置 略 我的版本：java version "1.8.0\_144"

2、jenkins的安装与初始化 略 我的版本：Jenkins2.121.1

参考：[http://www.cnblogs.com/zhaoxd07/p/4956637.html][http_www.cnblogs.com_zhaoxd07_p_4956637.html]

3、ant的安装与配置 略 我的版本：Apache Ant(TM) version 1.9.9

参考：[https://www.cnblogs.com/sell/archive/2013/07/24/3210198.html][https_www.cnblogs.com_sell_archive_2013_07_24_3210198.html]

4、jenkins上的checkstyle项目配置

只需要几个文件：

checkstyle-5.6-all.jar：必须有，checkstyle应用包，也可以是其他版本

checkstyle.xml：必须有，规范文件，可以有google版本、sun版，或者其他（比如华为版、自定义版）

checkstyle-author.xsl：可以没有，html模板文件，用于将checkstyle生成的xml文件转换为可视化的html报告，可用于邮件发送；可不使用该模板，而使用jenkins自带的style插件，生成对应报告，不过如果代码量太大，jenkins主机配置不高，jenkins生成报告耗时较长。

build.xml：必须有，ant的默认构建脚本，如果是其他名字，需要使用ant -file xxx.xml指定；文件内指定了前述几个文件的路径、文件名、待检测源代码路径、代码文件名通配符表达式等，参考如下：

<?xml version="1.0" encoding="UTF-8"?>   
<project name="checkstyle" default="checkstyle" basedir="/var/lib/jenkins/workspace/checkstyle">   
  
    <target name="init">  
        <tstamp/>  
          
        <property name="project.dir" value="/var/lib/jenkins/workspace/checkstyle"/>  
          
        <property name="project.checkstyle.report.dir" value="$\{project.dir\}/checkstyle\_report"/>      
        <property name="project.checkstyle.result.name" value="checkstyle-result.xml"/>  
        <property name="project.checkstyle.report.name" value="checkstyle-report.html"/>  
          
        <property name="checkstyle.config" value="/var/lib/jenkins/workspace/checkstyle/config/huawei-checkstyle.xml"/>  
        <property name="checkstyle.report.style" value="/var/lib/jenkins/workspace/checkstyle/config/checkstyle-author.xsl"/>      
        <property name="checkstyle.result" value="$\{project.checkstyle.report.dir\}/$\{project.checkstyle.result.name\}"/>      
        <property name="checkstyle.report" value="$\{project.checkstyle.report.dir\}/$\{project.checkstyle.report.name\}"/>      
        <mkdir dir="$\{project.checkstyle.report.dir\}"/>  
    </target>  
      
    <taskdef resource="checkstyletask.properties" classpath="/var/lib/jenkins/workspace/checkstyle/checkstyle-5.6-all.jar" />     
    <target name="checkstyle"  depends="init" description="check java code and report." >            
         <checkstyle config="$\{checkstyle.config\}" failureProperty="checkstyle.failure"  failOnViolation="false">      
            <formatter type="xml"   tofile="$\{checkstyle.result\}" />        
            <fileset dir="$\{project.dir\}/../" includes="\*\*/\*.java" />   
        </checkstyle>   
           
        <style in="$\{checkstyle.result\}" out="$\{checkstyle.report\}" style="$\{checkstyle.report.style\}" />   
    </target>   
</project>

jenkins配置参考：

![70 7][]

![70 8][]

检查报告：

![70 9][]

参考文档：

[http://qa.blog.163.com/blog/static/19014700220133351850624/][http_qa.blog.163.com_blog_static_19014700220133351850624]

[https://www.cnblogs.com/helloIT/p/6657483.html][https_www.cnblogs.com_helloIT_p_6657483.html]

[https://blog.csdn.net/youjianbo\_han\_87/article/details/7348498][https_blog.csdn.net_youjianbo_han_87_article_details_7348498]

[http://www.cnblogs.com/zhaoxd07/p/4956637.html][http_www.cnblogs.com_zhaoxd07_p_4956637.html]

[https://blog.csdn.net/csolo/article/details/73087223][https_blog.csdn.net_csolo_article_details_73087223]

[Java]: http://lib.csdn.net/base/javase
[70]: /images/20220517/61cfa8d84ea5470e9c37bef09498ee23.png
[70 1]: /images/20220517/9189ab0ca7774743a213b3e83f2998e7.png
[70 2]: /images/20220517/fd7080c1f17147f0afbbc7a66bceeafc.png
[70 3]: /images/20220517/3f33d4d3e0c0483baa00c4e13c86a15a.png
[70 4]: /images/20220517/92a178beea3c4d35b39cda571383b5a4.png
[70 5]: /images/20220517/df96225d2831442bb4de161b95c9f326.png
[70 6]: /images/20220517/fbc1ac9241e940248df8d20d5ccea3e0.png
[http_www.cnblogs.com_zhaoxd07_p_4956637.html]: http://www.cnblogs.com/zhaoxd07/p/4956637.html
[https_www.cnblogs.com_sell_archive_2013_07_24_3210198.html]: https://www.cnblogs.com/sell/archive/2013/07/24/3210198.html
[70 7]: /images/20220517/4349b4a9f5e94eb9b1c3043fff481df9.png
[70 8]: /images/20220517/f3ddcd1161c548358637d20d05fd3209.png
[70 9]: /images/20220517/af6ff15b4b4c4a78a6db44780f34584f.png
[http_qa.blog.163.com_blog_static_19014700220133351850624]: http://qa.blog.163.com/blog/static/19014700220133351850624/
[https_www.cnblogs.com_helloIT_p_6657483.html]: https://www.cnblogs.com/helloIT/p/6657483.html
[https_blog.csdn.net_youjianbo_han_87_article_details_7348498]: https://blog.csdn.net/youjianbo_han_87/article/details/7348498
[https_blog.csdn.net_csolo_article_details_73087223]: https://blog.csdn.net/csolo/article/details/73087223