安裝 Java 模組

系統相容性

Java 模組會在 macOS 和 Linux 發行版本上定期建置和測試。

Java 相容性

Java 模組與 JDK 11 及更高版本相容。目前，JDK 版本 11、17、21 和最新版本在 CI 中經過測試。

請注意，必須公開一些 JDK 內部元件，方法是在 java 命令中加入 --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED

# Directly on the command line
$ java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar ...
# Indirectly via environment variables
$ env JDK_JAVA_OPTIONS="--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED" java -jar ...

否則，您可能會看到類似 module java.base does not "opens java.nio" to unnamed module 或 module java.base does not "opens java.nio" to org.apache.arrow.memory.core 的錯誤訊息

請注意，此命令已從 Arrow 15 和更早版本變更。如果您仍使用該版本的旗標 (--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED)，您將會看到 module java.base does not "opens java.nio" to org.apache.arrow.memory.core 錯誤。

如果您使用 flight-core 或相依模組，您需要標記 flight-core 可以讀取未命名的模組。修改上面的 Flight 命令

# Directly on the command line
$ java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar ...
# Indirectly via environment variables
$ env JDK_JAVA_OPTIONS="--add-reads=org.apache.arrow.flight.core=ALL-UNNAMED --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED" java -jar ...

否則，您可能會看到類似 java.lang.IllegalAccessError: superclass access check failed: class org.apache.arrow.flight.ArrowMessage$ArrowBufRetainingCompositeByteBuf (in module org.apache.arrow.flight.core) cannot access class io.netty.buffer.CompositeByteBuf (in unnamed module ...) because module org.apache.arrow.flight.core does not read unnamed module ... 的錯誤訊息

最後，如果您使用 arrow-dataset，您也需要回報 JDK 內部元件需要公開。修改上面的 arrow-memory 命令

# Directly on the command line
$ java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar ...
# Indirectly via environment variables
$ env JDK_JAVA_OPTIONS="--add-opens=java.base/java.nio=org.apache.arrow.dataset,org.apache.arrow.memory.core,ALL-UNNAMED" java -jar ...

否則，您可能會看到類似 java.lang.RuntimeException: java.lang.reflect.InaccessibleObjectException: Unable to make static void java.nio.Bits.reserveMemory(long,long) accessible: module java.base does not "opens java.nio" to module org.apache.arrow.dataset 的錯誤訊息

如果使用 Maven 和 Surefire 進行單元測試，這個引數也必須加入到 Surefire 中。

從 Maven 安裝

預設情況下，Maven 將從中央儲存庫下載：https://repo.maven.apache.org/maven2/org/apache/arrow/

使用所需的 Java 模組 (例如：arrow-vector 和 arrow-memory-netty) 設定您的 pom.xml。

<?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">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <arrow.version>9.0.0</arrow.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.apache.arrow</groupId>
            <artifactId>arrow-vector</artifactId>
            <version>${arrow.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.arrow</groupId>
            <artifactId>arrow-memory-netty</artifactId>
            <version>${arrow.version}</version>
        </dependency>
    </dependencies>
</project>

已提供物料清單 (BOM) 模組，以簡化新增 Arrow 模組的流程。這樣就不需要為每個模組指定版本。上述的替代方案會是

<?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">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <arrow.version>15.0.0</arrow.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.apache.arrow</groupId>
            <artifactId>arrow-vector</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.arrow</groupId>
            <artifactId>arrow-memory-netty</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.arrow</groupId>
                <artifactId>arrow-bom</artifactId>
                <version>${arrow.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

若要使用 Arrow Flight 相依性，也請加入 os-maven-plugin 外掛程式。此外掛程式會產生有用的平台相依屬性，例如解析 Flight 傳遞相依性所需的 os.detected.name 和 os.detected.arch。

<?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">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <arrow.version>9.0.0</arrow.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.apache.arrow</groupId>
            <artifactId>flight-core</artifactId>
            <version>${arrow.version}</version>
        </dependency>
    </dependencies>
    <build>
        <extensions>
            <extension>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>1.7.0</version>
            </extension>
        </extensions>
    </build>
</project>

透過 Maven 執行單元測試時，必須加入 --add-opens 旗標

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M6</version>
            <configuration>
                    <argLine>--add-opens=java.base/java.nio=ALL-UNNAMED</argLine>
            </configuration>
        </plugin>
    </plugins>
</build>

或者，它們可以透過環境變數加入，例如在執行程式碼時

JDK_JAVA_OPTIONS="--add-opens=java.base/java.nio=ALL-UNNAMED" mvn exec:java -Dexec.mainClass="YourMainCode"

從原始碼安裝

請參閱 Java 開發。

IDE 設定

一般來說，應該不需要額外的設定。但是，請確保您的 Maven 或其他組建設定具有如上所述的 --add-opens 旗標，以便 IDE 可以偵測到它並使用該旗標執行測試。