Maven 項⽬⽣命週期

Maven從項⽬的三個不同的⻆度，定義了三套⽣命週期，三套⽣命週期是相互獨⽴的，它們之間不會相互影響。

• 清理⽣命週期(Clean Lifecycle)：該⽣命週期負責清理項⽬中的多餘信息，保持項⽬資源和代碼的整潔性。⼀般拿來清空directory(即⼀般的target)⽬錄下的⽂件。
• 默認構建⽣命週期(Default Lifeclyle)：該⽣命週期表示這項⽬的構建過程，定義了⼀個項⽬的構建要經過的不同的階段。
• 站點管理⽣命週期(Site Lifecycle)：向我們創建⼀個項⽬時，我們有時候需要提供⼀個站點，來介紹這個項⽬的信息，如項⽬介紹，項⽬進度狀態、項⽬組成成員，版本控制信息，項⽬javadoc索引信息等等。站點管理⽣命週期定義了站點管理過程的各個階段

常用命令

常用打包命令

mvn clean package -Dmaven.test.skip=true        -- 跳過單測打包
mvn clean install -Dmaven.test.skip=true        -- 跳過單測打包，並把打好的包上傳到本地倉庫
mvn clean deploy -Dmaven.test.skip=true            -- 跳過單測打包，並把打好的包上傳到遠程倉庫

其他命令

mvn -v //查看版本 
mvn archetype:create //創建 Maven 項目 
mvn compile //編譯源代碼 
mvn test-compile //編譯測試代碼 
mvn test //運行應用程序中的單元測試 
mvn site //生成項目相關信息的網站 
mvn package //依據項目生成 jar 文件 
mvn package -P profileName //指定profile進行打包,依據項目生成 jar 文件 
mvn install //在本地 Repository 中安裝 jar 
mvn -Dmaven.test.skip=true //忽略測試文檔編譯 
mvn clean //清除目標目錄中的生成結果 
mvn clean compile //將.java類編譯為.class文件 
mvn clean package //進行打包 
mvn clean test //執行單元測試 
mvn clean deploy //部署到版本倉庫 
mvn clean install //使其他項目使用這個jar,會安裝到maven本地倉庫中 
mvn archetype:generate //創建項目架構 
mvn dependency:list //查看已解析依賴 
mvn dependency:tree com.xx.xxx //看到依賴樹 
mvn dependency:analyze //查看依賴的工具 
mvn help:system //從中央倉庫下載文件至本地倉庫 
mvn help:active-profiles //查看當前激活的profiles 
mvn help:all-profiles //查看所有profiles 
mvn help:effective -pom //查看完整的pom信息

標籤解釋

常用標籤詳解

<!-- project 是根標籤-->
<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">
    
    <!--指定父項目的座標。如果項目中沒有規定某個元素的值，那麼父項目中的對應值即為項目的默認值。 座標包括group ID，artifact ID和 version。--> 
    <parent> 
         <!--繼承的父項目的構件標識符--> 
         <artifactId>maventest</artifactId>
         <!--繼承的父項目的全球唯一標識符--> 
         <groupId>com.seven</groupId>
         <!--繼承的父項目的版本:大版本.次版本.小版本 ;snapshot快照 alpha內部測試 beta公測 release穩定 GA正式發佈--> 
         <version>1.0.0-SNAPSHOT</version>
         <!-- 父項目的pom.xml文件的相對路徑。相對路徑允許你選擇一個不同的路徑。默認值是../pom.xml。Maven首先在構建當前項目的地方尋找父項 目的pom，其次在文件系統的這個位置（relativePath位置），然後在本地倉庫，最後在遠程倉庫尋找父項目的pom。--> 
         <relativePath/> 
     </parent> 
    
    <!-- 當前項目的標識 -->
     <!--項目的全球唯一標識符，通常使用全限定的包名區分該項目和其他項目。並且構建時生成的路徑也是由此生成， 如com.mycompany.app生成的相對路徑為：/com/mycompany/app-->  
    <groupId>com.seven.ch</groupId>  
    <!-- 構件的標識符，它和group ID一起唯一標識一個構件。換句話説，你不能有兩個不同的項目擁有同樣的artifact ID和groupID；在某個特定的group ID下，artifact ID也必須是唯一的-->  
    <artifactId>Question8_1</artifactId>
    <!--項目產生的構件類型，例如jar、war、ear、pom。插件也可以創建自己的構件類型，所以前面列的不是全部構件類型-->  
    <packaging>jar</packaging>  
    <!--項目當前版本，格式為:主版本.次版本.增量版本-限定版本號-->  
    <version>1.0-SNAPSHOT</version>  
    <!-- 項目 描述名-->
    <name></name>
    <!--項目主頁的URL, Maven產生的文檔用-->  
    <url></url>
    <!-- 項目的詳細描述, Maven 產生的文檔用。-->
    <description></description>
    
    <!-- 集合多個子模塊，在父中設置-->
    <modules></modules>
    <!--指定了當前的pom的版本-->
    <modelVersion>4.0.0</modelVersion>
    
    <!--在列的項目構建profile，如果被激活，會修改構建處理；一般在子pom中設置--> 
    <profiles>
        <!--根據環境參數或命令行參數激活某個構建處理--> 
        <profile>
            <id>betanoah</id>
            <properties>
                <deploy.type>betanoah</deploy.type>
            </properties>
        </profile>
    </profiles>
    
    <!--定義標籤，一般在父pom中設置--> 
    <properties>
        <!-- 自定義便籤，設置依賴版本 -->
        <java_target_version>11</java_target_version>
        <java_source_version>11</java_source_version>
        <junit.junit>4.12</junit.junit>
        <spring-boot.version>2.6.6</spring-boot.version>
    </properties>
  
    <!-- 繼承自該項目的所有子項目的默認依賴信息。這部分的依賴信息不會被立即解析,而是當子項目聲明一個依賴（必須描述group ID和 artifact ID信息），如果group ID和artifact ID以外的一些信息沒有描述，則通過group ID和artifact ID 匹配到這裏的依賴，並使用這裏的依賴信息。--> 
    <!-- 一般在父pom文件裏配置 -->
     <dependencyManagement> 
          <dependencies> 
               <!--參見dependencies/dependency元素--> 
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
               //...
          </dependencies> 
     </dependencyManagement>    
    
    <!-- 依賴列表，一般只在子pom文件裏配置，父pom文件只做依賴的版本管理 -->
    <dependencies>
        <dependency>
            <!-- 指定座標從而知道依賴的是哪個項目-->
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <!-- 這個類的依賴範圍-->
            <scope></scope>
            <!-- 設置依賴是否可選   默認false 是默認繼承-->
            <optional></optional>
            <!-- 排除依賴傳遞列表-->
            <exclusions>
                <exclusion></exclusion>
            </exclusions>
        </dependency>
    </dependencies>
   
    <!-- 插件列表-->
    <build>
        <plugins></plugins>
    </build>
</project>

依賴管理

Maven項目，依賴，構建配置，以及構件：所有這些都是要建模和表述的對象。這些對象通過一個名為項目對象模型(Project Object Model, POM)的XML文件描述。

POM是Maven項目管理和構建的核心文件，它通常是一個名為pom.xml的XML文件。POM文件包含了項目的所有配置信息，Maven通過這些信息來構建項目、管理依賴以及執行其他構建任務。

這個POM告訴Maven它正處理什麼類型的項目，如何修改默認的行為來從源碼生成輸出。同樣的方式，一個Java Web應用有一個web.xml文件來描述，配置，及自定義該應用，一個Maven項目則通過一個 pom.xml 文件定義。該文件是Maven中一個項目的描述性陳述；也是當Maven構建項目的時候需要理解的一份“地圖”。

座標詳解

座標，其實就是從眾多jar包中找到需要的那個jar包

傳遞性依賴

先考慮一個基於Spring Framework 的項目，如果不使用Maven, 那麼在項目中就需要手動 下載相關依賴。由於Spring Framework 又會依賴於其他開源類庫，因此實際中往往會下載一個很大的如 spring-framework-2.5.6-with-dependencies.zip 的包，這裏包含了所有Spring Framework 的 jar包，以及所有它依賴的其他 jar包。這麼做往往就引入了很多不必要的依賴。另一種做法是隻下載 spring-framework-2.5.6.zip 這樣一個包，這裏不包含其他相關依賴，到實際使用的時候，再根據出錯信息，或者查詢相關文檔，加入需要的其他依賴。

Maven 的傳遞性依賴機制可以很好地解決這一問題。

傳遞性依賴就是，當項目A依賴於B，而B又依賴於C的時候，自然的A會依賴於C，這樣Maven在建立項目A的時候，會自動加載對C的依賴。

groupId

<groupId>org.sonatype.nexus</groupId>
<artifactId>nexus-indexer</artifactId>
<version>2.0.0<Nersion>
<packaging>jar<packaging>

這是 nexus-indexer 的座標定義， nexus-indexer 是一個對Maven 倉庫編纂索引並提供搜索功能的類庫，它是 Nexus 項目的一個子模塊。後面會詳細介紹 Nexus。上述代碼片段中，其座標分別為 groupld:org.sonatype.nexus、artifactld:nexus-indexer、version:2.0.0、packaging: jar, 沒有 classifier。下面詳細解釋一下各個座標元素：

• groupId：定義當前 Maven 項目隸屬的實際項目。首先， Maven 項目和實際項目不一定是一對一的關係。比如 Spring Framework 這一實際項目，其對應的 Maven 項目會有很多，如 spring-core、spring-context 等。這是由於Maven 中模塊的概念，因此，一個實際項目往往會被劃分成很多模塊。其次， groupId不應該對應項目隸屬的組織或公司。原因很簡單，一個組織下會有很多實際項目，如果 groupId 只定義到組織級別， 而後面我們會看到，artifactId 只能定義Maven 項目(模塊), 那麼實際項目這個層將難以定義。最後， groupId 的表示方式與Java包名的表示方式類似，通常與域名反向一一對應。上例中， groupId 為 org.sonatype.nexus, org.sonatype 表示 Sonatype 公司建立的一 個非盈利性組織，nexus 表示 Nexus 這一實際項目，該 groupId 與域名 nexus.sonatype.org 對應。
• artifactId：該元素定義實際項目中的一個Maven項目(模塊), 推薦的做法是使用實際項目名稱作為 artifactId 的前綴。比如上例中的 artifactId 是 nexus-indexer, 使用了實際項目名 nexus 作為前綴，這樣做的好處是方便尋找實際構件。在默認情況下， Maven生成的構件，其文件名會以 artifactId 作為開頭，如 nexus-indexer-2.0.0.jar, 使用實際項目名稱作為前綴之後，就能方便從一個 lib文件夾中找到某個項目的一組構件。考慮有5個項目，每個項目都有一個 core模塊，如果沒有前綴，我們會看到很多 core-1.2.jar這樣的文件，加上實際項目名前綴之後，便能很容易區分 foo-core-1.2.jar、bar-core-1.2.jar … … 。
• version：該元素定義Maven 項目當前所處的版本，如上例中 nexus-indexer 的版本是 2.0.0。需要注意的是， Maven 定義了一套完整的版本規範，以及快照 (SNAPSHOT)的概念。
• packaging：該元素定義 Maven 項目的打包方式。首先，打包方式通常與所生成構件的文件擴展名對應， 如上例中 packaging 為 jar, 最終文件名為 nexus-indexer-2.0.0.jar, 而使用 war 打包方式的Maven 項目，最終生成的構件會有一個 .war 文件， 不過這不是絕對的。其次，打包方式會影響到構建的生命週期，比如 jar打包和 war打包會使用不同的命令。最後，當不定義 packaging 的時候，Maven 會使用默認值 jar。
• classifier：該元素用來幫助定義構建輸出的一些附屬構件。附屬構件與主構件對應， 如上例中的主構件是 nexus-indexer-2.0.0.jar, 該項目可能還會通過使用一些插件生成如nexus-indexer-2.0.0-javadoc.jar、nexus-indexer-2.0.0-sources. jar 這樣一些附屬構件，其包含了Java 文檔和源代碼。這時候， javadoc和 sources 就是這兩個附屬構件的classifier。這樣，附屬構件也就擁有了自己唯一的座標。還有一個關於classifier 的典型例子是 TestNG, TestNG 的主構件是基於Java 1.4平台的，而它又提供了一個classifier為 jdk5 的附屬構件。注意，不能直接定義項目的 classifier, 因為附屬構件不是項目直接默認生成的，而是由附加的插件幫助生成。

上述5個元素中， groupId、artifactId、version 是必須定義的， packaging是可選的(默認為jar), 而 classifier是不能直接定義的。

同時，項目構件的文件名是與座標相對應的， 一般的規則為 artifactId-version [-classifier].packaging, [-classifier] 表示可選。比如上例 nexus-indexer 的主構件為 nexus-indexer-2.0.0.jar, 附屬構件有 nexus-indexer-2.0.0-javadoe.jar。這裏還要強調的一點是，packaging 並非一定與構件擴展名對應，比如 packaging 為 maven-plugin 的構件擴展名為 jar。

此外， Maven 倉庫的佈局也是基於Maven 座標，這一點會在介紹 Maven 倉庫的時候詳細解釋。同樣地，理解清楚 Maven 座標之後，我們就能開始討論Maven 的依賴管理了。

dependencies

在dependencies標籤中添加需要添加的jar對應的Maven座標

<project>
    ...
    <dependencies>
        <dependency>
            <groupId>...</groupId>
            <artifactId>...</artifactId>
            <version>...</version>
            <type>...</type>
            <scope>...</scope>
            <optional>...</optional>
            <exclusions>
                <exclusion>
                ...
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
    ...
</project>

根元素 project 下的 dependencies 可以包含一個或者多個 dependency 元素，以聲明一個或者多個項目依賴。每個依賴可以包含的元素有：

• groupId 、artifactId 和 version：依賴的基本座標，對於任何一個依賴來説，基本座標是最重要的， Maven 根據座標才能找到需要的依賴。
• type：依賴的類型，對應於項目座標定義的 packaging 。大部分情況下，該元素不必聲明，其默認值為jar。
• scope：依賴的範圍。
• optional：標記依賴是否可選。
• exclusions：用來排除傳遞性依賴。

大部分依賴聲明只包含基本座標，然而在一些特殊情況下，其他元素至關重要。

scope

optional

假設有這樣一個依賴關係，項目A 依賴於項目B, 項目B 依賴於項目X 和Y, B 對於X 和Y 的依賴都是可選依賴：A->B、B->X(可選)、B->Y(可選)。根據傳遞性依賴的定義，如果所有這三個依賴的範圍都是 compile, 那麼 X、Y 就是A 的 compile 範圍傳遞性依賴。然而，由於這裏X、Y 是可選依賴，依賴將不會得以傳遞。換句話説， X、Y 將不會對 A有任何影響，如下圖所示。

為什麼要使用可選依賴這一特性呢? 可能項目B 實現了兩個特性，其中的特性一依賴於X, 特性二依賴於Y, 而且這兩個特性是互斥的，用户不可能同時使用兩個特性。比如 B 是一個持久層隔離工具包，它支持多種數據庫，包括 MySQL、PostgreSQL 等，在構建這個工具包的時候，需要這兩種數據庫的驅動程序，但在使用這個工具包的時候，只會依賴一種數據庫。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.xiaoshan.mvnbook</groupId> 
    <artifactId>project-b</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId> 
            <version>5.1.10</version>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>8.4-701.jdbc3</version>
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

上述 XML代碼片段中，使用<optional>元素表示 mysql-connector-java 和 postgresql 這兩個依賴為可選依賴，它們只會對當前項目產生影響，當其他項目依賴於這個項目的時候，這兩個依賴不會被傳遞。

因此，當項目A依賴於項目B的時候，如果其實際使用基於MySQL數據庫，那麼在項目A中就需要顯式地聲明 mysgl-connectorjava這一依賴，見以下代碼清單。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.xiaoshan.mvnbook</groupId>
    <artifactId>project-a</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.xiaoshan.mvnbook</groupId>
            <artifactId>project-b</artifactId>
            <version>1.0.0</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.10</version>
        </dependency>
    </dependencies>
</project>

但是實際上，在理想的情況下，是不應該使用可選依賴的。 使用可選依賴的原因是某一個項目實現了多個特性，在面向對象設計中，有個單一職責性原則，意指一個類應該只有一項職責，而不是糅合太多的功能。

這個原則在規劃 Maven 項目的時候也同樣適用。在上面的例子中，更好的做法是為MySQL 和 PostgreSQL分別創建一個 Maven 項目 ， 基於同樣的 groupId 分配不同的artifactId, 如 com.xiaoshan. mvnbook:project-b-mysql 和 com.xiaoshan. mvnbook:project-b-postgresgl, 在各自的 POM 中聲明對應的JDBC 驅動依賴，而且不使用可選依賴，用户則根據需要選擇使用 pro-ject-b-mysql 或者 project-b-postgresql。 由於傳遞性依賴的作用，就不用再聲明JDBC 驅動依賴。

排除依賴exclusions

假設有這樣一種依賴關係，A->B->C，這個時候由於某些原因，不需要對C的依賴，但是又必須要對B的依賴，針對這種情況，可以在添加A對B的依賴時申明不需要引進B對C的依賴。具體做法如下：

<dependency>
  <groupId>org.apache.struts</groupId>
  <artifactId>struts2-spring-plugin</artifactId>
  <version>2.5.20</version>
  <exclusions>
    <exclusion>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
    </exclusion>
  </exclusions>
</dependency>

依賴衝突

衝突產生的根本原因

由於傳遞依賴的原因，a會通過b引入c的依賴，也會通過d引入c的依賴，因此出現了衝突

依賴衝突的解決方案

路徑最近者優先

Maven 依賴調解 (Dependency Mediation) 的第一原則是：路徑最近者優先

項目A 有這樣的依賴關係： A->B->C->X(1.0)、A->D->X(2.0)，根據路徑最近者優先原則，X(1.0) 的路徑長度為 3 , 而 X(2.0) 的路徑長度為2, 因此X(2.0) 會被解析使用。

第一優先聲明

但是如果路徑長度一樣呢，如A->B->Y(1.0)、A-> C->Y(2.0)

從 Maven 2.0.9開始，第二原則是：第一優先聲明，也就是誰先定義就使用誰的

覆寫優先原則

⼦ POM 內聲明的依賴優先於⽗ POM 中聲明的依賴。

1. 找到 Maven 加載的 Jar 包版本，使⽤ mvn dependency:tree 查看依賴樹，根據依賴原則來調整依賴在POM ⽂件的聲明順序。
2. 發現了衝突的包之後，剩下的就是選擇⼀個合適版本的包留下，如果是傳遞依賴的包正確，那麼把顯示依賴的包exclude掉。如果是某⼀個傳遞依賴的包有問題，那需要⼿動把這個傳遞依賴execlude掉

如何處理無法拉取的jar包

注：本文中所有解決方案均使用IDEA操作

設置了離線工作

有些用户的IDEA中可能設置了離線工作，這項設置會讓IDEA無法連接網絡，自然也無法下載所需資源了。要修改這一設置，具體操作如下：

點擊File>>Settings，在彈出的菜單中選擇Build,Execution,Deployment >> Build Tools >> Maven，然後查看頁面中的Work Offline項是否處於勾選狀態，如果是，則IDEA無法聯網，應該取消勾選。如下圖所示：

配置文件問題

設置maven的 settings.xml文件的鏡像 為阿里雲鏡像

    <mirror>
          <id>alimaven-new</id>
          <name>aliyun maven</name>
          <url>https://maven.aliyun.com/repository/central</url>
          <mirrorOf>central</mirrorOf>
    </mirror>
    
    <mirror>
        <id>aliyun-public</id>
        <mirrorOf>central</mirrorOf>
        <name>aliyun public</name>
        <url>https://maven.aliyun.com/repository/public</url>
    </mirror>

手動下載

到以下網站尋找所需要的jar包：

https://repo.maven.apache.org/maven2/

根據控制枱輸出信息可知，需要的 com.github.spotbugs:spotbugs-maven-plugin:4.2.2

找到所需的jar包，進行下載

並放到本地的maven倉庫中

面試題專欄

Java面試題專欄已上線，歡迎訪問。

• 如果你不知道簡歷怎麼寫，簡歷項目不知道怎麼包裝；
• 如果簡歷中有些內容你不知道該不該寫上去；
• 如果有些綜合性問題你不知道怎麼答；

那麼可以私信我，我會盡我所能幫助你。