Maven的依赖范围

Maven的依赖构件包含一个依赖范围属性,这个属性描述的是三套classpath的控制,即编译、测试、运行。

举个例子Junit依赖只是在测试范围(classpath)使用,而在运行的时候不使用,还有Servlet api在编译的时候使用,在运行部署的时候不使用,因为大部分容器都已经提供该依赖支持。

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

下面对Maven依赖范围进行逐一说明:


1. compile: 编译依赖范围。 

 默认的依赖范围,使用此依赖范围会对编译、测试、运行三套classpath都有效。


2. test: 测试依赖范围。

 使用此依赖范围只会对测试有效。比如 Junit


3. provided: 已提供的依赖范围。

 使用此依赖范围会对编译和测试有效,对运行无效。比如 Servlet-api ,运行的时候容器已经提供


4. runtime: 运行时的依赖范围。

 使用此依赖范围会对测试和运行有效,对于编译无效。 比如 JDBC驱动依赖


5. system: 系统依赖范围。

 和provided依赖范围完全一样,由于此类依赖不是通过Maven仓库解析的,而是和本机系统绑定的,使用后可能会造成不可移植性,请谨慎使用此种依赖范围。


6. import: 导入依赖范围。

 该依赖不会对三套classpath产生影响。这种依赖范围只会在<dependencyManagement>标签中使用,意思是说使用此种依赖范围通常是指向一个POM类型的Maven项目,将依赖一个POM类型的项目中的所有依赖全部导入到目标项目中来,是除了复制依赖、继承依赖的另外一种使用依赖的方式,可以说Maven还是非常的灵活的。

### Maven Dependency Scope 的作用及使用指南 Maven 的 `<scope>` 标签用于控制依赖项在项目构建生命周期中的可见性和使用范围,它决定了依赖在编译、测试、运行等不同阶段是否可用,以及是否会被打包进最终的构建产物中。 #### 1. `compile` 这是 Maven 的默认作用域,如果 `<dependency>` 没有显式声明 `<scope>`,则默认使用 `compile`。该作用域适用于所有构建阶段,并且会随着项目一起发布。当前项目中所有模块都可以直接引用被修饰的依赖,并且该依赖可以通过传递依赖的方式被其他项目引用 [^1]。 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.6.0</version> </dependency> ``` #### 2. `provided` `provided` 作用域类似于 `compile`,但它期望由 JDK、容器或使用者提供该依赖。例如,`servlet-api` 和 `jsp-api` 这类依赖通常由应用服务器提供,因此不需要打包进应用中 [^2]。 ```xml <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.1</version> <scope>provided</scope> </dependency> ``` #### 3. `runtime` `runtime` 作用域表示该依赖在编译阶段不需要,但在运行和测试阶段是必需的。典型示例是 JDBC 驱动,它在编译时只需要接口,而在运行时才需要具体的实现 [^2]。 ```xml <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.27</version> <scope>runtime</scope> </dependency> ``` #### 4. `test` `test` 作用域用于测试阶段的依赖,例如 JUnit 或 TestNG,它们仅在编译和运行测试代码时使用,不会随项目发布 [^2]。 ```xml <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.13.2</version> <scope>test</scope> </dependency> ``` #### 5. `system` `system` 作用域类似于 `provided`,但需要显式提供依赖的 JAR 文件路径,Maven 不会在本地仓库或远程仓库中查找该依赖。这种方式不推荐使用,因为它破坏了 Maven依赖管理机制 。 ```xml <dependency> <groupId>com.example</groupId> <artifactId>custom-lib</artifactId> <version>1.0</version> <scope>system</scope> <systemPath>${project.basedir}/lib/custom-lib.jar</systemPath> </dependency> ``` #### 6. `import`(仅用于 `<dependencyManagement>`) `import` 是 Maven 2.0.9 引入的新作用域,仅用于 `<dependencyManagement>` 部分,用于导入其他 POM 文件中的依赖管理配置。它不会直接参与依赖的传递性控制,而是将指定 POM 的 `<dependencyManagement>` 内容合并到当前 POM 中 [^3]。 ```xml <dependencyManagement> <dependencies> <dependency> <groupId>com.example</groupId> <artifactId>shared-dependencies</artifactId> <version>1.0.0</version> <scope>import</scope> <type>pom</type> </dependency> </dependencies> </dependencyManagement> ``` #### 使用场景与建议 - 对于项目核心依赖,使用 `compile`。 - 对于运行环境已经提供的依赖,使用 `provided`。 - 对于运行时才需要的依赖,使用 `runtime`。 - 对于测试相关的依赖,使用 `test`。 - 尽量避免使用 `system`,以保持依赖管理的一致性。 - 使用 `import` 可以统一多个模块之间的依赖版本管理,提升项目的可维护性。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值