在 Maven 項目中，所有依賴通常都在 pom.xml 中通過 dependency 聲明。但并不是所有依賴在項目生命周期的各個階段都需要使用。例如，有些依賴只在 編譯階段使用，有些只在 運行階段使用，還有一些只在 測試階段使用。

為了解決這一問題，Maven 提供了 依賴作用域（Dependency Scope） 機制。
scope 用于定義依賴在 編譯、運行、測試和打包階段是否生效，從而決定該依賴是否會被加入到對應(yīng)階段的 類路徑（classpath） 中。如果不顯式指定 scope，默認(rèn)值為：

一、Maven 的依賴管理機制

在 Maven 項目中，所有依賴都通過 pom.xml 文件聲明，例如：

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>6.0.0</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

 如果不顯式指定 scope，默認(rèn)值為：

compile

當(dāng) Maven 構(gòu)建項目時，會自動完成以下工作：

• 讀取 pom.xml 中定義的依賴
• 從遠(yuǎn)程倉庫下載依賴
• 將依賴緩存到本地倉庫

本地倉庫位置：

~/.m2/repository

隨后 Maven 會在 不同構(gòu)建階段 將這些依賴加入不同的類路徑中。 

二、什么是類路徑（Classpath）

在 Java 中，類路徑（Classpath） 是 JVM 或 Java 編譯器用于查找 .class 文件和依賴庫的位置集合。

簡單來說：

類路徑就是 Java 程序在運行或編譯時，用來查找類文件的路徑列表。

類路徑通常包含以下幾種資源：

• 項目編譯后的 .class 文件
• 第三方依賴庫（jar）
• 項目資源文件（resources）

如果某個類不在類路徑中，程序就會出現(xiàn)典型錯誤：

ClassNotFoundException
NoClassDefFoundError

而 Maven 的核心作用之一，就是 自動管理這些類路徑依賴。

三、Maven 常見的五種 scope

Maven 常見的依賴作用域主要包括以下幾種。

1 compile（默認(rèn)作用域）

compile 是 Maven 的 默認(rèn)作用域，如果不寫 scope，依賴默認(rèn)就是 compile。

特點：

• 編譯階段可用
• 運行階段可用
• 測試階段可用
• 打包時會被包含

例如：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
</dependency>

Spring 框架依賴通常就是 compile。

適用于：

• 項目核心依賴
• 應(yīng)用運行必須依賴的庫

2 provided

provided 表示 編譯時需要，但運行時由外部環(huán)境提供。

特點：

• 編譯階段可用
• 運行階段不可用
• 不會被打包

典型例子：

Servlet API

例如：

<dependency>
    <groupId>jakarta.servlet</groupId>
    <artifactId>jakarta.servlet-api</artifactId>
    <scope>provided</scope>
</dependency>

原因是：

Tomcat / Jetty 已經(jīng)提供 Servlet API

如果再打包進(jìn)去就會沖突。

3 runtime

runtime 表示 編譯時不需要，但運行時需要。

特點：

• 編譯階段不可用
• 運行階段可用
• 會被打包

典型例子：

JDBC驅(qū)動

例如：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <scope>runtime</scope>
</dependency>

原因：

編譯代碼只依賴：

java.sql

但運行數(shù)據(jù)庫時需要：

java.sql

4 test

test 作用域只在 測試階段生效。

特點：

• 編譯主代碼不可用
• 運行主程序不可用
• 僅在測試代碼中可用

例如：

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

適用于：

JUnit
Mockito
TestNG

這些庫只在測試時使用。

5 system

system 依賴是 Maven 早期提供的一種方式，用于 引用本地 jar 包。

例如：

<dependency>
    <groupId>example</groupId>
    <artifactId>example-lib</artifactId>
    <scope>system</scope>
    <systemPath>D:/libs/example.jar</systemPath>
</dependency>

缺點：

• 不參與 Maven 依賴管理
• 不可移植

因此 基本不推薦使用。

四、Maven scope 與類路徑關(guān)系

Maven 在構(gòu)建項目時，會根據(jù) scope 決定依賴是否加入不同階段的 classpath。

因此可以這樣理解：

Maven 會根據(jù) pom.xml 中依賴的 scope，在 編譯、運行和打包階段構(gòu)建不同的 classpath，從而決定哪些依賴在不同階段被引入。

到此這篇關(guān)于Maven 依賴作用域詳解：compile、provided、runtime、test的文章就介紹到這了,更多相關(guān)Maven 依賴作用域內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論