程序代码向来都不仅仅是用来运行的,写的一手好代码,易读,可维护应该是每个程序员所追求的。
每个团队都(应该)有一套优良统一的代码规范,而规范的检查依赖于人工检测就不太现实,好在我们有一些分析工具可以辅助我们做这件事。
checkstyle是一个帮助我们检查java代码规范的工具。checkstyle具有很强的配置性。本文将简单介绍一些实用的checkstyle知识。
配置checkstyle如下修改Project的build.gradle文件
allprojects{repositories{jcenter()}applyplugin:checkstyletaskcheckstyle(type:Checkstyle){sourcesrcinclude**/*.javaexclude**/gen/**exclude**/R.javaexclude**/BuildConfig.javaconfigFilenewFile(rootDir,checkstyle.xml)//emptyclasspathclasspath=files()}}
设置checkstyle配置文件每一个checkstyle配置文件必须包含Checker作为根module
TreeWalkermodule用来遍历java文件,并定义一些属性。
ThreeWalkermodule包含了多个子module,用来进行检查规范。
注:checkstyle的配置文件,这里名称为checkstyle.xml位置为项目根目录即可。
一个简单的checkstyle配置文件如下,包含了检测import,whitespace,blocks等module.
?xmlversion=1.0?!DOCTYPEmodulePUBLIC-//PuppyCrawl//DTDCheckConfiguration1.//EN治白癜风有哪些偏方天津市治疗白癜风的医院