checkstyle 使用

简介:  下载: checkstyle 规范 (包含 codeformatter codetemplates checkstyle 文件) http://download.csdn.net/download/knight_black_bob/9640991   下载 checkstyle 插件 http://download.

 下载: checkstyle 规范 (包含 codeformatter codetemplates checkstyle 文件)

http://download.csdn.net/download/knight_black_bob/9640991

 

下载 checkstyle 插件

http://download.csdn.net/download/knight_black_bob/9643244

 

 

 

一、配置 Code Templates

 设置 Eclipse 代码模版

打开 Eclipse 设置面板,选择 Java -> Code Style -> Code Templates

如图: 



 

点击右边的 Import…按钮,选择 codetemplates.xml 文件,确定即

可。 

 

 

 

二、配置使用 4 个空格代替 tab

tab键在不同的IDE、编辑器(例如EditPlusUltraEdit等)中使用

的空格数不同,因此为了统一,开发人员统一使用4个空格代替tab

键。

打开 Eclipse 设置面板,选择 General -> Editors -> Text Editors

如图: 



 

勾选 Insert spaces for tabs,并设置 Displayed tab width 4

三、配置 Code Formatter

3.1 设置 Eclipse 的代码格式化模版

打开 Eclipse 设置面板,选择 Java -> Code Style -> Formatter,如图:

 

 

点击右边的 Import…按钮,选择 codeformatter.xml 文件,确定即

可。

3.2 格式化使用说明

若要对某个文件进行格式化,可使用如下几种方法:

1.打开文件后,在代码区域采用“CTRL + SHIFT + F”快捷键;

2.打开文件后,在代码区域点击右键选择 Source -> Format

能。

   【说明】建议采用 CTRL + Shift + F 快捷

 

四、配置 Checkstyle 

4.1 ant 集成

要在 ant 工程中使用 Checkstyle,需要先安装 checkstyle jar 包,以

checkstyle-6.15-all.jar 为例,这个包中包含了运行 Checkstyle 需要的类文件。

接下来就是在 build.xml 文件中添加 taskdef 的声明: 

 

<taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties"          classpath="/path/to/checkstyle-6.15-all.jar"/> 然后添加一个 checkstyle 的 target。
<target name="checkstyle" >
  <checkstyle config="checkstyle.xml" failureProperty="checkstyle.failure"
failOnViolation="false">
  <formatter type="xml" tofile="${result.xml}/checkstyle_report.xml"/>
    <fileset dir="/home/jenkins/workspace/JAVA_checkstyle_ANT"
includes="**/*.java"/>
  </checkstyle>
  <style in="${result.xml}/checkstyle_report.xml" 
out="${result.html}/checkstyle_report.html"  style="${basedir}/checkstyle.xsl" /> 
  <fail if="checkstyle.failure">
          Checkstyle failed.
        </fail>
</target> 

 

可以运行 ant checkstyle 进行扫描。详细结果信息被存放在

${result.xml}/checkstyle_report.xml 中。

4.2 MAVEN 集成

maven 中一个名为 maven-checkstyle-plugin 的插件,用于执行

CheckStyle task。下面是一个简单的配置。

 

<reporting> 

     <plugins> 

      <plugin> 

        <groupId>org.apache.maven.plugins</groupId> 

        <artifactId>maven-checkstyle-plugin</artifactId> 

        <version>2.9.1</version> 

<configuration> 

           <configLocation> config/maven_checks.xml</configLocation> 

<includes> 

            **\/package\/**.java,**\/otherpackage\/**.java 

             </includes> 

            </configuration> 

    </plugin> 

        <plugin> 

            <groupId>org.apache.maven.plugins</groupId> 

            <artifactId>maven-jxr-plugin</artifactId> 

            <version>2.3</version> 

         </plugin> 

        </plugins> 

</reporting> 

 

可以运行 mvn checkstyle:checkstyle 进行扫描。checkstye 的详细结果信息被

存放在 target/checkstyle-result.xml 中。

4.3 跳过对指定文件的某些检查

如果对于指定文件的某些行检查出了一些问题,但是你想忽略它,则可以使用 suppression方法是建立一个 checkstyle-suppressions.xml 文件。其中加入下述内容

 

<?xml version="1.0"?> 
<!DOCTYPE suppressions PUBLIC       
  "-//Puppy Crawl//DTD Suppressions 1.0//EN"        
 "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> 
 
<suppressions>     
<suppress checks="MagicNumberCheck"              
 files="SessionMessageSource.java"               
lines="221,250-295"/>

 </suppressions> 

 

 

然后配置 maven-checkstyel-plugin,在<configuration>……</configuration>

中添加下列两句: <suppressionsLocation>path/to/checkstylesuppressions.xml</suppressionsLocation> <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExp ression>

4.4 Jenkins 输出报告

在运行完 checkstyle 之后,可以使用 Publish Checkstyle analysis results

件,它可以解析生成的 xml 结果文件。 

1 Checkstyle 报告输出插件 



 

2 jenkins 输出 Checkstyle 报告

 

 

 

 

添加checkstyle 插件



 

 

 

添加 checkstyle.xml 为默认检测



 

 

eclipse > preferences > checkstyle > new > external configuration file > ok

> set as default

 

设置为默认

 

项目右键 format 一下 ,出现 checkstyle 报错



 

 

 

 

 

 _NA_SA  配置命令

mvn clean install checkstyle:checkstyle findbugs:findbugs -Dmaven.test.skip=true

 

 

 

 

 

 

 

 

 

 

 

 

 

 

捐助开发者

在兴趣的驱动下,写一个免费的东西,有欣喜,也还有汗水,希望你喜欢我的作品,同时也能支持一下。 当然,有钱捧个钱场(右上角的爱心标志,支持支付宝和PayPal捐助),没钱捧个人场,谢谢各位。



 
 
 谢谢您的赞助,我会做的更好!

 

 

 

 

 

目录
相关文章
|
Java Apache Maven
使用checkstyle来规范你的项目
Checkstyle是什么 自从做了程序员,关于格式化的讨论就不曾中断过,到底什么才是正确的,什么才是错误的,到现在也没有完整的定论。但随着时间发展,渐渐衍生出一套规范出来。没有什么绝对的正确和错误,关键在于规范的定义。
6090 0
|
Java
Checkstyle
CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。 CheckStyle检验的主要内容 ·Javadoc注释 ·命名约定 ·标题 ·Import语句 ·体积大小 ·空白 ·修饰符 ·块 ·代码问题 ·类设计 ·混合检查(包括一些
1206 0
|
12月前
|
IDE Java 持续交付
提升代码质量:CheckStyle插件的实践与心得
在软件开发过程中,代码的规范性是保证项目质量和维护性的重要因素。然而,手动检查代码规范既耗时又容易出错。为了解决这一问题,许多开发团队引入了自动化工具来帮助维护代码规范。CheckStyle就是这样一款广受欢迎的代码质量检查工具。本文将分享CheckStyle插件的实践应用和使用心得,探讨它是如何帮助我们提升代码规范性的。
651 0
|
Kubernetes 架构师 Java
史上最全对照表:大厂P6/P7/P8 职业技能 薪资水平 成长路线
40岁老架构师尼恩,专注于帮助读者提升技术能力和职业发展。其读者群中,多位成员成功获得知名互联网企业的面试机会。尼恩不仅提供系统化的面试准备指导,还特别针对谈薪酬环节给予专业建议,助力求职者在与HR谈判时更加自信。此外,尼恩还分享了阿里巴巴的职级体系,作为行业内广泛认可的标准,帮助读者更好地理解各职级的要求和发展路径。通过尼恩的技术圣经系列PDF,如《尼恩Java面试宝典》等,读者可以进一步提升自身技术实力,应对职场挑战。关注“技术自由圈”公众号,获取更多资源。
|
Kubernetes Docker Windows
kubernetes面试题汇总
kubernetes面试题汇总
|
Linux
Linux升级命令yum upgrade和yum update,有什么区别?
在日常开发工作中,根据不同的项目会需要配置环境和包,有时候会由于版本问题出现错误,这个时候通常就需要执行 update或者 upgrade命令,这里简要介绍一下区别。
3760 0
Linux升级命令yum upgrade和yum update,有什么区别?
|
canal 缓存 关系型数据库
Spring Boot整合canal实现数据一致性解决方案解析-部署+实战
Spring Boot整合canal实现数据一致性解决方案解析-部署+实战
|
消息中间件 JavaScript 小程序
自从用了CheckStyle插件,代码写的越来越规范了....
自从用了CheckStyle插件,代码写的越来越规范了....
|
存储 缓存 前端开发
Android Github 上面优秀的两种阴影方案,完美兼容高低版本问题
Android Github 上面优秀的两种阴影方案,完美兼容高低版本问题
|
iOS开发 MacOS
ubuntu22/20 安装macos 主题桌面
ubuntu22/20 安装macos 主题桌面
686 0