我們一起聊聊服務(wù)模塊化

作者：李福田 2023-01-04 18:10:26

模塊化是個(gè)廣泛的概念，用于軟件編程就是將系統(tǒng)分解成獨(dú)立且互相連接的模塊的行為，拆分的模塊通常需要提前定義好標(biāo)準(zhǔn)化的接口，以便讓各模塊獨(dú)立開(kāi)發(fā)情況下，還能互相調(diào)用不受影響。

服務(wù)模塊化踐行

2017年9月jdk 9正式發(fā)布，帶來(lái)了很多新特性，其中之一便是模塊化，JDK模塊化的前身是項(xiàng)目 Jigsaw，于2008開(kāi)始孵化，最早計(jì)劃用于jdk7，一部分內(nèi)容推遲到了jdk8，實(shí)際上在jdk9才完成了該項(xiàng)目全部目標(biāo)，即實(shí)現(xiàn)一個(gè)模塊系統(tǒng)，并以此實(shí)現(xiàn)jdk自身模塊化。本文主要闡述模塊化的概念，為什么關(guān)注模塊化，基于jdk9的模塊化實(shí)現(xiàn)原理和項(xiàng)目實(shí)踐。

1.什么是模塊化

模塊化是個(gè)廣泛的概念，用于軟件編程就是將系統(tǒng)分解成獨(dú)立且互相連接的模塊的行為，拆分的模塊通常需要提前定義好標(biāo)準(zhǔn)化的接口，以便讓各模塊獨(dú)立開(kāi)發(fā)情況下，還能互相調(diào)用不受影響。實(shí)際上在面向?qū)ο笳Z(yǔ)言中對(duì)象之間的關(guān)注點(diǎn)分離與模塊化的概念基本一致，在實(shí)際應(yīng)用開(kāi)發(fā)中，將復(fù)雜業(yè)務(wù)系統(tǒng)按照業(yè)務(wù)邏輯等分割成多個(gè)獨(dú)立的模塊，各模塊提前定義好對(duì)外的服務(wù)接口，各模塊獨(dú)立開(kāi)發(fā)，根據(jù)依賴(lài)的模塊可獨(dú)立完成業(yè)務(wù)模塊測(cè)試、交付。Java語(yǔ)言并不是按照模塊化思想設(shè)計(jì)的（除了package，在Java語(yǔ)言和虛擬機(jī)規(guī)范各版本第7章package，程序被組織為一組包。包的成員是類(lèi)、接口以及子包，它們以包為編譯單元聲明）但是java社區(qū)早就有很多模塊。一個(gè)jar，一個(gè)包，任何一個(gè)java類(lèi)庫(kù)，實(shí)際上都是一個(gè)模塊，通常模塊都附帶一個(gè)版本號(hào)，以便模塊升級(jí)提供新功能并不對(duì)低版本的模塊產(chǎn)生影響。

2.為什么模塊化

模塊化有助于將應(yīng)用分解為不同的模塊，各個(gè)模塊可以單獨(dú)測(cè)試、開(kāi)發(fā)、交付。類(lèi)庫(kù)基本上都是模塊，如果你想將部分類(lèi)庫(kù)提供給別人使用或者使用了別人提供的類(lèi)庫(kù)，那么實(shí)際上你已經(jīng)參與過(guò)模塊化應(yīng)用了。在實(shí)際項(xiàng)目中，一般使用構(gòu)建工具（maven、gradle等）組建，明確指明了依賴(lài)的類(lèi)庫(kù)，以及變成類(lèi)庫(kù)，供他人使用。

模塊化的好處之一是便于模塊獨(dú)立測(cè)試、開(kāi)發(fā)、交付。模塊可按照業(yè)務(wù)核心情況或依賴(lài)順序部分交付，以便項(xiàng)目逐步完成交付，節(jié)省資源，增加迭代優(yōu)化空間，這個(gè)概念提別像敏捷開(kāi)發(fā)，采用迭代、循序漸進(jìn)的方法進(jìn)行軟件開(kāi)發(fā)，把一個(gè)大項(xiàng)目分為多個(gè)相互聯(lián)系，但也可獨(dú)立運(yùn)行的小項(xiàng)目，并分別完成，在此過(guò)程中軟件一直處于可使用狀態(tài)。

模塊化的另一個(gè)好處是便于升級(jí)，修復(fù)bug并提供新的服務(wù)，而版本號(hào)的存在就是為了區(qū)分模塊的歷史版本以及避免依賴(lài)發(fā)生錯(cuò)誤。像guava、fastjson和fastjson2等類(lèi)庫(kù)證實(shí)了這點(diǎn)。

模塊化也可給項(xiàng)目管理帶來(lái)方便，復(fù)雜業(yè)務(wù)分割成一個(gè)個(gè)獨(dú)立可復(fù)用的模塊，項(xiàng)目結(jié)構(gòu)性更好，出現(xiàn)問(wèn)題或者需要部分優(yōu)化，只需要關(guān)注部分模塊，對(duì)于依賴(lài)的模塊由其他人提供維護(hù)即可，減少了維護(hù)和關(guān)注的成本。

3.模塊化的原理

首先需要安裝jdk9，下載地址放在文末附錄。

如下圖1所示為安裝好的jdk9，圖2所示為jdk8的目錄，是多個(gè)jar。

圖1

圖2

以上圖1和圖2對(duì)比可以看到j(luò)dk9拆分成了具體模塊，不再是一個(gè)個(gè)的jar，每個(gè)模塊都有一個(gè)module-info.class，文件定義模塊的名字、依賴(lài)的模塊、對(duì)外開(kāi)放的類(lèi)、接口實(shí)現(xiàn)類(lèi)等，實(shí)際上module-info就是是模塊化的聲明文件。

除了組織形式發(fā)生變化外，真正的區(qū)別在哪里呢？圖3是jdk.internal.loader.BuiltinClassLoader的loadClassOrNull方法中的代碼片段，是進(jìn)行類(lèi)加載的方法，代碼展示先查找LoadedModule （模塊信息）如果有的話就進(jìn)行類(lèi)加載，否則的話，按照雙親委派模式向上委托進(jìn)行類(lèi)加載，后一步是為了向前兼容，前一步就是模塊化實(shí)現(xiàn)的核心原理，類(lèi)加載機(jī)制不再向上委托，而是根據(jù)LoadedModule限制類(lèi)加載。

其初始化在java.lang.System# initPhase2如圖3.1，主要是虛擬機(jī)進(jìn)行系統(tǒng)模塊化的初始化，并返回ModuleLayer，稱(chēng)為layer（層，表示一組類(lèi)加載器），有兩種層，虛擬機(jī)提供的boot layer和用戶(hù)自定義的layer，用于將基礎(chǔ)模塊和用戶(hù)定義模塊與類(lèi)加載器（層）關(guān)聯(lián)。

圖3

圖3.1

模塊的定義在Module#defineModules，詳細(xì)的解釋可在java9se虛擬機(jī)規(guī)范5.3.6找到，Java 虛擬機(jī)支持將類(lèi)和接口組織成模塊，調(diào)用defineModules，將模塊與layer（類(lèi)加載器）關(guān)聯(lián)，設(shè)置模塊可訪問(wèn)、開(kāi)放的資源以及依賴(lài)的資源（由此限制模塊的訪問(wèn)），訪問(wèn)控制由類(lèi)的運(yùn)行時(shí)模塊管理，不是由創(chuàng)建類(lèi)的類(lèi)加載器或類(lèi)加載器服務(wù)的層管理，至此模塊化的初始化和限制訪問(wèn)核心功能實(shí)現(xiàn)。也可按照以下代碼理解模塊化的組織和實(shí)現(xiàn)。BuiltinClassLoader的實(shí)現(xiàn)類(lèi)有三個(gè)AppClassLoader，BootClassLoader，PlatformClassLoader，jdk9的類(lèi)加載器。

//初始化 layer
ModuleLayer boot = ModuleLayer.boot();
Configuration configuration = boot.configuration();
//獲取解析的模塊
Set<ResolvedModule> modules = configuration.modules();
modules.forEach(resolvedModule -> {
    //獲取模塊句柄
    ModuleReference reference = resolvedModule.reference();
    //模塊化的名稱(chēng)
    System.out.println(reference.descriptor().name());
    try (ModuleReader reader = reference.open()) {
        //模塊化下的全部資源
        reader.list().forEach(System.out::println);
    } catch (IOException ioe) {
        throw new UncheckedIOException(ioe);
    }
});

jdk9以前的類(lèi)加載機(jī)制是大家熟識(shí)的雙親委派三層模型，bootstrap classloader <-- extension classloader <-- application classloader，這里不在贅述。下面展示jdk9帶來(lái)的改變，維持了三層模型，為了向前兼容，自JEP 220.extension classloader 變改為platform classloader，與application classloader 不在是URLClassLoader 的實(shí)現(xiàn)，而是其內(nèi)部存有LoadedModule，并優(yōu)先根據(jù)模塊化信息自我進(jìn)行類(lèi)加載，否則委托給父類(lèi)，而platform classloader還可以委托給application classloader ，實(shí)際的加載機(jī)制如下圖4所示，模塊化的類(lèi)加載機(jī)制打破了雙親委派，效率更加高效。以上便是模塊化實(shí)現(xiàn)的核心原理，Module控制模塊下類(lèi)和接口的訪問(wèn)性，模塊化的類(lèi)加載不再是雙親委派，運(yùn)行時(shí)模塊根據(jù)模塊之間的關(guān)系，與layer（一組類(lèi)加載器）關(guān)聯(lián)，按照下圖方式進(jìn)行類(lèi)加載。

圖4

4.模塊化踐行

下面實(shí)踐基于jdk9模塊化項(xiàng)目編譯到運(yùn)行全過(guò)程目錄4.1以及完整多模塊化的項(xiàng)目的使用4.2。

4.1模塊化項(xiàng)目

由hello項(xiàng)目入手品略模塊化項(xiàng)目的編譯、打包、運(yùn)行、生成運(yùn)行時(shí)環(huán)境的過(guò)程，深入理解模塊化的按需打包的優(yōu)點(diǎn)。著重展示模塊化項(xiàng)目從建立到可運(yùn)行環(huán)境輸出過(guò)程，項(xiàng)目名為hello，項(xiàng)目目錄如下圖5：

圖5

src目錄下新建一個(gè)module-info.java，模塊名是hello。在hello目錄下，新建Main.java，添加代碼代碼，其實(shí)就是打印一個(gè)hello world。下面進(jìn)行編譯，運(yùn)行，鏡像輸出。

public static void main(String[] args){
        System.out.println("hello world");
}

4.1.1編譯

編譯java文件，out是個(gè)目錄，編譯生成文件到out這個(gè)目錄下：

javac -d out .\src\hello\Main.java  .\src\module-info.java

4.1.2打包

將out目錄下全部文件也就是（*）打包成 hello.jar 文件，存放在jar目錄下，并指定應(yīng)用程序入口點(diǎn)為 hello.Main，-c創(chuàng)建新檔案，-f指定檔案文件名，-e指定應(yīng)用程序入口點(diǎn)。

cd .\out\
mkdir jar
jar -cfe hello.jar hello.Main *

4.1.3運(yùn)行

運(yùn)行生成的jar ,--module-path指定模塊路徑， jar是存放hello.jar文件的目錄，控制臺(tái)輸出 hello world

java --module-path .\jar\ --module hello/hello.Main    
或者
java --module-path .\jar\ --module hello

4.1.4生成模塊

指定生成模塊的jar是hello.jar，生成模塊 hello.jmod

jmod create --class-path hello.jar hello.jmod

4.1.5生成運(yùn)行環(huán)境

將hello.jmod 放到j(luò)dk安裝目錄下的jmods目錄下（windows下module-path指定多個(gè)路徑分隔符是半角分號(hào)【;】，Linux分隔符是半角冒號(hào)【:】我的環(huán)境是windows，嘗試多次均為未成功，所以粘貼這個(gè)模塊到JDK的基礎(chǔ)模塊中，指定module-path 為當(dāng)前目錄即可）并在此目錄執(zhí)行以下命令，指定模塊路徑為當(dāng)前目錄，--add-modules添加java.base和hello模塊，--launcher定義一個(gè)入口點(diǎn)直接運(yùn)行模塊 --output 指定生成的運(yùn)行時(shí)環(huán)境的目錄名稱(chēng)。

jlink --module-path . --add-modules java.base,hello --launcher hello=hello --output jre/

4.1.6運(yùn)行

打開(kāi)jre目錄，可以看到如圖6所示，bin目錄下生成可運(yùn)行hello和 hello.bat，windows下命令行運(yùn)行 .\hello.bat，控制臺(tái)打印，hello world

圖6

4.1.7小結(jié)

以上項(xiàng)目生成的文件是一個(gè)完整的可運(yùn)行的Java運(yùn)行環(huán)境即Java Runtime Environment 即jre，而這個(gè)可運(yùn)行的環(huán)境大小只有35.9 MB，完整的jre是215M（我的環(huán)境中），這也就是模塊化的一大優(yōu)點(diǎn)，可按需打包依賴(lài)，從jdk層支持，應(yīng)用依賴(lài)也可以按照如此按需打包，減少浪費(fèi)資源，以上是模塊化從編譯到生成jre的過(guò)程，下面我們進(jìn)行模塊化的完整項(xiàng)目開(kāi)發(fā)。

4.2多模塊項(xiàng)目實(shí)踐

一個(gè)完整項(xiàng)目如何模塊化？模塊之間如何依賴(lài)使用？怎么對(duì)外開(kāi)放服務(wù)？如何對(duì)外允許反射的服務(wù)和以及隱式的依賴(lài)傳遞，下面項(xiàng)目深入展示模塊化的項(xiàng)目使用基本要點(diǎn)。著重展示了模塊化的使用以各關(guān)鍵字的詳細(xì)解釋。

假設(shè)場(chǎng)景是每天的生活，新建一個(gè)項(xiàng)目，建四個(gè)模塊，eat、transportation、work、console 項(xiàng)目如下，eat模塊模擬吃喝，transportation模塊模擬交通，work模塊模擬工作，console 模塊模擬生活，項(xiàng)目目錄如圖7所示。

圖7

4.2.1eat模塊

eatapi目錄下，對(duì)外提供服務(wù)接口，吃飯喝水兩個(gè)方法，

public interface EatApi {
    void eat();
    void drink();
}

eatservice目錄下，實(shí)現(xiàn)EatApi接口，

public class EatApiImpl implements EatApi {
    @Override
    public void eat(){
        System.out.println("吃飯了");
    }
    @Override
    public void drink(){
        System.out.println("喝水了");
    }
}

模塊化 module-info 類(lèi)，定義名稱(chēng)為eat，exports對(duì)外暴露eatapi接口，接口的實(shí)現(xiàn)為EatApiImpl類(lèi)，provides with 可被ServiceLoader根據(jù)SPI的方式加載到，但是反射并不能獲取實(shí)現(xiàn)類(lèi)。

module eat {
    exports eatapi;
    provides eatapi.EatApi with eatservice.EatApiImpl;
}

4.2.2.transportation模塊

transportapi目錄下，對(duì)外提供服務(wù)，模擬交通，

public interface Transportation {
    void transport();
}

transportservice目錄下，實(shí)現(xiàn)transportapi接口

public class TransportationImpl implements Transportation {
    @Override
    public void transport(){
        System.out.println("開(kāi)車(chē)出去");
    }
}

模塊化 module-info 類(lèi)，定義名稱(chēng)為transportation，exports對(duì)外暴露transportapi接口，接口的實(shí)現(xiàn)為T(mén)ransportationImpl類(lèi)，opens關(guān)鍵字，可以加在module關(guān)鍵字之前，表明整個(gè)模塊都可以被深度反射，opens transportservice 只表明該包下的類(lèi)可以被深度反射。

module transportation {
    exports transportapi;
    provides transportapi.Transportation with transportservice.TransportationImpl;
    opens transportservice;
}

4.2.3.work模塊

workapi目錄下，對(duì)外提供服務(wù)，模擬工作，

public interface Work {
    void work() throws Exception;
}

workservice目錄下，實(shí)現(xiàn)接口，通過(guò)ServiceLoader獲取eat模塊EatApi，通過(guò)反射獲取 Transportation實(shí)現(xiàn)了類(lèi)。

public class WorkImpl implements Work {
    @Override
    public void work() throws Exception {
        System.out.println("開(kāi)始工作了");
        //獲取服務(wù)
        EatApi eatApi = ServiceLoader.load(EatApi.class).findFirst().get();
        //喝口水
        eatApi.drink();
        //反射獲取 Transportation實(shí)現(xiàn)了類(lèi)  
        Transportation transportation = getTransportation();
        //出去一趟
        transportation.transport();
        //吃點(diǎn)東西
        eatApi.eat();
        //喝口水
        eatApi.drink();
    }

    private Transportation getTransportation() throws Exception{
        Class<Transportation> transportationClass = (Class<Transportation>)                        Class.forName("transportservice.TransportationImpl");
        Transportation transportation = transportationClass.getDeclaredConstructor().newInstance();
        return transportation;
    }
}

模塊化module，workapi可對(duì)外暴露，實(shí)現(xiàn)類(lèi)是WorkImpl，requires 表示依賴(lài)模塊，依賴(lài)模塊eat、transportation，調(diào)用了這兩個(gè)模塊的服務(wù)，transitive 關(guān)鍵字表示該依賴(lài)會(huì)被傳遞，引用本服務(wù)的服務(wù)也會(huì)引用transitive修飾的模塊，不用在主服務(wù)中在引一次，uses表示使用模塊中的具體服務(wù)。

module work {
    exports workapi;
    provides workapi.Work with workservice.WorkImpl;
    requires transitive eat;
    requires transitive transportation;
    uses eatapi.EatApi;
}

4.2.4.console模塊

該模塊調(diào)用work模塊以及work transitive 的模塊，

模塊化配置如下，依賴(lài)模塊work，使用workapi.Work和eatapi.EatApi

module console {
    requires work;
    uses workapi.Work;
    uses eatapi.EatApi;
}

day1目錄下新建Main，模塊Work的依賴(lài)隱式傳遞，最終打印出結(jié)果如圖8所示。

public class Main {
    public static void main(String[] args) throws Exception {
        //獲取work 服務(wù)
        ServiceLoader<Work> load = ServiceLoader.load(Work.class);
        Work work = load.findFirst().get();
        //調(diào)用
        work.work();
        //其他服務(wù)
        ServiceLoader<EatApi> eatLoader = ServiceLoader.load(EatApi.class);
        EatApi eatApi = eatLoader.findFirst().get();
        eatApi.eat();
        eatApi.drink();
        //反射獲取
        Transportation transportation = getTransportation();
        transportation.transport();

    }
    private static Transportation getTransportation() throws Exception {
        Class<Transportation> transportationClass = (Class<Transportation>) Class.forName("transportservice.TransportationImpl");
        Transportation transportation = transportationClass.getDeclaredConstructor().newInstance();
        return transportation;
    }
}

圖8

5.總結(jié)

以上便是使用模塊化生成需要jre環(huán)境和在項(xiàng)目中使用多模塊服務(wù)的踐行。

模塊化核心原則模塊必須強(qiáng)封裝性，隱藏部分代碼，只對(duì)外提供指定服務(wù)，也就需要良好的接口定義并且顯示依賴(lài)，聲明式的服務(wù)依賴(lài)，不是使用了但不知道依賴(lài)來(lái)自哪里的糊涂賬。可以提高模塊的可讀性，明確服務(wù)的入口和依賴(lài)，減少服務(wù)循環(huán)依賴(lài)，按需打包，解決反射帶來(lái)的全可見(jiàn)危害，提高安全性。但是就目前而言模塊化帶來(lái)的收益遠(yuǎn)低于遷移工作，目前大家都在用spring的全家桶應(yīng)用項(xiàng)目，使用很方便，但是真正按照模塊化將其切分出來(lái)，并且能夠完全理清楚項(xiàng)目依賴(lài)，也是有一定門(mén)檻的，不過(guò)模塊化的方法和工具，jdk已然提供，模塊化的思維和想法是很值得學(xué)習(xí)的，相信在不久的將來(lái)，模塊化會(huì)更智能和完善。