🐕

Gradle buildSrc で Kotlin ファイルを有効化する手順

2023/03/25に公開

サーバサイド Kotlin で開発するとき、./buildSrc/ にはビルド関連のコードをまとめられます。
Kotlin で記述したコード (.kt) を使えるようにするためのシンプルな文献が見当たらなかったので、メモとして記載します。

手順はとても簡単です。

  1. build.gradle.kts を作る
  2. src/main/kotlin/ を作る

特にポイントとなるのが Step 1 で、これによって、src/main/kotlin/ をビルドソートしてGradleが認識するようになります。

(1) build.gradle.kts の作成

./buildSrc/ 内に build.gradle.kts を作成します。

plugins {
    `kotlin-dsl`
    kotlin("jvm") version "1.5.10"
}

repositories{
    mavenCentral()
}

このファイルは、アプリケーション用の ./build.gradle.kts が存在していたとしても、別に作成する必要があります。プロジェクトルートディレクトリのものはアプリケーションコードをコンパイルするためのもので、./buildSrc/ 内のものはビルドスクリプトをコンパイルするためのものです。

(2) Kotlin ビルドスクリプトの配置

Kotlin で記述したビルドスクリプト用のファイルを下記のディレクトリ以下に配置します。

mkdir -p ./buildSrc/src/main/kotlin/

IntelliJ IDEA を使っていると、./buildSrc/src/main/java/ 以下に .kt を格納しても一見使えるように見えるのですが、いざきちんとコンパイルすると上手く動きません。言語ごとにディレクトリを分ける必要があるようです。

Discussion