今天开发的时候发现了一个好用的plugin:maven-checkstyle-plugin,可以帮助程序员检测代码中不符合规范的地方,大大方便程序开发。
1. maven自定义checkstyle使用
1.1. 自定义checkstyle.xml
即自己定义代码的规格。例如谷歌的代码规范约定缩进两个空格,但是现在Java开发一般都是缩进四个空格。这些规范都定义在checkstyle.xml文件中。从网上看到一个基于华为java编程规范的checkstyle.xml,在文章最后面贴出了xml文件内容。
1.2. 配置pom.xml
maven-checkstyle-plugin
3.0.0
validate
validate
style/checkstyle.xml
UTF-8
true
true
false
check
2. maven使用阿里的p3c-pmd的规范
只需要配置pom.xml就可以。
2.1. pom.xml文件配置
org.apache.maven.plugins
maven-pmd-plugin
3.8
rulesets/java/ali-comment.xml
rulesets/java/ali-concurrent.xml
rulesets/java/ali-constant.xml
rulesets/java/ali-exception.xml
rulesets/java/ali-flowcontrol.xml
rulesets/java/ali-naming.xml
rulesets/java/ali-oop.xml
rulesets/java/ali-orm.xml
rulesets/java/ali-other.xml
rulesets/java/ali-set.xml
true
validate
validate
check
com.alibaba.p3c
p3c-pmd
1.3.0
附录
给基于华为java编程规范的checkstyle.xml
直接搬运过来,并没有进行加工。可根据实际情况选择。