Maven打包插件—— maven-dependency-plugin 的使用

最新推荐文章于 2024-05-20 16:40:14 发布
最新推荐文章于 2024-05-20 16:40:14 发布
阅读量1.4k 收藏 3
点赞数
文章标签： java python runtime
原文链接：https://my.oschina.net/LucasZhu/blog/1539468
版权

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

maven-dependency-plugin插件的使用

maven-dependency-plugin是处理与依赖相关的插件。它有很多可用的goal，大部分是和依赖构建、分析和解决相关的goal，这部分goal可以直接用maven的命令操作，例如：mvn dependency:tree、mvn dependency:analyze；这类操作在平时的maven应用中很少会用到。这里主要介绍除此之外的、用得最多的几个操作：copy, copy-dependencies和它们对应的unpack, unpack-dependencies

首先声明插件：

<build>  
    <plugins>  
        <plugin>  
            <groupId>org.apache.maven.plugins</groupId>  
            <artifactId>maven-dependency-plugin</artifactId>  
            <version>2.8</version>  
        </plugin>  
    </plugins>  
</build>

copy 和 unpack

copy操作可以用来将某个（些）maven artifact(s)拷贝到某个目录下。添加phase和goal如下：

 <build>  
    <plugins>  
        <plugin>  
            <groupId>org.apache.maven.plugins</groupId>  
            <artifactId>maven-dependency-plugin</artifactId>  
            <version>2.8</version>  
            <executions>  
                <execution>  
                    <phase>package</phase>  
                    <goals>  
                        <goal>copy</goal>  
                    </goals>  
                </execution>  
            </executions>  
        </plugin>  
    </plugins>  
</build>

然后就是配置，copy可以的配置的项比较多，详细的请参考：copy配置。下面是一些常用项说明：

Name Type Since Description

artifactItemsList1.0Collection of ArtifactItems to work on. (ArtifactItem contains groupId, artifactId, version, type, classifier, outputDirectory, destFileName and overWrite.) See Usage for details.
outputDirectoryFile1.0Default output location used for mojo, unless overridden in ArtifactItem.
Default value is: ${project.build.directory}/dependency.
User property is: outputDirectory.
prependGroupIdboolean2.7Prepend artifact groupId during copy
Default value is: false.
User property is: mdep.prependGroupId.
  • prependGroupId: 用来指示拷出来的library名字需要不需要加上groupId，默认是不加
  • outputDirectory: 用来指定拷出后Libraries的存放地

这里除了artifactItems没有默认值，需要指定外，所有其他的选项都可以被忽略：

<configuration>  
    <artifactItems>  
        <artifactItem>  
            <groupId>junit</groupId>  
            <artifactId>junit</artifactId>  
            <version>4.11</version>  
        </artifactItem>  
    </artifactItems>  
</configuration>

以上配置会将junit包拷到target/dependency目录下，文件名为：junit-4.11.jar。

如果想把它拷到lib目录下，可以如下配置：

 <configuration>  
    <artifactItems>  
        <artifactItem>  
            <groupId>junit</groupId>  
            <artifactId>junit</artifactId>  
            <version>4.11</version>  
        </artifactItem>  
    </artifactItems>  
    <outputDirectory>lib</outputDirectory>  
</configuration>

或者：

<configuration>  
        <artifactItems>  
            <artifactItem>  
                <groupId>junit</groupId>  
                <artifactId>junit</artifactId>  
                <version>4.11</version>  
                <outputDirectory>lib</outputDirectory>  
            </artifactItem>  
        </artifactItems>  
    </configuration>

根据上面的说明，artifactItem里可以有以下几个参数：

  • groupId 
  • artifactId
  • version
  • type
  • classifier
  • outputDirectory
  • destFileName
  • overWrite

同样的参数，artifactItem里的优先级更高，例如：

    <configuration>  
        <artifactItems>  
            <artifactItem>  
                <groupId>junit</groupId>  
                <artifactId>junit</artifactId>  
                <version>4.11</version>  
            </artifactItem>  
            <artifactItem>  
                <groupId>org.slf4j</groupId>  
                <artifactId>slf4j-log4j12</artifactId>  
                <version>1.7.7</version>  
                <outputDirectory>lib2</outputDirectory>  
            </artifactItem>  
        </artifactItems>  
        <outputDirectory>lib</outputDirectory>  
    </configuration>

其中junit会拷到lib目录下，因为它没有定义自己的outputDirectory；slf4j-log4j12会拷到lib2下，因为它定义了自己的outputDirectory。

unpack和copy类似，只不过它会把拷来的包解开，例如：

<executions>  
    <execution>  
        <phase>package</phase>  
        <goals>  
            <goal>unpack</goal>  
        </goals>  
    </execution>  
</executions>  
<configuration>  
    <artifactItems>  
        <artifactItem>  
            <groupId>junit</groupId>  
            <artifactId>junit</artifactId>  
            <version>4.11</version>  
        </artifactItem>  
        <artifactItem>  
            <groupId>org.slf4j</groupId>  
            <artifactId>slf4j-log4j12</artifactId>  
            <version>1.7.7</version>  
            <outputDirectory>lib2</outputDirectory>  
        </artifactItem>  
    </artifactItems>  
    <outputDirectory>lib</outputDirectory>  
</configuration>

则junit和slf4j-log4j12拷完以后，放到lib和lib2下的不再是Jar包，还是Jar包里的内容。 

 

copy-dependencies 和 unpack-dependencies

上面介绍的copy 和 unpack操作是由要拷某个包，这个包需要具体指定要拷哪个包，与当前工程的依赖没有关系。copy-dependencies和它有点类似，但是它是用来拷当前工程的依赖包的，典型的，例如我们有一个web应用，当打成war包的时候，它所有的依赖也需要被打到应用中。

copy-dependencies的参数有很多，详细的可以参考：copy-dependencies Doc，但是几乎所有都有默认值。所以一个最简单的定义如下：

<plugin>  
    <groupId>org.apache.maven.plugins</groupId>  
    <artifactId>maven-dependency-plugin</artifactId>  
    <version>2.8</version>  
    <executions>  
        <execution>  
            <phase>package</phase>  
            <goals>  
                <goal>copy-dependencies</goal>  
            </goals>  
        </execution>  
    </executions>  
</plugin>

这里没有指定任何配置，所有的参数都用默认值，则当前工程的所有依赖（直接、间接的）都会被拷到target/dependency目录下。

也可以使用outputDirectory指定存放在。另外，以下几个参数可以控制哪些依赖将被拷出（或排除）：

Name Type Since Description

excludeArtifactIdsString2.0Comma separated list of Artifact names to exclude.
User property is: excludeArtifactIds.
excludeClassifiersString2.0Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeClassifiers.
excludeGroupIdsString2.0Comma separated list of GroupId Names to exclude.
User property is: excludeGroupIds.
excludeScopeString2.0Scope to exclude. An Empty string indicates no scopes (default).
User property is: excludeScope.
excludeTransitiveboolean2.0If we should exclude transitive dependencies
Default value is: false.
User property is: excludeTransitive.
excludeTypesString2.0Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeTypes.
includeArtifactIdsString2.0Comma separated list of Artifact names to include.
User property is: includeArtifactIds.
includeClassifiersString2.0Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
User property is: includeClassifiers.
includeGroupIdsString2.0Comma separated list of GroupIds to include.
User property is: includeGroupIds.
includeScopeString2.0Scope to include. An Empty string indicates all scopes (default). The scopes being interpreted are the scopes as Maven sees them, not as specified in the pom. In summary:
  • runtime scope gives runtime and compile dependencies,
  • compile scope gives compile, provided, and system dependencies,
  • test (default) scope gives all dependencies,
  • provided scope just gives provided dependencies,
  • system scope just gives system dependencies.

User property is: includeScope.
includeTypes      String2.0Comma Separated list of Types to include. Empty String indicates include everything (default).
User property is: includeTypes.

例如当前工程有以下依赖：

<pluginManagement>
	<plugins>
		<plugin>
			<groupId>org.eclipse.m2e</groupId>
			<artifactId>lifecycle-mapping</artifactId>
			<version>1.0.0</version>
			<configuration>
				<lifecycleMappingMetadata>
					<pluginExecutions>
						<pluginExecution>
							<pluginExecutionFilter>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-dependency-plugin</artifactId>
								<versionRange>[2.0,)</versionRange>
								<goals>
									<goal>copy-dependencies</goal>
								</goals>
							</pluginExecutionFilter>
							<action>
								<ignore />
							</action>
						</pluginExecution>
					</pluginExecutions>
				</lifecycleMappingMetadata>
			</configuration>
		</plugin>
		
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-resources-plugin</artifactId>
			<version>2.6</version>
			<executions>
				<execution>
					<id>copy-resources</id>
					<phase>package</phase>
					<goals>
						<goal>copy-resources</goal>
					</goals>
					<configuration>
						<outputDirectory>${project.build.directory}/${project.artifactId}</outputDirectory>
						<resources>
							<resource>
								<directory>${basedir}/src/main/resources</directory>
							</resource>
						</resources>
					</configuration>
				</execution>
			</executions>
		</plugin>
        <!-- 针对sprong boot web项目打包 -->
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-jar-plugin</artifactId>
			<version>2.6</version>
			<configuration>
				<excludes>
					<exclude>conf/**</exclude>
					<exclude>templates/**</exclude>
					<exclude>static/**</exclude>
				</excludes>
				<argLine>-Dfile.encoding=UTF-8</argLine>
			</configuration>
			<executions>
                <execution>
                        <id>copy-current-jar</id>
                        <phase>package</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <classifier>${project.version}</classifier>
                            <jarName>${project.artifactId}</jarName>
                            <outputDirectory>${project.build.directory}/${project.artifactId}/lib</outputDirectory>
                        </configuration>
                </execution>
            </executions>
		</plugin>
		
		<plugin>
			<artifactId>maven-source-plugin</artifactId>
			<version>2.1</version>
			<executions>
				<execution>
					<phase>compile</phase>
					<goals>
						<goal>jar</goal>
					</goals>
					<configuration>
						<excludes>
							<exclude>conf/**</exclude>
							<exclude>templates/**</exclude>
							<exclude>static/**</exclude>
						</excludes>
					</configuration>
				</execution>
			</executions>
		</plugin>
       <!-- 复制依赖包 -->
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-dependency-plugin</artifactId>
			<version>2.8</version>
			<executions>
				<execution>
					<id>copy</id>
					<phase>package</phase>
					<goals>
						<goal>copy-dependencies</goal>
					</goals>
					<configuration>
					<outputDirectory>${project.build.directory}/${project.artifactId}/lib</outputDirectory>
						<includeScope>compile</includeScope>
					</configuration>
				</execution>
			</executions>
		</plugin>
	</plugins>
</pluginManagement>

要排除所有scope为test的依赖：

<plugin>  
    <groupId>org.apache.maven.plugins</groupId>  
    <artifactId>maven-dependency-plugin</artifactId>  
    <version>2.8</version>  
    <executions>  
        <execution>  
            <phase>package</phase>  
            <goals>  
                <goal>copy-dependencies</goal>  
            </goals>  
        </execution>  
    </executions>  
    <configuration>  
        <includeScope>compile</includeScope>  
    </configuration>  
</plugin>

注意：这里不能<excludeScope>test</excludeScope>，这样会把所有compile级别的也排除。看下图： 

Copied From: Dependencies Scopes

scope/phase->compiletestrunassembly
compileUUUU
providedU!!!
runtime!UUU
test!U!!

说明：最左侧是表示dependency的scope级别，顶行表示maven的阶段，可以看出：compile级别的dependency会在所有阶段都被使用。

 

要排除所有camel的依赖，如下：

 <configuration>  
    <excludeGroupIds>org.apache.camel</excludeGroupIds>  
</configuration>

要排除除camel-spring外的所有其他依赖如下：

 <configuration>  
    <includeArtifactIds>camel-spring</includeArtifactIds>  
</configuration>

 

 

 

 

maven-dependency-plugin

<execution>：执行单元

id:标识

phase:在哪个阶段执行 如 package

goals-goal:执行的操作：copy、copy-dependencies、unpack、unpack-dependencies 四种

<configuration>:执行单元内的配置

type: 类型 jar

includeTypes: jar

outputDirectiry:存放的路径 project.build.directory标识 target目录

excludeTransitive:是否排除间接依赖 默认false 不排除

stripVersion:是否消除依赖jar包后缀的版本信息 默认是false 不取消版本信息

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>2.8</version>
    <executions>
        <execution>
            <id>copy-dependencies</id>
            <phase>package</phase>
            <goals>
                <goal>copy-dependencies</goal>
            </goals>
            <configuration>
                <type>jar</type>
                <includeTypes>jar</includeTypes>
                <outputDirectory>
                    ${project.build.directory}/lib
                </outputDirectory>
                <!-- 是否排除间接依赖 默认false 不排除 -->
                <excludeTransitive>false</excludeTransitive>
                <!-- 是否消除依赖jar包后缀的版本信息 默认是false 不取消版本信息-->
                <stripVersion>false</stripVersion>
            </configuration>
        </execution>
        <execution>
            <id>copy</id>
            <phase>package</phase>
            <goals>
                <goal>copy</goal>
            </goals>
            <configuration>
                <artifactItems>
                    <artifactItem>
                        <groupId>junit</groupId>
                        <artifactId>junit</artifactId>
                        <version>4.11</version>
                    </artifactItem>
                </artifactItems>
                <outputDirectory>
                    ${project.build.directory}/lib/libs
                </outputDirectory>
            </configuration>
        </execution>
        <execution>
            <id>unpack</id>
            <phase>package</phase>
            <goals>
                <goal>unpack</goal>
            </goals>
            <configuration>
                <artifactItems>
                    <artifactItem>
                        <groupId>junit</groupId>
                        <artifactId>junit</artifactId>
                        <version>4.11</version>
                    </artifactItem>
                </artifactItems>
                <outputDirectory>
                    ${project.build.directory}/lib/libs
                </outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

如果：goals-goal:为 copy 或者 unpack 的话 configuration中可以加多个artifactItem 信息 进行打包

copy : 拷贝指定jar包 到指定目录

copy-dependencies : 拷贝依赖jar包 到指定目录

unpack : 解压指定jar包到指定目录

unpack-dependencies : 解压依赖jar包到指定目录

 

 

转载于:https://my.oschina.net/LucasZhu/blog/1539468

weixin_34348111
关注
Maven dependency plugin使用
拾年一剑 的专栏
03-14 6350
本篇博客主要总结了maven dependency plugin的使用，主要介绍copy、copy-dependencies、unpack、get等goals
Maven中的docker-maven-plugin、dockerfile-maven-plugin插件
北辰
04-16 2063
dockerfile-maven-plugin是一个用于构建和推送Docker镜像的Maven插件。
maven-dependency-plugin插件的使用
刘刚的空间
07-17 1588
maven-dependency-plugin是处理与依赖相关的插件。它有很多可用的goal，大部分是和依赖构建、分析和解决相关的goal，这部分goal可以直接用maven的命令操作，例如：mvn dependency:tree、mvn dependency:analyze；这类操作在平时的maven应用中很少会用到。这里主要介绍除此之外的、用得最多的几个操作：copy, copy-depe...
maven插件maven-dependency-plugin的使用
lindana的专栏
12-10 1288
  用maven来管理应用，经常会用到这个插件，他的功能很强大，暂说说他的一个功能吧。就是可以将依赖的jar文件拷贝到你指定的文件夹。 使用例子如下：     &lt;build&gt; &lt;plugins&gt; &lt;plugin&gt; &lt;artifactId&gt;maven-dependency-plugin&lt;/artifactId...
maven打包插件——maven-dependency-plugin
一个努力的小码农
05-20 2131
本文是对`maven-dependency-plugin`常用配置的介绍，maven-dependency-plugin作用：依赖插件提供了操作构件的能力。它可以从本地或远程存储库复制或解压构件到指定位置。它有很多可用的goal，但是我们最常用到的是 `dependency:copy`，`dependency:copy-dependencies`及`dependency:unpack`，`dependency:unpack-dependencies`这四个
dependency-lock-maven-plugin：确保不会意外更改Maven依赖关系的Maven插件
02-04
mvn se.vandmo:dependency-lock-maven-plugin:lock将创建一个dependencies-lock.json文件。 然后，您应该将该文件提交给您选择的源控件。 如果某些依赖项是同一多模块项目的一部分，则您可能希望这些依赖项与锁定...
maven-dependency-plugin-2.8.jar
01-15
maven-dependency-plugin-2.8.jar
基于Java的smart-doc-maven-plugin官方maven插件设计源码
最新发布
05-26
plugin官方maven插件设计源码，包含43个文件，其中包括27个Java源文件、7个Markdown文档、2个JSON文件、1个gitignore文件、1个LICENSE文件、1个NOTICE文件、1个PNG图片文件、1个licenses/LICENSE-living-...
maven打包插件maven-jar-plugin
jishulaozhuanjia的博客
03-20 1426
个人博客导航页（点击右侧链接即可打开个人博客）：大牛带你入门技术栈 项目打包需求描述 1、导出单独的项目jar包(精简，不包含依赖jar） 2、项目依赖的所有jar包导出到lib目录下 3、项目依赖oracle ojdbc8.jar，在maven仓库中并不存在，需要一并导出并添加进MANIFEST.MF文件中的Class-Path。 --也可以将ojdbc8安装到本地maven仓库后直...
Maven 打包插件（1）—— maven-dependency-plugin 的使用方法
HeatDeath的博客
08-13 2289
1、利用maven-dependency-plugin插件使用及场景 https://www.cnblogs.com/lianshan/p/7350614.html 2、dependency:unpack https://maven.apache.org/plugins/maven-dependency-plugin/unpack-mojo.html 3、Unpacking specifi...
maven插件maven-dependency-plugin使用详解
撸啊撸的博客
02-25 5126
maven-dependency-plugin插件时一个依赖管理插件，大部分情况下我们使用它都是和maven-jar-plugin配合来使用，将项目的执行jar和依赖的jar进行分离处理，这样可以减少项目执行jar的大小。除了上面的功能，maven-dependency-plugin还提供了很多其他的操作，下面我们通过实例来看看如何使用这个插件。
maven-dependency-plugin
morning_china的专栏
12-22 353
mvn dependency:list 列出项目最终解析到的依赖列表 mvn dependency:tree 列出项目最终解析到的依赖列表，以树的形式 mvn dependency:analyze mvn dependency:copy-dependencies ...
MAVEN - 使用maven-dependency-plugin的应用场景是什么?
记录并分享
06-14 1749
该插件主要用于管理项目中的依赖，使用该插件可以方便地查看、下载、复制和解压缩依赖，还支持生成依赖树和依赖报告。
maven 打包时复制依赖的jar到指定的文件
BlueMiracle
05-13 2800
org.apache.maven.plugins     maven-dependency-plugin                  copy-dependencies       package               copy-dependencies                      ${project.build.directory}/lib    
请教个 maven-dependency-plugin 的 excludeScope 问题
yh_zeng2的博客
09-26 5891
转载自：《请教个 maven-dependency-plugin 的 excludeScope 问题》 我需求是 copy(copy-dependencies) compile 和 system 范围的依赖。 我想当然的以为这样配置能行 &lt;includeScope&gt;compile&lt;/includeScope&gt; &lt;excludeScope&gt;provided...
Maven学习笔记(十三)-maven-dependency-plugin插件
geejkse_seff的博客
08-20 6560
copy-dependencies和它有点类似，但是它是用来拷当前工程的依赖包的，典型的，例如我们有一个web应用，当打成war包的时候，它所有的依赖也需要被打到应用中。它有很多可用的goal，大部分是和依赖构建、分析和解决相关的goal，这部分goal可以直接用maven的命令操作，例如：mvn dependency:tree、mvn dependency:analyze但是我们最常用到的是。junit和slf4j-log4j12拷完以后，放到lib和libs下的不再是Jar包，还是Jar包里的内容。
cannot find symbol symbol: class HashSet location: class nowcoder_39.m1.Main(compiler.err.cant.resolve.location)
04-28
这个错误提示表明在编译程序时找不到 HashSet 类。可能是因为你没有正确地导入 java.util.HashSet 类，或者你的 JDK 版本太低，不支持该类。 你可以检查你的代码中是否正确导入了 HashSet 类。正确的导入方式为： ```java import java.util.HashSet; ``` 如果你的 JDK 版本太低，建议升级到支持 HashSet 类的版本。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值