maven打包插件:maven-compiler-plugin、maven-dependency-plugin、maven-jar-plugin、maven-resources-plugin详解

屠浩
2023-12-01

最近开发的产品,我们是有四五个maven模块,开发阶段一直是在eclipse中运行的,然后快发版的时候,需要把这些项目打成jar包,通过命令去启动,那首先就得把这些模块项目打包,或者拷贝一些资源文件等等。
1.maven打包,首先在pom文件中加上build属性,和dependencies是同级的:

<build>
	<!--打包出来的文件名,可以不填写,有默认值-->
	<finalName>Test</finalName>
	<plugins>
		<!--这块写插件-->
	</plugins>
<build>

2.maven-compiler-plugin,编译插件,可能会用到的一些配置如下:

<plugin>  
       <groupId>org.apache.maven.plugins</groupId>  
       <artifactId>maven-compiler-plugin</artifactId>  
       <version>3.1</version>  
       <configuration>  
            <source>1.8</source>  
            <target>1.8</target>  
        </configuration>  
</plugin>

3.maven-jar-plugin,打jar包的插件,把整个maven工程打成jar包,可能会用到的一些配置如下:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-jar-plugin</artifactId>
	<version>2.4</version>
	<configuration>
		<archive>
			<!-- 生成的jar中,包含pom.xml和pom.properties这两个文件 -->
			<addMavenDescriptor>true</addMavenDescriptor>
			<!-- 生成MANIFEST.MF的设置 -->
			<manifest>
				<!--这个属性特别关键,如果没有这个属性,有时候我们引用的包maven库
				下面可能会有多个包,并且只有一个是正确的,其余的可能是带时间戳的,
				此时会在classpath下面把那个带时间戳的给添加上去,然后我们
				在依赖打包的时候,打的是正确的,所以两头会对不上,报错。-->
				<useUniqueVersions>false</useUniqueVersions>
				<!-- 为依赖包添加路径, 这些路径会写在MANIFEST文件的Class-Path下 -->	
				<addClasspath>true</addClasspath>
				<!-- 这个jar所依赖的jar包添加classPath的时候的前缀,如果这个
				jar本身和依赖包在同一级目录,则不需要添加-->
				<classpathPrefix>lib/</classpathPrefix>
                <!-- jar启动入口类-->
                <mainClass>com.test.Test</mainClass>
			</manifest>
			<manifestEntries>
				<!-- 在Class-Path下添加配置文件的路径 -->
				<Class-Path>../config/</Class-Path>
				<!-- 假如这个项目可能要引入一些外部资源,但是你打包的时候并不想把
				这些资源文件打进包里面,这个时候你必须在这边额外指定一些这些资源
				文件的路径,这个位置指定的话,要根据你预期的这些位置去设置,我这边
				所有jar都在lib下,资源文件都在config下,lib和config是同级的 -->
				<!-- 同时还需要注意另外一个问题,假如你的pom文件里面配置了
				<scope>system</scope>,就是你依赖是你本地的资源,这个时候使用
				这个插件,classPath里面是不会添加,所以你得手动把这个依赖添加进
				这个地方,用空格隔开就行-->
			</manifestEntries>
		</archive>
		<!-- jar包的位置-->
		<outputDirectory>${project.build.directory}/lib</outputDirectory>
		<includes>
			<!-- 打jar包时,只打包class文件 -->
			<!-- 有时候可能需要一些其他文件,这边可以配置,包括剔除的文件等等-->
			<include>**/*.class</include>
		</includes>
	</configuration>
</plugin>

4.maven-dependency-plugin,用来拷贝项目所有依赖的插件,可能会用到的一些配置如下:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-dependency-plugin</artifactId>
	<executions>
		<execution>
			<id>copy-dependencies</id>
			<phase>package</phase>
			<goals>
				<goal>copy-dependencies</goal>
			</goals>
			<configuration>
				<!-- 拷贝项目依赖包到lib/目录下 -->
				<outputDirectory>${project.build.directory}/lib</outputDirectory>
				<!-- 间接依赖也拷贝 -->
				<excludeTransitive>false</excludeTransitive>
				<!-- 带上版本号 -->
				<stripVersion>false</stripVersion>
			</configuration>
		</execution>
	</executions>
</plugin>

5.maven-resources-plugin,用来拷贝项目中的一些资源文件,可能会用到的一些配置如下:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-resources-plugin</artifactId>
	<version>2.6</version>
	<executions>
		<!-- 一个execution就是一个目标输入位置,如果想把各种资源拆开放的话,就
		可以创建多个execution,一个资源文件可以被拷贝多份 -->
		<execution>
			<id>copy-resources</id>
			<phase>package</phase>
			<goals>
				<goal>copy-resources</goal>
			</goals>
			<configuration>
				<encoding>UTF-8</encoding>
				<!-- 资源文件的输出目录 -->
				<outputDirectory>{project.build.directory}/config</outputDirectory>
				<resources>
					<!-- 资源文件的原始目录,有多个的话就多配几个 -->
					<resource>
						<!-- 原始目录 -->
						<directory>src/main/resources</directory>
						<!-- 是否使用过滤器,如果是的话,需要配置一下才行
						这个后续再研究,这边没有使用到 -->
						<filtering>true</filtering>
						<!-- 包含哪些文件以及去除调哪些文件等等 -->
						<includes>
							<include>**/*.*</include>
						</includes>
						<excludes>
							<exclude>**/*.json</exclude>
						</excludes>
					</resource>
				</resources>
			</configuration>
		</execution>
	</executions>
</plugin>

关于资源文件拷贝,注意一个小问题,平时用eclipse开发的话,默认的classPath其实就是target/classes,默认情况下,eclipse也会把一些在src/main/resources下的资源文件拷贝到这个目录下,但是如果你配了上述资源拷贝插件,只会按你配置的来,我配置上述插件是为了在非eclipse环境下运行的,但是这样影响到了eclipse的运行,所以呢,需要额外再配置一个execution,拷贝到classes目录下即可

注意:上面说的这个,在IDEA中不会有这个问题,因为IDEA每次启动都会自己build一下,会完全一部分事情,保证项目能够运行。

以上就是这4个插件,后续如果还有其余插件或者这些插件中一些新内容,会及时添加。关于一些文件的输出目录,一定要根据自己的需求来,先明白自己想要什么,再去配置,或者两者互相迭代吧。

  1. maven-war-plugin,war包打包插件,一般也不用指定,默认都会用的。只不过在针对一些快照版本的依赖包,打出来的文件,WEB-INFO/lib下面的jar包,都会带一些时间戳,经过下面的配置,打出来的就不带时间戳了。
<plugin>
	<artifactId>maven-war-plugin</artifactId>
	<version>2.6</version>
	<configuration>
		<outputFileNameMapping>@{artifactId}@-@{baseVersion}@.@{extension}@</outputFileNameMapping>
	</configuration>
</plugin>
 类似资料: