Java9 modules (Jigsaw)模塊化遷移

要點

  • 通過模塊化的方式開發應用程序,實現更好的設計,如關注點分離和封裝性。
  • 通過Java平臺模塊化系統(JPMS),開發者可以定義他們的應用程序模塊,決定其他模塊如何調用他們的模塊,以及他們的模塊如何依賴其他模塊。
  • 對於已經使用了其他模塊系統(如Maven或Gradle)的應用程序來說,還是有可能再加入JPMS。
  • JDK爲開發者提供了一些工具,用於將現有的代碼遷移到JPMS。
  • 應用程序代碼仍然可以依賴Java 9之前的類庫,這些類庫的jar包被看成是一種特別的“自動化”模塊,從而簡化了向Java 9遷移的工作。

這篇文章提供了一個學習案例,演示一個真實的應用程序需要做出哪些變更才能遷移到JPMS。當然,要使用Java 9不一定要做這些事情,不過對於Java開發者來說,瞭解模塊化系統(通過被叫作Jigsaw)無疑是一個非常重要的技能。

我將會演示如何一步步地使用新的Java模塊化系統來重構一個基於Java 8的應用程序。

下載Java 9

首先要下載和安裝最新版本的JDK 9,目前只有搶先預覽版(這裏使用的是9-ea+176版本)。在全面瞭解Java 9之前,你可能不希望把它作爲系統的默認Java版本。所以,你可以不改變原先的$JAVA_HOME環境變量,而是創建一個新的變量$JAVA9_HOME,並把它指向新安裝的JDK目錄。我將在這篇文章裏使用這個新變量。

關於使用Java 9要做的其他一些步驟,可以參看其他現成的教程。我們主要還是討論模塊化組件,不過你也可以參考Oracle的遷移指南。

模塊化

關於Java 9,你會經常聽到人們談論Jigsaw項目,也就是Java的新模塊化系統。關於Jigsaw已經有很多相關教程,而這篇文章將介紹如何使用JPMS對已有代碼進行遷移。

要使用Java 9,並不一定要在代碼裏添加模塊化,這一點讓很多開發者都感到驚訝。開發者在使用Java 9時最爲關注的一點或許是內部API的封裝性,雖然這個會影響到開發者,但這並不意味着要使用Java 9就一定要完全擁抱模塊化。

要利用好JPMS,有很多工具可以幫到你,比如jdeps依賴分析器、Java編譯器和你所使用的IDE。

我不會在這裏講解如何將應用程序拆解成模塊,如果一開始沒有做好模塊化規劃,後續就會變得很困難(JDK的模塊化拆解就花了好幾年的時間)。相反,我假設你的應用程序已經是按照小型的部件組織在一起的,它們可能是Maven模塊或者Gradle子項目,又或者是IDE裏的子項目或模塊。

你會發現,在很多教程裏,包括Jigsaw的入門指南,都會假設一個如下所示的項目結構。

這裏寫圖片描述
圖1

項目裏有一個單獨的src目錄和一個單獨的test目錄,其他所有模塊都是這兩個目錄的子目錄。這個與Maven或Gradle的結構不太一樣,它們的每個模塊都有自己的src目錄和test目錄。不過好在你不一定要重新組織整個應用程序的代碼結構(也不需要讓你的構建工具重新去理解這種結構),你可以繼續使用Maven或Gradle的結構,只要你知道在不同的教程裏可能使用了不同的結構。關鍵是你要知道應用程序的根目錄是哪一個——在Maven或Gradle裏,根目錄就是src目錄和test目錄。

這裏寫圖片描述
圖2

你要做的第一件事情是在模塊的根目錄放置一個module-info.java文件,用來定義模塊的名字。你可以手動創建這個文件,也可以讓IDE幫你創建這個文件。圖3展示了我的模塊的module-info.java文件:

這裏寫圖片描述
圖3

現在在IDE裏編譯項目,或者在src目錄通過命令行來編譯模塊:

> "%JAVA9_HOME%"\bin\javac -d ..\mods\service module-info.java com\mechanitis\demo\sense\service\*.java 
com\mechanitis\demo\sense\service\config\*.java

這個時候你會發現有很多編譯錯誤(如圖4所示)。

這裏寫圖片描述
圖4

總共有27個錯誤,或許你會感到很驚訝,之前這個項目完全可以編譯並正常運行,但在添加了一個module-info.java文件之後就無法編譯了。問題在於,我們現在要顯式地指定我們的模塊所依賴的其他模塊。這些模塊包括JDK的模塊、我們自己創建的其他模塊,或者來自外部依賴的模塊(在這裏我們需要自動模塊)。

jdeps依賴項分析器可以幫助我們確定需要在module-info.java裏聲明哪些模塊。爲了讓程序運行起來,你需要一些東西:

一個包含模塊代碼的jar包,或者一個包含class文件的目錄。要注意,在上一步編譯之後根本得不到class文件,你需要先移除module-info.java文件後重新編譯才能得到需要的class文件。
模塊代碼的類路徑。如果你習慣了在IDE裏運行程序,並使用了Maven或Gradle來管理依賴,可能就很難找到或設置類路徑。在IntelliJ IDEA裏,你可以在運行窗口中看到類路徑。如圖5所示,我把滾動條滾動到適當的位置,然後把藍色字體的內容拷貝出來。

這裏寫圖片描述
圖5

現在我們可以運行jdeps,並使用Java 9的一些標記:

> "%JAVA9_HOME%"\bin\jdeps --class-path %SERVICE_MODULE_CLASSPATH% out\production\com.mechanitis.demo.sense.service

最後一個參數是包含了class文件的目錄。在運行這個命令的時候,我們會得到如下的輸出。

split package: javax.annotation [jrt:/java.xml.ws.annotation, C:\.m2\...\javax.annotation-api-1.2.jar]

com.mechanitis.sense.service -> java.base
com.mechanitis.sense.service -> java.logging
com.mechanitis.sense.service -> C:\.m2\...\javax-websocket-server-impl-9.4.6.jar
com.mechanitis.sense.service -> C:\.m2\...\javax.websocket-api-1.0.jar
com.mechanitis.sense.service -> C:\.m2\...\jetty-server-9.4.6.jar
com.mechanitis.sense.service -> C:\.m2\...\jetty-servlet-9.4.6.jar
   com.mechanitis.sense.service    -> com.mechanitis.sense.service.config  com.mechanitis.sense.service
   com.mechanitis.sense.service    -> java.io                              java.base
   com.mechanitis.sense.service    -> java.lang                            java.base
   com.mechanitis.sense.service    -> java.lang.invoke                     java.base
   com.mechanitis.sense.service    -> java.net                             java.base
   com.mechanitis.sense.service    -> java.nio.file                        java.base
   com.mechanitis.sense.service    -> java.util                            java.base
   com.mechanitis.sense.service    -> java.util.concurrent                 java.base
   com.mechanitis.sense.service    -> java.util.concurrent.atomic          java.base
   com.mechanitis.sense.service    -> java.util.function                   java.base
   com.mechanitis.sense.service    -> java.util.logging                    java.logging
   com.mechanitis.sense.service    -> java.util.stream                     java.base
   com.mechanitis.sense.service    -> javax.websocket                      javax.websocket-api-1.0.jar
   com.mechanitis.sense.service    -> javax.websocket.server               javax.websocket-api-1.0.jar
   com.mechanitis.sense.service    -> org.eclipse.jetty.server             jetty-server-9.4.6.jar
   com.mechanitis.sense.service    -> org.eclipse.jetty.servlet            jetty-servlet-9.4.6.jar
   com.mechanitis.sense.service    -> org.eclipse.jetty.websocket.server        javax-websocket-server-impl-9.4.6.jar
   com.mechanitis.sense.service    -> org.eclipse.jetty.websocket.server.deploy javax-websocket-server-impl-9.4.6.jar
   com.mechanitis.sense.service.config           -> java.lang              java.base
   com.mechanitis.sense.service.config           -> java.lang.invoke       java.base
   com.mechanitis.sense.service.config           -> javax.websocket        javax.websocket-api-1.0.jar
   com.mechanitis.sense.service.config           -> javax.websocket.server javax.websocket-api-1.0.jar

這些是分裂包(split pacakge)的警告信息,說明相同的包名出現在兩個不同的模塊或jar文件裏。在我們的例子裏,相同的包名同時出現在了java.xml.ws.annotation(來自JDK)和javax.annotation-api.jar裏。這些信息還包含了我的模塊所使用的所有包名,以及這些包所在的模塊或jar文件。我可以使用這些信息來創建module-info.java文件:

module com.mechanitis.demo.sense.service {
   requires java.logging;
   requires javax.websocket.api;
   requires jetty.server;
   requires jetty.servlet;
   requires javax.websocket.server.impl;
}

java.base包含了幾乎所有的JDK基本類庫,不過我不需要顯示地聲明它,因爲它是默認包含的。我甚至不需要知道外部依賴項的自動模塊名稱。

自動模塊

Java 9和JPMS考慮到大部分的代碼在一開始並不會使用JPMS(例如並沒有通過module-info.java來定義依賴和權限從而實現完全的模塊化)。爲了解決這個問題並簡化遷移工作,你的模塊化代碼仍然可以使用jar包依賴(這些jar包不是真正的模塊)。這些jar包被稱爲自動模塊,它們內部的包名可以被自由訪問,只要它們處在類路徑裏,你就可以像以前那樣隨意訪問它們。對於開發者來說,我們唯一要做的就是找出它們的名字。默認情況下,它們的名字一般就是去掉了版本號的jar包文件名。例如,jetty-server-9.4.1.v20170120.jar對應的自動模塊名就是jett.server(使用點號代替了破折號)。

注意:最新版本的Java 9允許開發者通過jar包的manifest屬性“Automatic-Module-Name”指定自動模塊的名字,所以你可以通過檢查jar包來找出模塊名。

使用我們的新模塊

現在我的代碼可以通過編譯,接下來讓我們來遷移另一個模塊。先創建一個空的module-info.java文件,圖6顯示了新的編譯錯誤。

這裏寫圖片描述
圖6

要修復這些錯誤非常簡單,只要更新module-info.java文件就可以了:

module com.mechanitis.demo.sense.service {
   requires java.logging;
   requires javax.websocket.api;
   requires jetty.server;
   requires jetty.servlet;
   requires javax.websocket.server.impl;

   exports com.mechanitis.demo.sense.service;
}

重新編譯後生成另一個錯誤:

Error:(3, 33) java: package com.mechanitis.demo.sense.service is not visible
  (package com.mechanitis.demo.sense.service is declared in module com.mechanitis.demo.sense.service, but module com.mechanitis.demo.sense.user does not read it)
這說明要爲user模塊聲明service模塊:

module com.mechanitis.demo.sense.user {
   requires com.mechanitis.demo.sense.service;
}

然後就可以正常編譯模塊,併成功運行user服務。

結論

我們演示瞭如何重構一個已有的應用程序,讓它用上JPMS。將應用程序拆分成模塊是有好處的,將應用程序遷移到JMPS也是一件很有意義的事情,不過在這樣做之前要先確定這樣確實能給你帶來好處。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章