Maven依赖作用域和依赖传递的使用

更新时间：2023年06月02日 08:57:35 作者：守望时空33

本文主要介绍了Maven依赖作用域和依赖传递的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

1，依赖作用域

通过在每个dependency中设定scope字段，即可声明其作用域，例如：

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.28</version>
	<!-- 声明作用域 -->
	<scope>provided</scope>
</dependency>

上面我们就设定了lombok这个依赖的作用域为provided。

常用的作用域字段值及其意义如下：

compile 这是默认的scope（即你不写scope字段的话，这个依赖作用域就是compile），表示依赖在编译、测试和运行时都是可用的，并且会参与项目的打包过程，该依赖会传递给依赖该模块的其他模块
provided 表示依赖在编译和测试时是可用的，但该依赖不会参与程序运行阶段，即程序运行时无法调用该依赖中的类，它不会参与项目的打包过程，也不会传递给其他模块
runtime 表示依赖仅在运行时是可用的，但在编译和测试时不需要，它会传递给依赖该模块的其他模块，但不会参与项目的打包过程
test 表示依赖只在测试和运行时使用，不会参与项目的打包过程，也不会传递给其他模块

可见一个Maven项目，从编译到运行会经历三个阶段：编译 → 测试 → 运行

不同作用域在三个阶段的可见性如下表：

	编译时可用	测试时可用	运行时可用
`compile`	√	√	√
`provided`	√	√	x
`runtime`	x	√	√
`test`	x	√	x

2，作用域和打包

我们常常会使用maven-assembly-plugin插件，让我们在打包的时候将所有的依赖都打包至最后的jar文件中，使得jar文件可以直接运行。

不过真的是所有的依赖都会被打包到最后的jar中吗？

其实并不是，在使用maven-assembly-plugin插件插件时，默认只有scope为compile和runtime的依赖才会被包含在最终的结果中。

因此，为了减小最终jar的大小，我们应当将运行时不需要的依赖设置为provided或者test，当然这也是根据用途选择。

例如lombok依赖会在编译的时候生成getter和setter的代码，但是运行的时候这个依赖就不需要了，因此它常常被设定为provided。

但是在Spring Boot开发中就不一样了，Spring Boot工程中，使用的是spring-boot-maven-plugin，这个插件也能完成同样的目的，即打包时将所有的依赖全部打包到一个jar中，但是这个插件会将所有的依赖都打包进去，无论其scope是什么。

不过，我们可以在这个插件中进行配置，声明打包时需要排除的依赖，例如：

<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
	<configuration>
		<excludes>
			<!-- 打包时排除lombok依赖 -->
			<exclude>
				<groupId>org.projectlombok</groupId>
				<artifactId>lombok</artifactId>
			</exclude>
		</excludes>
	</configuration>
</plugin>

3，依赖的传递

事实上，在Maven中，依赖也是会传递的，我们先创建一个名为first的项目，并引入lombok依赖如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.gitee.swsk33</groupId>
	<artifactId>first</artifactId>
	<version>1.0.0</version>
	<properties>
		<java.version>17</java.version>
		<maven.compiler.source>${java.version}</maven.compiler.source>
		<maven.compiler.target>${java.version}</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>
	<dependencies>
		<!-- 引入lombok依赖 -->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.28</version>
		</dependency>
	</dependencies>
</project>

这是项目first的pom.xml文件，其groupId为com.gitee.swsk33，其artifactId为first，其版本为1.0.0，现在在其工程目录下执行mvn clean install安装至本地仓库使得待会可以引用它。

现在在新建项目second，并引用上述的first作为依赖，如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.gitee.swsk33</groupId>
	<artifactId>second</artifactId>
	<version>1.0.0</version>
	<properties>
		<java.version>17</java.version>
		<maven.compiler.source>${java.version}</maven.compiler.source>
		<maven.compiler.target>${java.version}</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>
	<dependencies>
		<!-- 引用first项目 -->
		<dependency>
			<groupId>com.gitee.swsk33</groupId>
			<artifactId>first</artifactId>
			<version>1.0.0</version>
		</dependency>
	</dependencies>
</project>

好的，现在展开IDEA左侧栏的外部库部分，看看second项目的依赖：

可见second项目仅仅是引入了first项目，但为什么外部库中包含了lombok依赖呢？这是因为first依赖lombok，而second依赖first时，lombok也被传递给了second。

同样地，如果现在又有一个项目third依赖second呢？那么third也会间接依赖lombok，也可以使用lombok中的类。

当然，依赖并不总是会传递的，有下列因素会影响依赖传递。

(1) scope作用域

scope不仅仅代表这个依赖的作用域，也会影响依赖的传递，只有scope为compile和runtime的依赖是会传递的。

假设现在把上述first项目中的lombok依赖scope改成provided或者test，然后重新执行mvn clean install，你就会发现在second的依赖中，就看不到lombok了！

(2) optional字段

除了scope之外，还可以设定依赖的optional字段，当设定为true时代表这个依赖是可选的，那么这时无论其scope是什么，这个依赖都不会传递。默认情况下，即不声明依赖的optional字段时，它的值是false。

现在将first中的lombok依赖的optional字段声明为true：

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.28</version>
	<optional>true</optional>
</dependency>

然后重新mvn clean install，再次打开second项目，你就会发现lombok依赖就没有传递过来了！

所以如果在制作外部库需要其他人引用的时候，我们可以将一些仅仅是外部库需要使用但是其它项目不一定要使用的依赖的optional设定为true，避免其他开发者引入你的外部库时发生依赖冲突。

到此这篇关于Maven依赖作用域和依赖传递的使用的文章就介绍到这了,更多相关Maven依赖作用域和依赖传递内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

浅谈Maven 依赖作用域实战避坑指南

详解如何在SpringBoot控制器中处理用户数据
在 Spring Boot 应用开发中,控制器（Controller）扮演着至关重要的角色,它负责接收用户请求、处理数据并返回响应,本文将深入浅出地讲解如何在 Spring Boot 控制器中处理用户数据,包括获取请求参数、处理表单提交、返回 JSON 数据等常见场景,需要的朋友可以参考下
2025-05-05
@DS注解的使用,动态数据源,事务详解
在项目中使用多数据源时,可以借助苞米豆的dynamic-datasource-spring-boot-starter进行配置,首先需引入相应的jar包,并在application.yml中设置主从数据源,其中一般选择master作为默认数据源,在实现类中通过@DS注解指定数据源
2024-09-09
java数组排列组合问题汇总
这篇文章主要为大家详细汇总了java数组排列组合问题，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-02-02
Java实现平滑加权轮询算法之降权和提权详解
所有负载均衡的场景几乎都会用到这个平滑加权轮询算法,下面这篇文章主要给大家介绍了关于Java实现平滑加权轮询算法之降权和提权的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
2022-04-04
四个Java必须知道的负载均衡算法分享
我们在设计系统的时候，为了系统的高扩展性，会创建无状态的系统。但是，要使系统具有更好的可扩展性，除了无状态设计之外，还要考虑采用什么负载均衡算法，本文就带领大家认识以下常见的4种负载均衡算法
2023-01-01
Java截取PDF内容为图片的实现代码
本文主要介绍了java实现截取PDF指定页并进行图片格式转换功能的技术要点,通过实例代码,文章详细地介绍了如何使用java语言来实现PDF指定页的截取和图片格式转换,需要的朋友可以参考下
2025-10-10
Redis中String字符串和sdshdr结构体超详细讲解
这篇文章主要介绍了Redis中String字符串和sdshdr结构体，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-04-04
使用Java实现类似Comet风格的web app
这篇文章主要介绍了使用Java实现类似Comet风格的web app的方法,包括客户端的响应和XML解析等功能,需要的朋友可以参考下
2015-11-11
Spring Boot配置过滤器的2种方式示例
这篇文章主要给大家介绍了关于Spring Boot配置过滤器的2种方式，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-09-09
java 创建线程的四种方式
这篇文章主要介绍了java 创建线程的四种方式，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
2020-11-11