IDEA中代码检查工具的安装和使用(PMD,FindBugs,CheckStyle)

最近公司要求本地开发的代码需要通过CI检查才能提交。CI检查,what?上网查了下CI也就是持续集成,为了保证持续集成的质量,实际上开发环境要装的是代码检查工具(PMD,FindBugs,CheckStyle)

FindBugs

检查.class,基于Bug Patterns概念,查找javabytecode(.class文件)中的潜在bug
主要检查bytecode中的bug patterns,如NullPoint空指针检查、没有合理关闭资源、字符串相同判断错(==,而不是equals)等

PMD

检查源文件,检查Java源文件中的潜在问题
主要包括:
空try/catch/finally/switch语句块
未使用的局部变量、参数和private方法
空if/while语句,不必须的if语句、可以使用while循环完成的for循环
String/StringBuffer的滥用
尽量不要再for或while循环体内实例化一个新对象
过于复杂的表达式,如不必要的if语句等
Connect,Result,Statement等使用之后确保关闭掉
复杂类

CheckStyle

检查源文件,主要关注格式,检查Java源文件是否与代码规范相符
主要包括:
Javadoc注释
命名规范
多余没用的Imports
Size度量,如过长的方法
缺少必要的空格Whitespace
重复代码

插件安装

  • PMD
    Plugins->Browse Repositories…->PMDPlugin->install,完成安装。
  • FindBugs
    Plugins->Browse Repositories…->FindBugs-IDEA->install,完成安装。
  • CheckStyle
    Plugins->Browse Repositories…->CheckStyle-IDEA->install,完成安装。

插件配置

  • PMD
    Other Settions->PMD
    设置options,Target JDK值为1.8,Encoding值为UTF-8。
  • FindBugs
    Other Settions->FindBugs-IDEA
    保持默认设置。
  • CheckStyle
    Other Settions->Checkstyle
    配置Configuration File点击绿色+号,添加CheckStyle-mars.xml文件,并在Configuration File选择该文件为Active。

如何使用

  • PMD
    IDEA的Project导航视图中,项目或模块文件夹点击鼠标右键,弹出菜单选择Run PMD->Pre->Defined->All(或者单个PMD规则)
  • FindBugs
    IDEA的Project导航视图中,项目或模块文件夹点击鼠标右键,弹出菜单选择FindBugs->Analyze Module Files
    Analyze Module Files:分析模块中的所有文件。
    Analyze Project Files:分析项目中的所有文件。
    Analyze All Modified Files:分析全部已修改的文件。
  • CheckStyle
    IDEA的Project导航视图中单选、多选一个文件。
    底部CheckStyle视图,点击绿色三角运行CheckStyle,窗口显示检查报告。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容