你必须遵守约定!Maven Enforcer Plugin
时间:2010-08-09
来源:互联网
转自 http://www.juvenxu.com/ 作者 Juven Xu 在mavne方面相当历害。
在他的blog中学到了很多关于mavne的知识。
在一个稍大一点的组织或团队中,你无法保证所有成员都熟悉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:
view plaincopy to clipboardprint?
1. <build>
2. <plugins>
3. <plugin>
4. <groupId>org.apache.maven.plugins</groupId>
5. <artifactId>maven-enforcer-plugin</artifactId>
6. <version>1.0-beta-1</version>
7. <executions>
8. <execution>
9. <id>enforce-versions</id>
10. <goals>
11. <goal>enforce</goal>
12. </goals>
13. <configuration>
14. <rules>
15. <requireMavenVersion>
16. <version>2.2.1</version>
17. </requireMavenVersion>
18. <requireJavaVersion>
19. <version>1.5</version>
20. </requireJavaVersion>
21. </rules>
22. </configuration>
23. </execution>
24. </executions>
25. </plugin>
26. </plugins>
27. </build>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>1.0-beta-1</version>
<executions>
<execution>
<id>enforce-versions</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireMavenVersion>
<version>2.2.1</version>
</requireMavenVersion>
<requireJavaVersion>
<version>1.5</version>
</requireJavaVersion>
</rules>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
上述代码中使用了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,如:
view plaincopy to clipboardprint?
1. <plugin>
2. <groupId>org.apache.maven.plugins</groupId>
3. <artifactId>maven-enforcer-plugin</artifactId>
4. <version>1.0-beta-1</version>
5. <executions>
6. <execution>
7. <id>enforce-banned-dependencies</id>
8. <goals>
9. <goal>enforce</goal>
10. </goals>
11. <configuration>
12. <rules>
13. <bannedDependencies>
14. <excludes>
15. <exclude>junit:junit</exclude>
16. </excludes>
17. <message>you must use TestNG</message>
18. </bannedDependencies>
19. </rules>
20. </configuration>
21. </execution>
22. </executions>
23. </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>1.0-beta-1</version>
<executions>
<execution>
<id>enforce-banned-dependencies</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<bannedDependencies>
<excludes>
<exclude>junit:junit</exclude>
</excludes>
<message>you must use TestNG</message>
</bannedDependencies>
</rules>
</configuration>
</execution>
</executions>
</plugin>
上述代码中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的错误提示,从而自觉修复这些问题。
在他的blog中学到了很多关于mavne的知识。
在一个稍大一点的组织或团队中,你无法保证所有成员都熟悉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:
view plaincopy to clipboardprint?
1. <build>
2. <plugins>
3. <plugin>
4. <groupId>org.apache.maven.plugins</groupId>
5. <artifactId>maven-enforcer-plugin</artifactId>
6. <version>1.0-beta-1</version>
7. <executions>
8. <execution>
9. <id>enforce-versions</id>
10. <goals>
11. <goal>enforce</goal>
12. </goals>
13. <configuration>
14. <rules>
15. <requireMavenVersion>
16. <version>2.2.1</version>
17. </requireMavenVersion>
18. <requireJavaVersion>
19. <version>1.5</version>
20. </requireJavaVersion>
21. </rules>
22. </configuration>
23. </execution>
24. </executions>
25. </plugin>
26. </plugins>
27. </build>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>1.0-beta-1</version>
<executions>
<execution>
<id>enforce-versions</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireMavenVersion>
<version>2.2.1</version>
</requireMavenVersion>
<requireJavaVersion>
<version>1.5</version>
</requireJavaVersion>
</rules>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
上述代码中使用了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,如:
view plaincopy to clipboardprint?
1. <plugin>
2. <groupId>org.apache.maven.plugins</groupId>
3. <artifactId>maven-enforcer-plugin</artifactId>
4. <version>1.0-beta-1</version>
5. <executions>
6. <execution>
7. <id>enforce-banned-dependencies</id>
8. <goals>
9. <goal>enforce</goal>
10. </goals>
11. <configuration>
12. <rules>
13. <bannedDependencies>
14. <excludes>
15. <exclude>junit:junit</exclude>
16. </excludes>
17. <message>you must use TestNG</message>
18. </bannedDependencies>
19. </rules>
20. </configuration>
21. </execution>
22. </executions>
23. </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>1.0-beta-1</version>
<executions>
<execution>
<id>enforce-banned-dependencies</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<bannedDependencies>
<excludes>
<exclude>junit:junit</exclude>
</excludes>
<message>you must use TestNG</message>
</bannedDependencies>
</rules>
</configuration>
</execution>
</executions>
</plugin>
上述代码中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的错误提示,从而自觉修复这些问题。
作者: surpass_li 发布时间: 2010-08-09
回复 surpass_li
尝试用过maven1 。后来放弃 退回ant
尝试用过maven1 。后来放弃 退回ant
作者: tong0245 发布时间: 2010-08-09
相关阅读 更多
热门阅读
-
office 2019专业增强版最新2021版激活秘钥/序列号/激活码推荐 附激活工具
阅读:74
-
如何安装mysql8.0
阅读:31
-
Word快速设置标题样式步骤详解
阅读:28
-
20+道必知必会的Vue面试题(附答案解析)
阅读:37
-
HTML如何制作表单
阅读:22
-
百词斩可以改天数吗?当然可以,4个步骤轻松修改天数!
阅读:31
-
ET文件格式和XLS格式文件之间如何转化?
阅读:24
-
react和vue的区别及优缺点是什么
阅读:121
-
支付宝人脸识别如何关闭?
阅读:21
-
腾讯微云怎么修改照片或视频备份路径?
阅读:28