Maven插件介绍

最新推荐文章于 2024-08-18 21:36:31 发布

chuannaoxuan4674

最新推荐文章于 2024-08-18 21:36:31 发布

阅读量133

点赞数

文章标签： java javascript 开发工具 ViewUI

原文链接：https://my.oschina.net/surenpi/blog/816769

版权

介绍

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

缺省变量

${basedir} 项目根目录

编译

[codesyntax lang="xml"]

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-compiler-plugin</artifactId>
	<version>3.1</version>
	<configuration>
		<source>1.6</source>
		<target>1.6</target>
		<encoding>UTF-8</encoding>
	</configuration>
</plugin>

[/codesyntax]

生成可执行jar包

[codesyntax lang="xml"]

<build>
	<finalName>surenpi.com.toolkit</finalName>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-jar-plugin</artifactId>
			<version>2.4</version>
			<configuration>
				<archive>
					<manifest>
						<addClasspath>true</addClasspath>
						<classpathPrefix>lib</classpathPrefix>
						<mainClass>org.suren.main.StartUp</mainClass>
					</manifest>
				</archive>
			</configuration>
		</plugin>
	</plugins>
</build>

[/codesyntax] 上面的finalName当然就是生成的文件名前缀了（surenpi.com.toolkit.jar），manifest的内容就是jar文件中的manifest了。更多有关该插件的内容，请看这里。

拷贝依赖

下面的配置会将所有的maven依赖jar文件拷贝到项目的target目录下 [codesyntax lang="xml"]

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-dependency-plugin</artifactId>
	<executions>
		<execution>
			<id>copy</id>
			<phase>package</phase>
			<goals>
				<goal>copy-dependencies</goal>
			</goals>
			<configuration>
				<outputDirectory>${project.build.directory}</outputDirectory>
			</configuration>
		</execution>
	</executions>
</plugin>

[/codesyntax] 下面的配置会将所有的maven依赖的包结构拷贝到生成的jar文件中，并添加manifest信息 [codesyntax lang="xml"]

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<executions>
		<execution>
			<id>make-assembly</id>
			<goals>
				<goal>single</goal>
			</goals>
			<phase>package</phase>
			<configuration>
				<descriptorRefs>
					<descriptorRef>jar-with-dependencies</descriptorRef>
				</descriptorRefs>
				<archive>
					<addMavenDescriptor>true</addMavenDescriptor>
					<manifest>
						<mainClass>org.suren.main.StartUp</mainClass>
					</manifest>
				</archive>
			</configuration>
		</execution>
	</executions>
</plugin>

[/codesyntax]

jarsigner签名

[codesyntax lang="xml"]

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-jar-plugin</artifactId>
	<version>2.4</version>
	<executions>
		<execution>
			<id>sign</id>
			<goals>
				<goal>sign</goal>
			</goals>
			<phase>install</phase>
			<configuration>
				<alias>suren</alias>
				<storepass>suren</storepass>
				<keystore>${basedir}/key</keystore>
				<jarPath>${project.build.directory}/${project.build.finalName}-jar-with-dependencies.jar
				</jarPath>
			</configuration>
		</execution>
	</executions>
</plugin>

[/codesyntax] 这个插件对于JNLP来说挺有用的。

静态资源压缩

这里介绍的是以YUI Compressor为基础的一个插件，主要功能是可以将工程中的js、css等静态资源压缩，例如：将jquery.js压缩为jquery.min.js。注意，该插件会把工程中的源码（例如jquery.min.js）覆盖掉。 [codesyntax lang="xml"]

<plugin>
	<groupId>net.alchim31.maven</groupId>
	<artifactId>yuicompressor-maven-plugin</artifactId>
	<version>1.3.0</version>
	<executions>
		<execution>
			<phase>package</phase>
			<goals>
				<goal>compress</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<encoding>UTF-8</encoding>
		<jswarn>false</jswarn>
		<force>false</force>
		<suffix>.min</suffix>
		<linebreakpos>-1</linebreakpos>
		<sourceDirectory>${basedir}/src/main/resources</sourceDirectory>
		<includes>
			<include>**/component/**/js/*.js</include>
			<include>**/component/**/css/*.css</include>
		</includes>
		<excludes>
			<exclude>**/component/**/js/*.min.js</exclude>
			<exclude>**/component/**/css/*.min.css</exclude>
		</excludes>
		<outputDirectory>${basedir}/src/main/resources</outputDirectory>
	</configuration>
</plugin>

[/codesyntax]

项目配置规范约定

我们知道，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： [codesyntax lang="xml" lines="normal"]

<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>

[/codesyntax] 上述代码中使用了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，如： [codesyntax lang="xml" lines="normal"]

<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>

[/codesyntax] 上述代码中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

参考

要想自己写一Maven插件的童鞋，可以看这里。在eclipse中使用Maven插件的常见问题

转载于:https://my.oschina.net/surenpi/blog/816769

chuannaoxuan4674

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Maven插件介绍

介绍 Maven之所以流行，除了它由包管理的能力外，非常重要的一点就是它的插件机制。幸运滴是，现在已经有很多好用的插件可以直接拿来的。本文总结了一些常用的插件。缺省变量 ${basedir} 项目根目录编译 [codesyntax lang=...
复制链接

扫一扫