談談 Maven 輕松重構項目
現在是微服務盛行時代,說不準哪一天領導就會讓你對一個大項目進行重構。大項目的痛點:編譯慢、發布繁瑣等。就像下面這張圖:
真的不敢動呀,一不小心就坍塌了。
比如說我們用戶系統,我們可以這么重構(這里只是舉例,每個項目拆分目的可能不同)。
user-system拆分成:
- user-web
- user-service
- user-dao
- user-common
我們對其拆分后很有可能存在多個子項目中同時依賴某個jar包,如果使用不當可能會導致每個模塊使用的版本不一樣,所以想想能不能有什么方式來解決這類問題呢?
答案:能。但是得先了解兩個概念:聚合和繼承。
聚合
所謂的聚合就是我們如果想一次性構建多個項目模塊,那我們就需要把這些項目模塊進行聚合。
配置模板
- <modules>
- <module>項目模塊一</module>
- <module>項目模塊二</module>
- <module>項目模塊三</module>
- <module>項目模塊...</module>
- </modules>
使用方式
比如我們對user-web、user-service、user-dao、user-common四個項目模塊進行聚合。
- <modules>
- <module>user-web</module>
- <module>user-service</module>
- <module>user-dao</module>
- <module>user-common</module>
- </modules>
注意:其中module的路徑為相對路徑。
這樣就解決了我們項目模塊的聚合,我們再來看看maven是如何來解決由于重復依賴導致版本不一樣的問題。
繼承
繼承為了消除重復,我們把很多相同的配置提取出來,例如:grouptId,version等 。
繼承的配置
- <parent>
- <artifactId>maven-demo</artifactId>
- <groupId>com.tian</groupId>
- <version>1.0-SNAPSHOT</version>
- </parent>
繼承代碼中定義屬性
繼承代碼過程中,可以定義屬性,例如:
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <junit.version>4.13.1</junit.version>
- <maven.version>0.0.1-SNAPSHOT</maven.version>
- </properties>
訪問屬性的方式為${junit.version},例如:
- <?xml version="1.0" encoding="UTF-8"?>
- <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">
- <parent>
- <artifactId>maven-demo</artifactId>
- <groupId>com.tian</groupId>
- <version>1.0-SNAPSHOT</version>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>user-web</artifactId>
- <dependencies>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <!-- 使用了parent中 junit.version -->
- <version>${junit.version}</version>
- </dependency>
- </dependencies>
- </project>
這樣我們就可以使用到上面定義的屬性junit.version=4.13.1。
父模塊用dependencyManagement進行管理
由于項目模塊較多,所以我們又抽象了一層,抽出一個parent來管理子項目的公共的依賴。為了項目的正確運行,必須讓所有的子項目使用依賴項的統一版本,必須確保應用的各個項目的依賴項和版本一致,才能保證測試的和發布的是相同的結果。
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>${junit.version}</version>
- <scope>test</scope>
- </dependency>
- </dependencies>
- </dependencyManagement>
這樣的好處是子模塊可以有選擇性的繼承,而不需要全部繼承。
這樣做的好處:統一管理項目的版本號,確保應用的各個項目的依賴和版本一致,才能保證測試的和發布的是相同的成果,因此,在頂層pom中定義共同的依賴關系。同時可以避免在每個使用的子項目中都聲明一個版本號,這樣想升級或者切換到另一個版本時,只需要在父類容器里更新,不需要任何一個子項目的修改;如果某個子項目需要另外一個版本號時,只需要在dependencies中聲明一個版本號即可。子類就會使用子類聲明的版本號,不繼承于父類版本號。
聚合和繼承的關系
在前面我們構建多模塊項目中,關系如下
mavendemo就是user-web、user-service等幾個模塊的父項目。
父項目主要是用來配置一些公共的配置,其它三個項目再通過繼承的方式擁有父項目中的配置,首先配置父項目的pom.xml,添加對項目的user-web、user-service、user-dao、user-common這四個模塊進行聚合以及jar包依賴。
相對于dependencyManagement,所有生命在dependencies里的依賴都會自動引入,并默認被所有的子項目繼承。
面試題:dependencyManagement和dependencies的區別
- dependencyManagement里只是聲明依賴,并不實現引入,因此子項目需要顯示的聲明需要用的依賴。如果不在子項目中聲明依賴,是不會從父項目中繼承下來的;只有在子項目中寫了該依賴項,并且沒有指定具體版本,才會從父項目中繼承該項,并且version和scope都讀取自父pom;另外如果子項目中指定了版本號,那么會使用子項目中指定的jar版本。
- dependencies即使在子項目中不寫該依賴項,那么子項目仍然會從父項目中繼承該依賴項(全部繼承)。
IDEA中配置
Maven在使用IDEA開發時,如何將Maven配置呢?
打開IDEA,在File--->Settings。輸入欄搜索:maven
配置我們之前安裝好的maven目錄、maven下面的setting.xml以及本地倉庫目錄。然后Apply--->OK。
我們項目對某個項目進行clean 等操作的時候,就可以直接雙擊Lifcycle下面的。
這樣我們就把Maven集成到我們的IDEA中來了。
編譯運行項目
我們可以在父項目中對所有子項目進行編譯、打包等。我們就來對所有子模塊進行打包。
然后在對應子項目中可以找到target目錄和對應的jar包。
也可單獨對某個子項目進行打包等操作。比如我們對user-common進行clean。
于是,此時的user-common下的target已經被刪掉,其他子項目中并沒有收到影響。
IDEA中如何創建多項目模塊
先創建一個user-parent的maven項目:
然后把src目錄刪掉,創建子項目:
選中user-parent項目,右鍵,選中New-->Module
來到New Module界面,選擇Maven,選好自己的本地安裝的JDK。
next。填寫子項目名稱,我們這里創建一個user-web的子項目:
注意這里user-web,默認是userweb,需要我們手工在兩個單詞之間添加橫線:
點擊Finish:
然后在看看user-parent的pom中的內容:
已經添加了modules,同時把我們的user-web添加進去了。
同樣方法,我們就可以創建更多字項目了:
再看看user-parent中的pom.xml文件內容:
到這里,我們就輕輕松松的構建了我們這個大項目user-parent,該項目包括了user-web,user-service,user-dao,-user-commmon子項目。
若是新建多模塊項目,安裝上面的步驟就搞定了。
若是大項目拆分,我們就可以使用上面的方式先創建好自己的多模塊項目,然后對應把大項目里的內容拷貝到對應模塊中(需要注意此時子模塊直接肯定會有相互依賴的)。
總結
通過繼承,我們可以定義項目的父類項目,用于繼承父項目的依賴、插件、屬性等信息。聚合就是我們如果想一次性構建多個項目模塊,那我們就需要對這些項目模塊進行聚合。
構建多模塊項目,在IDEA中使用創建Module的方式很輕松就可以創建了。在父項目中使用來管理子模塊的依賴相關依賴。
對大項目進行重構時,只需要把各模塊拆分出來的代碼拷貝到對應子模塊就可以了。
本文轉載自微信公眾號「 Java后端技術全棧」,可以通過以下二維碼關注。轉載本文請聯系 Java后端技術全棧公眾號。