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,窗口显示检查报告。

你可能感兴趣的:(IDEA中代码检查工具的安装和使用(PMD,FindBugs,CheckStyle))