Android Studio 配置 CheckStyle

一、简介

CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。

CheckStyle检验的主要内容
·Javadoc注释
·命名约定
·标题
·Import语句
·体积大小
·空白
·修饰符
·块
·代码问题
·类设计

二、使用方法

1、安装CheckStyle插件。使用Android Studio。在 Setting 的 plugins 的 Browse 中搜索
CheckStyle，安装CheckStyle-IDEA。

2、 配置过滤文件。在application 目录下建一个
suppressions.xml。

suppressions.xml：

<!DOCTYPE suppressions PUBLIC    "-//Puppy Crawl//DTD Suppressions 1.1//EN"    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd"><suppressions>    <suppress checks="MemberName" files="com/app/example/model/*" /></suppressions>

suppressions.xml的过滤主要是过滤工程中Java bean（可以根据需要配置自己的过滤文件）。可以不以m开头的驼峰规则(checks为MemberName)。

然后并在application的build.gradle文件的最外层结构中添加：

project.ext {checkstyleSuppressionsPath = file("${project.rootDir}/checkconfig/quality/checkstyle/suppressions.xml").absolutePath}

3、配置规则文件。和 suppressions.xml 一样仍需要建一个checkstyle.xml

并在 application 工程的build.gradle文件中增加：

apply from: '../checkconfig/quality.gradle'

最后为了自动检测当前打开的Java文件，需要在setting中找到Other Settings-CheckStyle，里面有一个默认的规则，那个是sun的，我们点击下面的 “+” 号新建一个自己的，名称更加需要自己定。然后规则就选上面自己建的checkstyle.xml。ok 勾选之，apply/ok。就行了~ （这里如果你打开的是application的文件，那么中间会多一个步骤，需要要你填写checkstyleSuppressionsPath，value填写checkconfig/quality/checkstyle/suppressions.xml。那么这个时候执行该步骤就是给application的java代码应用自动检测，同理，lib工程也是，随便打开一个lib的java文件，然后再执行一次该步骤(不需要设置checkstyleSuppressionsPath属性)，这样 application工程和lib工程都可以自动检测了）

4、 对文件检测。在Android studio 底部面板中找到 checkstyle 的插件，选择自己配置的规则，左侧则有对 current file、module、project、all modified files、current change list 的操作。

Github CheckStyle