Maven插件介绍

  • 介绍

Maven之所以流行,除了它由包管理的能力外,非常重要的一点就是它的插件机制。幸运滴是,现在已经有很多好用的插件可以直接拿来的。本文总结了一些常用的插件。

  • 缺省变量

${basedir} 项目根目录

  • 编译

  • 生成可执行jar包

上面的finalName当然就是生成的文件名前缀了(surenpi.com.toolkit.jar),manifest的内容就是jar文件中的manifest了。

如果你的依赖中有的是快照版本(SNAPSHOT)的话,可能会发生找不到类的情况,就需要增加useUniqueVersions设置。

更多有关该插件的内容,请看这里。

  • 拷贝依赖

下面的配置会将所有的maven依赖jar文件拷贝到项目的target目录下

mvn dependency:copy-dependencies -DoutputDirectory=lib -DincludeScope=runtime -o

下面的配置会将所有的maven依赖的包结构拷贝到生成的jar文件中,并添加manifest信息

  • jarsigner签名

这个插件对于JNLP来说挺有用的。

  • 静态资源压缩

这里介绍的是以YUI Compressor为基础的一个插件,主要功能是可以将工程中的js、css等静态资源压缩,例如:将jquery.js压缩为jquery.min.js。注意,该插件会把工程中的源码(例如jquery.min.js)覆盖掉。

  • 项目配置规范约定

我们知道,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的视频,有兴趣的朋友可以去看看:

http://www.youtube.com/watch?v=bgLag8rxSJE

http://www.youtube.com/watch?v=XVZKLZPewSg

  • 版本发布

加入上面的配置后,执行下面的命令可以做版本预发布:

release:prepare 该命令会根据pom.xml中的scm配置,提交修改记录

如果需要在发布的时候,跳过测试,需要执行下面的命令:

mvn -Darguments="-DskipTests" release:prepare

如果在构建的时候,发生错误,可以利用下面的命令做回滚:

mvn release:rollback

预发布完成后,就可以向Maven仓库做发布了:

mvn -Darguments="-DskipTests" --activate-profiles oss release:perform

  • Docker

docker-maven-plugin该插件支持把Java项目发布到Docker中。

项目地址https://github.com/spotify/docker-maven-plugin

  • 参考

要想自己写一Maven插件的童鞋,可以看这里。

在eclipse中使用Maven插件的常见问题

发表评论

电子邮件地址不会被公开。 必填项已用*标注