Java 9 的模組（Module）系統

碼農小胖哥發表於2022-03-24
Java

Java 的模組在Java 9中正式實裝，一直沒時間來研究一下這個東西，今天就和大家一起學習一下這個功能。

Java模組解決了什麼問題

最近很多同學問我，胖哥，該怎麼學習？該學習什麼？這裡胖哥也穿插說一下。不管學東西，一定要先搞清楚學了有什麼用，是學了馬上就能用上還是以後有用。我覺得在時間有限的情況下，一定要學當前立馬有用的東西。接下來我們們就一起來看看Java模組到底有啥用。

我覺得模組化最大的意義就是按照功能把程式碼邏輯分割開來，就像你幹前端，我寫後端，他做測試，把整體大概念拆成小概念，用的時候自由組合，按需引用。事實上確實有這方面的作用，但是不僅僅就這麼多。

簡化類庫

JDK類庫目前太臃腫了，在一些微型裝置上可能用不到全部的功能，在目前的情況下卻不得不引用全部的類庫。Java 9引入模組功能後，JDK、JRE、甚至是JAR都可以把用不到的類庫排除掉，大大降低了依賴庫的規模。

真正的訪問隔離

在之前只要類是public的，可以直接在整個依賴可傳遞的範圍內訪問它。但是很多時候我們需要在某個範圍去限制一些類的訪問，讓這些類具有一些封閉性。在引入模組後，我們就可以做到這些，把一些我們不想暴露的內部實現細節安全地隱藏起來。

什麼是模組？

Java 9 引入的模組是在Java包（package）的基礎上又引入的一個新的抽象層。基於package這一點很重要，這裡需要強調一下。

模組的結構

Java 模組可以由一個或者多個在一起的 Java 包組成。結構可以參考這個圖：

Java Modules

建立模組

建立模組需要如下幾個步驟：

  • 建立一個資料夾，通常是一個包名，例如cn.felord.module。
  • 然後在cn.felord.module下建立一個module-info.java檔案，這個檔案被稱為模組描述符檔案。
  • 在模組描述符檔案的同級別建立Java包。
  • 最後在建立的包下編寫你的Java類檔案即可。

建立模組規則

建立模組也必須遵守下面的規則：

  • 模組名稱必須是唯一的。
  • 模組描述符檔案module-info.java 必須有。
  • 包名稱必須是唯一的。即使在不同的模組中，我們也不能有相同的包名。
  • 每個模組將建立一個 jar 檔案。對於多個 jar，我們需要建立單獨的模組。
  • 一個專案可以由多個模組組成。

模組型別

模組同樣還具有型別，一共有四種。

系統模組

來自 JDK 和 JRE 的模組。可以使用 java --list-modules 列出，這裡列出了一部分：

❯ .\java.exe --list-modules
java.base@17
java.compiler@17
java.datatransfer@17
java.desktop@17
java.instrument@17
java.logging@17
java.management@17
java.management.rmi@17
# 省略……

應用程式模組

在應用程式中建立以實現功能的所有模組，日常開發如果涉及到模組應該屬於這一類。

自動模組

現有的 jar 檔案，感覺像相容舊的類庫。它們其實不是模組。當我們將非模組 jar 新增到模組路徑時，會建立具有 jar 名稱的模組。該模組有以下特性：

  • 預設匯出所有包。
  • 預設情況下可以訪問所有其他模組的類。

未命名模組

新增到類路徑中的 jar 和類。當我們將 jar 或類新增到類路徑時，所有這些類都會新增到未命名的模組中

  • 只匯出到其他未命名的模組和自動模組。這意味著，應用程式模組無法訪問這些類。
  • 它可以訪問所有模組的類。

模組描述符檔案

一個模組只有一個module-info.java，而且它是有格式要求的，我們來了解一下。

宣告模組

我們只需要在module-info.java這樣做就能宣告一個名稱為cn.felord的模組：

module cn.felord {
}

模組名稱應該是兩個單詞以上，並用英文句號.隔開，上面是一個空模組。

匯出包

預設情況下，模組裡下所有包都是私有的，即使被外部依賴也無法訪問，一個模組之內的包還遵循之前的規則不受模組影響。我們可以使用 export 關鍵字公開特定的包，就像這樣：

module cn.felord {
    exports cn.felord.pkg;
    exports cn.felord.util;
}

請注意cn.felord.pkg和exports cn.felord.util不能是空包，匯出的包必須宣告Java物件。

不能匯出具體的Java類。

定向匯出包

還有一種是定向匯出，該包僅僅向某模組公開。就像什麼特供酒、特供煙一樣。它的語法是：

exports <包名> to <目標模組1>,<目標模組2>,<目標模組3>,...

我們把上面的cn.felord.util定向匯出給com.xxx:

module cn.felord {
    exports cn.felord.pkg to com.xxx,com.ooo;
    exports cn.felord.util to com.xxx;
}

在上述情況下，所有模組都可以訪問 cn.felord.pkg，但只有com.xxx模組能訪問 cn.felord.util。

定向導包的作用域是模組。

依賴

如果一個模組要訪問從其它模組匯出的包，則該模組必須使用requires關鍵字匯入要訪問的包所在的模組。就像上面，雖然cn.felord模組向com.ooo開放了cn.felord.pkg包， 即使com.ooo依賴了cn.felord也不能直接使用該包下面的類，需要這樣做：

module com.ooo {
    exports com.ooo.pkg;
    // 註釋掉 Pkg就變紅了 cn.felord.util下面的類無法使用
    requires cn.felord;
}
requires的作用域是模組。

靜態依賴

有時我們只在編譯時需要一些模組，它們在執行時是可選的。例如，測試或程式碼生成庫。這就需要用到靜態匯入了，關鍵字是 requires static ,例如：

module com.xxx {
       // 移除pom 依賴編譯不了
    requires static cn.felord;
}

在此示例中，cn.felord 在編譯時是必需的，但在執行時是可選的，有點類似Maven中的<scope>compile</scope>。

依賴傳遞

這看起來越來越像Maven了！a模組依賴b模組，b模組依賴c模組，如果a模組想用c模組公開的包的話，按照前面的規則需要再requires模組c。現在藉助於 requires transitive 就可以這樣幹，因為b承上啟下，我們可以這樣：

module b {
    exports b.pkg;
    // 開啟依賴傳遞
    requires transitive  c; 
}

module c {
   exports c.pkg
}

module a {
   requires b; 
}
所有依賴b的模組將自動依賴c匯出的包，export to定向匯出的包優先順序最高。

使用服務

使用 uses 關鍵字，我們可以指定我們的模組需要或使用某些服務。這個服務通常是一個介面或抽象類。它不應該是一個實現類。

module com.xxx {
    requires com.ooo;
    // 移除pom 依賴編譯不了
    requires static cn.felord;
    uses com.ooo.pkg.Read;
}

uses只能從模組自己的包中或者requires、requires static以及requires transitive傳遞過來的介面或者抽象類。

uses用於指定所需要的服務類或者介面。

給予服務

我們可以通過 provides ... with ...語法，在模組中宣告一些服務的實現供其它模組（通過uses）使用。

開放反射

反射 API 的 Java 9 封裝和安全性得到了改進。使用反射，我們甚至可以訪問物件的私有成員。

從 java 9 開始，預設情況下不開啟。我們可以明確地通過open授予其它模組反射許可權。

open com.xxx{
}

在這種情況下，com.xxx 模組的所有包都可以使用反射訪問。

opens

我們不想全部開放反射訪問的話還可以使用opens關鍵字來指定反射可以訪問的包：

module com.xxx{
  opens com.xxx.reflect;
}

opens … to

當然我們還可以將特定的包開放給指定的模組來反射訪問：

module com.xxx{
  opens com.xxx.reflect to com.ooo;
}

com.xxx模組的com.xxx.reflect包將開放給com.ooo模組來反射訪問。

總結

模組的東西主要是理解，實際運用主要用來系統瘦身、依賴jar級別的隔離。這個自己用Java 9 以上版本建一個多模組的Maven或者Gradle專案，按照上面實驗一下就明白了。

關注公眾號：Felordcn 獲取更多資訊

個人部落格：https://felord.cn

相關文章