Maven scope 依赖范围详解

桃扇骨 2023-02-20 05:58 13阅读 0赞

Maven的生命周期存在编译、测试、运行、打包这些过程，那么显然有些依赖只用于测试（test），比如 `junit` ；  
有些依赖编译用不到，只有运行的时候才能用到（ runtime ），比如 mysql 驱动包在编译期就用不到，而是在运行时用到的；  
还有些依赖在编译期要用到，而运行期不需要提供（provided），因为有些容器已经提供了，比如 `servlet-api` 在 tomcat 中已经提供了，我们只需要的是编译期提供而已。

总结说来，在POM 4中，`<dependency>`中还引入了`<scope>`，它主要管理依赖的部署。大致有 `compile、provided、runtime、test、system` 等几个。

1.  compile：默认的scope，参与当前项目的编译、测试、运行、打包等 **全过程** 参与。 （程序员写的业务代码）
2.  provided：编译、测试阶段存在，不会打入包中。（`servlet-api.jar`、`JDK`）
3.  runtime：编译不需要，在运行、打包阶段参与。（`mysql.jar` 驱动）
4.  test：测试需要，不会打入包中。（`junit.jar`）
5.  system：不是从本地maven仓库引入，而是在本地目录的下的jar，与provided 相似 。**一般不使用。** （oracle 驱动 `ojdbc14.jar`）

<dependency>
        <groupId>groupId</groupId>
        <artifactId>artifactId</artifactId>
        <version>N</version>
        <scope>...</scope>
    </dependency>

### 1.1、compile 模式 （默认，全过程参与） ###

默认就是 compile。

compile 需要参与当前项目的编译、测试、运行、打包。

### 1.2、provided（编译、测试阶段存在，打包时排除） ###

provided 只存在编译、运行、测试阶段，打包是不用包括进去，打包阶段做了 exclude 动作，因为别的容器能提供对应的依赖。

应用场景：

定义了一个Servlet，此时需要`servlet-api.jar` 才能编译成功，但是当你达成war 包时，你并不想将 `servlet-api.jar` 包进去，因为Tomcat等容器会提供。此时用到 provided 。

provided 只在编译、运行、测试阶段，打包是不用包进去，打包阶段做了排除。

provided 打包的时候可以不用包含进去，因为别的容器（Web Container）会提供。

阿里开发规范文档：如果依赖其它二方库，尽量是 provided 引入，让二方库使用者去依赖具体版本号； 无 log 具体实现，只依赖日志框架。

例如 ： 添加 `<scope>provided</scope>` ，因为provided表明该包只在编译和测试的时候用，所以，当启动tomcat 的时候，就不会冲突了。

<dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>1.0-alpha-1</version>
        <scope>provided</scope>
    </dependency>

### 1.3、runtime 模式（跳过编译，运行和打包参与） ###

runtime 表示被依赖项目无需参与项目的编译，不过后期的测试、运行和打包周期需要其参与。

与compile相比，runtime 跳过编译而已。

比如，你可能在编译的时候只需要 `JDBC API JAR`，而只有在运行的时候才需要 JDBC 驱动实现。

编译时该包不参与，运行时参与。

### 1.4、test 模式（测试阶段有效） ###

test 范围依赖 在一般的编译和运行时都不需要，它们只有在测试编译和测试运行阶段可用。比如

<dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <scope>test</scope>
    </dependency>
    
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <scope>test</scope>
    </dependency>

### 1.5、system (依赖于本地目录中，与provided 相似) ###

system 不是依赖于 maven仓库、本地maven仓库，而是从本地磁盘指定路径下寻找，需要 systemPath 属性。

与 provided 相似，不过不依赖maven仓库，而是从本地文件系统读取。

1）方式1、引入本地磁盘目录下的jar包

<dependency>
        
        <groupId>com.im</groupId> 
        
        <artifactId>sdk</artifactId>   
        
        <version>1.0</version>
        
        <scope>system</scope>
        
        <systemPath>${basedir}/lib/sdk-1.0.jar</systemPath>
    </dependency>

2）方式2、编译阶段指定外部 lib

<plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.1.2</version>
        
        <configuration>
            <source>1.8</source>
            <target>1.8</target>
            <encoding>UTF-8</encoding>
            
            <compilerArguments>
                
                <extdirs>lib</extdirs>
            </compilerArguments>        
        </configuration>
    </plugin>

## 2、将外部 jar 导入本地 maven 仓库 ##

有一些收费的，或都其他途径获取的jar 在maven仓库中不存在， 如果想通过maven使用时，可以先将jar导入到本地的maven仓库中，如下：

mvn install:install-file -DgroupId=com.oracle -DartifactId=ojdbc14  -Dversion=10.2.0.5.0 -Dpackaging=jar -Dfile=.\ojdbc14_10.2.0.5.0.jar

再引入jar包：

<dependency>
        <groupId>com.oracle</groupId>
        <artifactId>ojdbc14</artifactId>
        <version>10.2.0.5.0</version>
    </dependency>

## 3、maven预定义内置属性 ##

${basedir}          表示项目根目录,即包含 pom.xml 文件的目录;
    ${version}          表示项目版本;
    ${project.basedir}  同${basedir};
    ${project.baseUri}  表示项目文件地址;
    ${maven.build.timestamp}  表示项目构件开始时间;
    ${maven.build.timestamp.format}  表示属性 ${maven.build.timestamp}  的展示格式,默认值为 yyyyMMdd-HHmm ,可自定义其格式

## 4、scope 的传递依赖 ##

A -> B -> C, 当前项目 A，A依赖于B，B依赖于C，知道B在A中的scope，怎么知道 C在 A 中的 scope，
    即，A需不需要 C的问题，本质由 C在B中的scope决定
    当 C 在 B 中的scope 是test 或 provided 时，C 直接被丢弃，A不依赖C
    否则 A 依赖 C，C的scope 继承与B 的scope