IDEA集成CheckStyle插件

安装插件

  • 打开IDEA

  • File -> Settings (或者Ctrl+Alt+S) -> Plugins

  • 在搜索框中输入CheckStyle-IDEA

  • 找到后在右边栏中点击Install,安装结束后重启IDEA,安装结束

Plugins

配置CheckStyle插件

  • 同样进入到Setting中 -> Checkstyle

  • 在界面中可以配置版本号,扫描域

  • 如果想要使用的CheckStyle版本号不在其中的话可以使用第三方的包进行扫描:

    • 在Third-Party Checks栏中点击右边的"+"号按钮,选择要用到的第三方Jar包
    • Jar包可以在CheckStyle官网下载,这里是传送门
  • CheckStyle自带Google和Sun的编码规范xml文件,如果需要用自己定制的:

    • 在Configuration File栏中点击右边的"+"号按钮,选择要用到的定制的xml文件
    • 官方自带的Google规范Sun规范在此
    • 如果上面链接过时,可到CheckStyle官网查找
Checkstyle

修改Google规范文件(可选,看自己项目规范)

因为项目组默认使用缩进格式是4个空格,而谷歌规范使用的是2个空格,因此在使用谷歌规则文件时,还需要做简单的修改:

  • 打开google_checks.xml文件

  • 找到Indentation模块,如图所示

  • 将里面的值统统扩大到2倍:

    • basicOffset value: 2->4
    • caseIndent value: 2->4
    • throwsIndent value: 4->8
    • lineWrappingIndentation value: 4->8
    • arrayInitIndent value: 2->4
Google规则文件

使用CheckStyle对文件进行检查

在要进行检查的文件中右键Check Current File就开始进行检查了,结果如图:

检查结果

附:使用命令行模式进行CheckStyle的检查

  • 官网指令模式说明
  • 如果不复杂的话可以直接使用该句,对指定目录下所有文件进行扫描检查
java -jar checkstyle-8.15-all.jar -c google_checks.xml CodeRepos/data-server/src/
  • 检查结果:
开始检查……
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:40:5: 缺少 Javadoc 。 [JavadocMethod]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:87:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:88:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:89:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:90:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:101:22: WhitespaceAround: '>' is not preceded with whitespace. [WhitespaceAround]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:101:23: WhitespaceAround: '>' is not followed by whitespace. Empty blocks may only be represented as {} when not part of a multi-block statement (4.1.3) [WhitespaceAround]
检查完成。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容

  • mean to add the formatted="false" attribute?.[ 46% 47325/...
    ProZoom阅读 2,685评论 0 3
  • 1、在android studio中安装checkstyle插件。 具体操作见上图。安装完之后见下图 底栏会多一个...
    nmssdmf阅读 3,615评论 0 4
  • 1 背景 一个项目开发必然会涉及团队协作,而工程质量就需要团队去保证。一般我们期望的代码:无潜在风险、无重复逻辑、...
    zyl06阅读 3,202评论 5 16
  • 晨练第395天:站桩30分钟 读经第215天:易经·坤卦 乾坤 乾坤,坤通常是乾的合作者、配合者、支持者,乾引领开...
    山缘有约阅读 409评论 0 0
  • 1 雨冷得像是被剪碎的短发,芒刺一般落进周云云紫色针织衫的缝隙里,扎得她脖子后面生疼。周云云不禁把翠鸟似的身体往方...
    青叶飘飘阅读 382评论 0 0