Настройка проекта Maven

Целевая версия JVM

Параметр <extensions> гарантирует, что компиляторы Kotlin и Maven используют одну и ту же целевую версию байт-кода.

Плагин Kotlin Maven автоматически определяет целевую версию JVM в следующем порядке:

Компиляция исходного кода Kotlin и Java

Чтобы скомпилировать проект с исходными файлами Kotlin и Java, убедитесь, что компилятор Kotlin запускается до компилятора Java.

Компилятор Java не видит объявления Kotlin, пока они не скомпилированы в файлы .class. Если код Java использует классы Kotlin, сначала необходимо скомпилировать эти классы, чтобы избежать ошибок cannot find symbol.

Maven определяет порядок выполнения плагинов на основе двух основных факторов:

• Порядок объявления плагинов в файле pom.xml.

• Встроенные выполнения по умолчанию, например default-compile и default-testCompile, которые всегда запускаются перед пользовательскими выполнениями независимо от их положения в файле pom.xml.

Чтобы управлять порядком выполнения:

• Объявите kotlin-maven-plugin перед maven-compiler-plugin.

• Отключите выполнения по умолчанию плагина компилятора Java.

• Добавьте пользовательские выполнения, чтобы явно управлять этапами компиляции.

Чтобы применить плагин Kotlin Maven, обновите файл сборки pom.xml следующим образом:

<build>
    <plugins>
        <!-- Kotlin compiler plugin configuration -->
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <version>${kotlin.version}</version>
            <executions>
                <execution>
                    <id>kotlin-compile</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                    <configuration>
                        <sourceDirs>
                            <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
                            <!-- Ensure Kotlin code can reference Java code -->
                            <sourceDir>${project.basedir}/src/main/java</sourceDir>
                        </sourceDirs>
                    </configuration>
                </execution>
                <execution>
                    <id>kotlin-test-compile</id>
                    <phase>test-compile</phase>
                    <goals>
                        <goal>test-compile</goal>
                    </goals>
                    <configuration>
                        <sourceDirs>
                            <sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
                            <sourceDir>${project.basedir}/src/test/java</sourceDir>
                        </sourceDirs>
                    </configuration>
                </execution>
            </executions>
        </plugin>

        <!-- Maven compiler plugin configuration -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.15.0</version>
            <executions>
                <!-- Disable default executions -->
                <execution>
                    <id>default-compile</id>
                    <phase>none</phase>
                </execution>
                <execution>
                    <id>default-testCompile</id>
                    <phase>none</phase>
                </execution>

                <!-- Define custom executions -->
                <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 компилируется первым.

• Код Java компилируется после Kotlin и может ссылаться на классы Kotlin.

• Поведение Maven по умолчанию не переопределяет порядок плагинов.

Подробнее о том, как Maven обрабатывает выполнения плагинов, см. в официальной документации Maven: Руководство по идентификаторам выполнений плагинов по умолчанию.

Компиляция исходного кода только на Kotlin

Чтобы скомпилировать проект, содержащий только исходные файлы Kotlin, объявите корневые каталоги исходного кода и настройте плагин Kotlin Maven:

1. Укажите каталоги исходного кода в разделе <build>:

   <build>
       <sourceDirectory>src/main/kotlin</sourceDirectory>
       <testSourceDirectory>src/test/kotlin</testSourceDirectory>
   </build>
   

2. Убедитесь, что плагин Kotlin Maven применен:

   <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>
   

Установка версии JDK

Kotlin поддерживает цепочки инструментов Maven, которые помогают управлять версией JDK в сборке.

Если настроить maven-toolchains-plugin в сборке, можно указать версию JDK для компиляции Kotlin независимо от версии JVM, в которой работает Maven (заданной в пути JAVA_HOME). Затем плагин Kotlin Maven автоматически выбирает указанную цепочку инструментов JDK.

Это позволяет настроить одну цепочку инструментов, которая управляет версией JDK для всех плагинов сборки, включая компиляцию Kotlin. Например:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-toolchains-plugin</artifactId>
    <version>3.2.0</version>
    <executions>
        <execution>
            <goals>
                <goal>toolchain</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <toolchains>
            <jdk>
                <version>21</version>
            </jdk>
        </toolchains>
    </configuration>
</plugin>

Учитывайте приоритет различных способов указания версии JDK:

• Версия JDK, заданная параметром jdkHome в конфигурации kotlin-maven-plugin, всегда имеет приоритет над версией из цепочки инструментов.

• Версия JDK в maven-toolchains-plugin переопределяет версию JDK, заданную в пути JAVA_HOME.

Также можно использовать специальный для плагина параметр <jdkToolchain>, чтобы напрямую задать версию JDK в цепочке инструментов для kotlin-maven-plugin. В отличие от использования maven-toolchains-plugin, этот параметр влияет только на компиляцию Kotlin и не затрагивает другие плагины сборки.