Maven各scope使用情况介绍

你的名字 2023-02-25 10:23 8阅读 0赞

compile：默认的scope。任何定义在compile scope下的依赖将会在所有的class paths下可用。maven工程会将其打包到最终的artifact中。如果你构建一个WAR类型的artifact，那么在compile scope下引用的JAR文件将会被集成到WAR文件内。

provided：这个scope假定对应的依赖会由运行这个应用的JDK或者容器来提供。最好的例子就是servlet API。任何在provided scope下定义的依赖在构建时的类路径里是可用的，但是不会被打包到最终的artifact中。如果是一个WAR的文件，servlet API在构建时的类路径里是可用的，但是并不会被打包到WAR文件中。

runtime：在runtime scope下定义的依赖只会在运行期可用，而在构建期的类路径下不可用。这些依赖将会被打包到最终的artifact中。比如你有一个基于web的应用需要在运行时访问MySQL数据库。你的代码没有任何MySQL数据库驱动的硬依赖。你的代码仅仅是基于JDBC API来编写，在构建期并不需要MySQL数据库驱动。然而，在运行期，就需要相应的驱动来操作MySQL数据库了。因此，这个驱动应该被打包到最终的artifact中。

test：只用于测试变异的依赖（比如JUnit），execution必须定义在test scope下。这些依赖不会被打包到最终的artifact中。

system：于provided scope很像。唯一的区别在于，在system scope中，你需要告诉Maven如何去找到这个依赖。如果你要引用的依赖在Maven仓库中不存在时，就可以用这个scope。不推荐使用system依赖。

import：从其它的pom文件中导入依赖设置。

### maven scope import详解： ###

想必大家在做SpringBoot应用的时候，都会有如下代码：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>&lt;parent&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;artifactId&gt;spring-boot-starter-parent&lt;/artifactId&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;version&gt;1.3.3.RELEASE&lt;/version&gt;</code> <code>&lt;/parent&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

假如说，我不想继承，或者我想继承多个，怎么做？

我们知道Maven的继承和[Java][]的继承一样，是无法实现多重继承的，如果10个、20个甚至更多模块继承自同一个模块，那么按照我们之前的做法，这个父模块的dependencyManagement会包含大量的依赖。如果你想把这些依赖分类以更清晰的管理，那就不可能了，import scope依赖能解决这个问题。你可以把dependencyManagement放到单独的专门用来管理依赖的pom中，然后在需要使用依赖的模块中通过import scope依赖，就可以引入dependencyManagement。例如可以写这样一个用于依赖管理的pom：

<project>
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.test.sample</groupId>
 <artifactId>base-parent1</artifactId>
 <packaging>pom</packaging>
 <version>1.0.0-SNAPSHOT</version>
 <dependencyManagement>
 <dependencies>
 <dependency>
 <groupId>junit</groupId>
 <artifactid>junit</artifactId>
 <version>4.8.2</version>
 </dependency>
 <dependency>
 <groupId>log4j</groupId>
 <artifactid>log4j</artifactId>
 <version>1.2.16</version>
 </dependency>
 </dependencies>
 </dependencyManagement>
 </project>

然后我就可以通过非继承的方式来引入这段依赖管理配置

<dependencyManagement>
 <dependencies>
 <dependency>
 <groupId>com.test.sample</groupId>
 <artifactid>base-parent1</artifactId>
 <version>1.0.0-SNAPSHOT</version>
 <type>pom</type>
 <scope>import</scope>
 </dependency>
 </dependencies>
 </dependencyManagement>
 
 <dependency>
 <groupId>junit</groupId>
 <artifactid>junit</artifactId>
 </dependency>
 <dependency>
 <groupId>log4j</groupId>
 <artifactid>log4j</artifactId>
 </dependency>

注意：import scope只能用在dependencyManagement里面

这样，父模块的pom就会非常干净，由专门的packaging为pom来管理依赖，也契合的面向对象设计中的单一职责原则。此外，我们还能够创建多个这样的依赖管理pom，以更细化的方式管理依赖。这种做法与面向对象设计中使用组合而非继承也有点相似的味道。

那么，如何用这个方法来解决SpringBoot的那个继承问题呢？

配置如下：

<dependencyManagement>
 <dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-dependencies</artifactId>
 <version>1.3.3.RELEASE</version>
 <type>pom</type>
 <scope>import</scope>
 </dependency>
 </dependencies>
 </dependencyManagement>
 
 <dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 </dependencies>

这样配置的话，自己的项目里面就不需要继承SpringBoot的module了，而可以继承自己项目的module了。

[Java]: http://lib.csdn.net/base/javase