Archive

Archive for July, 2010

你必须遵守约定!Maven Enforcer Plugin

July 30th, 2010 4 comments

在一个稍大一点的组织或团队中,你无法保证所有成员都熟悉Maven,那么他们做一些比较愚蠢的事情就会变得很正常,例如给项目引入了外部的SNAPSHOT依赖而导致构建不稳定,使用了一个与大家不一致的Maven版本而经常抱怨构建出现诡异问题,或者不小心引入了一个项目禁止使用的依赖或者插件,等等。如果你的项目有十几个或者更多的模块,团队成员也是两位数,隔三差五地遇到并不得不解决这种琐碎的问题显然非常烦人。当然,你可以引入Maven培训来加强大家的技术能力,从而避免类似的错误不断发生,但本文要介绍的是一种更便捷的做法,就是使用一个大家可能未听说过的Maven插件:Maven Enforcer Plugin。

我们知道,Maven的核心设计原则之一是“约定优于配置”,例如不进行任何配置,Maven就知道从src/main/java读取源码,从src/test/java读取测试代码并自动运行。Maven的超级POM其实就是约定的实现,在这里你能看到各种约定的配置,包括目录结构,核心插件版本,等等。所有的Maven POM都隐式地继承自超级POM从而获得这些配置。

在此基础上,你在组织内部可能有进一步的约定希望大家遵守,例如固定的JDK版本,固定的Maven版本,固定某些依赖的版本,固定某些插件的版本等等,这个时候Maven Enforcer Plugin就能派上用场。举个最简单的例子,我希望大家使用的JDK版本都是1.5及以上,Maven版本都是2.2.1及以上,那么就可以在父POM中如下配置Maven Enforcer Plugin:

上述代码中使用了Maven Enforcer Plugin的enforce目标,该目标会基于rules配置进行检验。这里我们配置两条rule,第一条是requireMavenVersion,值2.2.1表示大于等于2.2.1,第二条规则是requireJavaVersion,值1.5表示大于等于1.5。如果你想配置更为复杂的版本范围,可以参考该文档,例如 (1.0,2.0] 就表示大于1.0小于等于2.0。

除了requireMavenVersion和requireJavaVersion之外,Maven Enforcer Plugin内置了很多其它的rule,包括如何禁止某些依赖、设定操作系统版本、设定插件版本等等,读者可以在这里看到完整的内置rule的列表。下面就再举一个关于依赖的例子,假设你的项目全面使用了TestNG,因此你不像在依赖中看到JUnit,这个时候就可以使用bannedDependencies这条rule,如:

上述代码中bannedDependencies下有一条exclude配置,值为junit:junit,表示排除所有groupId为junit,artifactId为junit的依赖,而message用来配置当Maven检查到有人构建中有junit依赖事将打印的错误输出。

还有一条非常有用的rule是requireReleaseDeps,用来禁止项目引入SNAPSHOT依赖,具体配置不再赘述,读者可以直接参考官方文档。

如果所有这些内置的rule都无法满足你的需求怎么办,Maven Enforcer Plugin提供了开放的接口允许你编写自己的rule,有兴趣的读者可以参考这个文档

OK,现在你只要在父POM里配置好Maven Enforcer Plugin,然后要求所有子模块来继承,你就能很好的控制项目的约定,如果再有人破坏约定,那么他们不得不面对Maven的错误提示,从而自觉修复这些问题。

最后,Youtube上还有两段Sonatype提供的关于Maven Enforcer Plugin的视频,有兴趣的朋友可以去看看:

Categories: Maven Tags: ,