阿男的小窝

View the Project on GitHub

使用maven的check-style-plugin对代码风格进行约束

在做多人协作的项目的时候,需要大家对代码的格式与风格进行一些统一的约定。使用Maven的check-style-plugin可以做这件事。使用方法是在pom.xml里添加maven-checkstyle-plugin并指定checkstyle.xml

这个plugin使用checkstyle.xml来定制各种检查规则。比如我们可以禁止class中的import *,规则在checkstyle.xml里面这样写:

这样,当我们在代码中使用import *试试看:

上面这样的写法违反了checkstyle.xml里面的规则,在编译的时候就会出错:

因此要修改代码,去掉import *的用法才可以:

这样,就满足了checkstyle.xml里面定义的规则。此外,为了避免IntelliJ自动把import切换成*,可以在它的设置里面,把下面两条设置的值转为999

关于maven-checkstyle-plugin的用法,可以参考它的文档: