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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 1、在android studio中安装checkstyle插件。 具体操作见上图。安装完之后见下图 底栏会多一个...
    nmssdmf阅读 3,640评论 0 4
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,072评论 25 707
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,803评论 6 342
  • 人人反对偏见,可人人都有偏见。——赫·斯宾塞 我们总会莫名其妙不喜欢一个人,因为对他们所贴的标签而引起偏见,我们经...
    梦凝雪天阅读 765评论 0 3