Open AIDoc

繁體中文

简体中文
日本語
한국어

繁體中文

简体中文
日本語
한국어

Appearance

Maven ​

Maven 是一個建構系統，可用於建構和管理任何基於 Java 的專案。

配置並啟用外掛程式 ​

kotlin-maven-plugin 會編譯 Kotlin 原始碼和模組。目前僅支援 Maven v3。

在您的 pom.xml 檔案中，於 kotlin.version 屬性中定義您要使用的 Kotlin 版本：

xml
<properties>
    <kotlin.version>2.2.20</kotlin.version>
</properties>

若要啟用 kotlin-maven-plugin，請更新您的 pom.xml 檔案：

xml
<plugins>
    <plugin>
        <artifactId>kotlin-maven-plugin</artifactId>
        <groupId>org.jetbrains.kotlin</groupId>
        <version>2.2.20</version>
    </plugin>
</plugins>

使用 JDK 17 ​

若要使用 JDK 17，請在您的 .mvn/jvm.config 檔案中加入：

none
--add-opens=java.base/java.lang=ALL-UNNAMED
--add-opens=java.base/java.io=ALL-UNNAMED

宣告儲存庫 ​

依預設，mavenCentral 儲存庫適用於所有 Maven 專案。若要存取其他儲存庫中的構件，請在 <repositories> 元素中指定每個儲存庫的 ID 和 URL：

xml
<repositories>
    <repository>
        <id>spring-repo</id>
        <url>https://repo.spring.io/release</url>
    </repository>
</repositories>

如果您在 Gradle 專案中將 mavenLocal() 宣告為儲存庫，則在 Gradle 和 Maven 專案之間切換時可能會遇到問題。如需更多資訊，請參閱宣告儲存庫。

設定依賴項 ​

Kotlin 擁有豐富的標準函式庫，可用於您的應用程式。若要在您的專案中使用標準函式庫，請將以下依賴項新增到您的 pom.xml 檔案中：

xml
<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-stdlib</artifactId>
        <version>${kotlin.version}</version>
    </dependency>
</dependencies>

如果您以 JDK 7 或 8 為目標，且 Kotlin 版本早於：

  • 1.8，請分別使用 kotlin-stdlib-jdk7 或 kotlin-stdlib-jdk8。
  • 1.2，請分別使用 kotlin-stdlib-jre7 或 kotlin-stdlib-jre8。

如果您的專案使用 Kotlin 反射或測試設施，您還需要添加相應的依賴項。反射函式庫的構件 ID 是 kotlin-reflect，測試函式庫的構件 ID 是 kotlin-test 和 kotlin-test-junit。

編譯僅限 Kotlin 的原始碼 ​

若要編譯原始碼，請在 <build> 標籤中指定原始碼目錄：

xml
<build>
    <sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
    <testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
</build>

需要引用 Kotlin Maven 外掛程式才能編譯原始碼：

xml
<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <version>${kotlin.version}</version>

            <executions>
                <execution>
                    <id>compile</id>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>

                <execution>
                    <id>test-compile</id>
                    <goals>
                        <goal>test-compile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

從 Kotlin 1.8.20 開始，您可以將上述整個 <executions> 元素替換為 <extensions>true</extensions>。啟用擴展會自動將 compile、test-compile、kapt 和 test-kapt 執行添加到您的建構中，並將它們綁定到其適當的生命週期階段。如果您需要配置執行，則需要指定其 ID。您可以在下一節中找到此範例。

如果多個建構外掛程式覆寫了預設生命週期，並且您也啟用了 extensions 選項，則 <build> 區段中的最後一個外掛程式在生命週期設定方面具有優先權。所有先前對生命週期設定的更改都將被忽略。

編譯 Kotlin 和 Java 原始碼 ​

若要編譯包含 Kotlin 和 Java 原始碼的專案，請在 Java 編譯器之前叫用 Kotlin 編譯器。在 Maven 術語中，這表示 kotlin-maven-plugin 應在 maven-compiler-plugin 之前執行，使用以下方法，確保 kotlin 外掛程式在您的 pom.xml 檔案中位於 maven-compiler-plugin 之前：

xml
<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <version>${kotlin.version}</version>
            <extensions>true</extensions> <!-- 您可以設定此選項
            以自動取得生命週期資訊 -->
            <executions>
                <execution>
                    <id>compile</id>
                    <goals>
                        <goal>compile</goal> <!-- 如果您為外掛程式啟用擴展，可以跳過 <goals> 元素 -->
                    </goals>
                    <configuration>
                        <sourceDirs>
                            <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
                            <sourceDir>${project.basedir}/src/main/java</sourceDir>
                        </sourceDirs>
                    </configuration>
                </execution>
                <execution>
                    <id>test-compile</id>
                    <goals> 
                        <goal>test-compile</goal> <!-- 如果您為外掛程式啟用擴展，可以跳過 <goals> 元素 -->
                    </goals>
                    <configuration>
                        <sourceDirs>
                            <sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
                            <sourceDir>${project.basedir}/src/test/java</sourceDir>
                        </sourceDirs>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.5.1</version>
            <executions>
                <!-- 將 default-compile 替換為 Maven 特殊處理 -->
                <execution>
                    <id>default-compile</id>
                    <phase>none</phase>
                </execution>
                <!-- 將 default-testCompile 替換為 Maven 特殊處理 -->
                <execution>
                    <id>default-testCompile</id>
                    <phase>none</phase>
                </execution>
                <execution>
                    <id>java-compile</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>
                <execution>
                    <id>java-test-compile</id>
                    <phase>test-compile</phase>
                    <goals>
                        <goal>testCompile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

配置 Kotlin 編譯器執行策略 ​

Kotlin 編譯器執行策略定義了 Kotlin 編譯器執行的位置。有兩種可用策略：

策略Kotlin 編譯器執行的位置
Kotlin daemon (預設)在其專屬的 daemon 程序中
在程序內在 Maven 程序中

依預設，會使用 Kotlin daemon。您可以透過在 pom.xml 檔案中設定以下屬性來切換到「在程序內」策略：

xml
<properties>
    <kotlin.compiler.daemon>false</kotlin.compiler.daemon>
</properties>

無論您使用哪種編譯器執行策略，您仍然需要明確配置增量編譯。

啟用增量編譯 ​

為了加速您的建構，您可以透過新增 kotlin.compiler.incremental 屬性來啟用增量編譯：

xml
<properties>
    <kotlin.compiler.incremental>true</kotlin.compiler.incremental>
</properties>

或者，使用 -Dkotlin.compiler.incremental=true 選項執行您的建構。

配置註解處理 ​

請參閱 kapt – 在 Maven 中使用。

建立 JAR 檔案 ​

若要建立一個只包含您的模組程式碼的小型 JAR 檔案，請將以下內容包含在 Maven pom.xml 檔案的 build->plugins 下，其中 main.class 定義為屬性並指向主要的 Kotlin 或 Java 類別：

xml
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.6</version>
    <configuration>
        <archive>
            <manifest>
                <addClasspath>true</addClasspath>
                <mainClass>${main.class}</mainClass>
            </manifest>
        </archive>
    </configuration>
</plugin>

建立獨立 JAR 檔案 ​

若要建立一個包含您的模組程式碼及其依賴項的獨立 JAR 檔案，請將以下內容包含在 Maven pom.xml 檔案的 build->plugins 下，其中 main.class 定義為屬性並指向主要的 Kotlin 或 Java 類別：

xml
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>2.6</version>
    <executions>
        <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals> <goal>single</goal> </goals>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>${main.class}</mainClass>
                    </manifest>
                </archive>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
        </execution>
    </executions>
</plugin>

此獨立 JAR 檔案可以直接傳遞給 JRE 以執行您的應用程式：

bash
java -jar target/mymodule-0.0.1-SNAPSHOT-jar-with-dependencies.jar

指定編譯器選項 ​

編譯器的額外選項和引數可以在 Maven 外掛程式節點的 <configuration> 元素下指定為標籤：

xml
<plugin>
    <groupId>org.jetbrains.kotlin</groupId>
    <artifactId>kotlin-maven-plugin</artifactId>
    <version>${kotlin.version}</version>
    <extensions>true</extensions> <!-- 如果您要啟用自動將執行加入您的建構 -->
    <executions>...</executions>
    <configuration>
        <nowarn>true</nowarn>  <!-- 停用警告 -->
        <args>
            <arg>-Xjsr305=strict</arg> <!-- 啟用 JSR-305 註解的嚴格模式 -->
            ...
        </args>
    </configuration>
</plugin>

許多選項也可以透過屬性來配置：

xml
<project ...>
    <properties>
        <kotlin.compiler.languageVersion>2.1</kotlin.compiler.languageVersion>
    </properties>
</project>

支援以下屬性：

JVM 特有屬性 ​

名稱屬性名稱描述可能值預設值
nowarn不生成警告true, falsefalse
languageVersionkotlin.compiler.languageVersion提供與指定 Kotlin 版本相容的原始碼"1.8", "1.9", "2.0", "2.1", "2.2" (EXPERIMENTAL)
apiVersionkotlin.compiler.apiVersion允許僅使用指定版本的捆綁函式庫中的宣告"1.8", "1.9", "2.0", "2.1", "2.2" (EXPERIMENTAL)
sourceDirs包含要編譯的原始碼檔案的目錄專案原始碼根目錄
compilerPlugins已啟用的編譯器外掛程式[]
pluginOptions編譯器外掛程式的選項[]
args其他編譯器引數[]
jvmTargetkotlin.compiler.jvmTarget生成的 JVM 位元碼的目標版本"1.8", "9", "10", ..., "24""1.8"
jdkHomekotlin.compiler.jdkHome將指定位置的自訂 JDK 包含到 classpath 中，而非預設的 JAVA_HOME

使用 BOM ​

若要使用 Kotlin 物料清單 (BOM)，請編寫對 kotlin-bom 的依賴項：

xml
<dependencyManagement>
    <dependencies>  
        <dependency>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-bom</artifactId>
            <version>2.2.20</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

生成文件 ​

標準的 Javadoc 生成外掛程式 (maven-javadoc-plugin) 不支援 Kotlin 程式碼。若要為 Kotlin 專案生成文件，請使用 Dokka。Dokka 支援混合語言專案，並且可以生成多種格式的輸出，包括標準 Javadoc。有關如何在 Maven 專案中配置 Dokka 的更多資訊，請參閱 Maven。

啟用 OSGi 支援 ​

了解如何在您的 Maven 專案中啟用 OSGi 支援。

Copyright © 2025 Open AIDoc.