memo

Gradle

Gradle

build.gradle 設定

MANIFEST.MF に属性追加

jar {
  manifest {
    attributes "Implementation-Version": "1.0"
  }
}

Java の警告出力を有効化

tasks.withType(JavaCompile) {
  options.compilerArgs << "-Xlint:deprecation"
}

Fat JAR 作成

Gradle 7.2 で確認

createjfatJar タスクを追加して Fat JAR をビルド

task createfatJar(type: Jar) {
    baseName = 'Fuga'
    duplicatesStrategy 'exclude'
    manifest {
        attributes 'Main-Class': 'com.example.Hoge'
    }
    archiveClassifier = "all"
    from {
        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
    }
    with jar
}

ビルド
./gradlew createfatJar

デフォルトの jar タスク定義を上書きして Fat JAR のビルド定義

jar {
    duplicatesStrategy 'exclude'
    manifest {
        attributes 'Main-Class': 'com.example.Hoge'
    }
    from {
        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
    }
}

サンプル

plugins {
  id 'java'
  // git からコミットのハッシュ値、タグを取得してくれるプラグイン
  id 'com.palantir.git-version' version '0.12.3'
}

group 'com.examples'
version 'v1.2'

repositories {
    mavenCentral()
}

tasks.withType(JavaCompile).configureEach {
  // コンパイル時の警告を表示する設定
  options.deprecation = true
  options.compilerArgs << '-Xlint:unchecked'
}

// git からバージョン情報取得
def gitInfo = versionDetails()
version = gitInfo.lastTag
def implementationVersion = version + '(' + gitInfo.gitHash[0..7] + ')'

jar {
  // hoge.jar がビルドされる
  archiveBaseName = 'hoge'
  // これを指定しなかった場合、hoge-0.0.1.jar といった感じの JAR ファイルがビルドされる。
  archiveVersion = ''
  // MANIFEST.MF に設定する内容
  manifest {
    attributes(
            // 起動するクラス
            'Main-Class': 'com.examples.Hoge',
            // gitかから取得したバージョン
            'Implementation-Version' : implementationVersion,
            'Implementation-Title' : 'Hoge'
    )
  }
  // Fat JAR をビルド
  duplicatesStrategy 'exclude'
  from {
    configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
  }
}

dependencies {
  implementation group: 'org.slf4j', name: 'slf4j-api', version: '2.0.12'
  testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
  testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}

test {
  useJUnitPlatform()
}

ビルド
./gradlew jar

Kotlin 用 Fat JAR 作成

JDK 21 + Kotlin 1.9.22 で Fat JAR をビルドするサンプル

  plugins {
    id 'org.jetbrains.kotlin.jvm' version '1.9.22'
    id 'application'
}

group = 'org.example'
version = '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

jar {
    archiveBaseName = 'hoge'
    archiveVersion = ''
    duplicatesStrategy 'exclude'
    manifest {
        attributes(
                'Main-Class': 'MainKt',
                'Implementation-Title' : 'Hoge'
        )
    }
    from {
        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
    }
}

dependencies {
    implementation("org.slf4j:slf4j-api:2.0.12")
    implementation("ch.qos.logback:logback-classic:1.4.14")
}

test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain(21)
}

application {
    mainClass.set('MainKt')
}

JDK 21 を使う場合は gradle-wrapper.properties に Gradle 8.x を使うように指定しておくとよさそう。

distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip

FatJAR にスクリプトを結合(内蔵)して、実行可能な JAR ファイルを作成

bin ディレクトリを作成
```
mkdir bin
```
bin ディレクトリに exec.sh を作成して次のように JAR ファイルを実行するための内容を記述(ファイル名は適当に)
```
#!/bin/sh
JAVA_OPTS='-Xmx32M'
java $JAVA_OPTS -jar "$0" "$@"
exit $?
```
bin ディレクトリに makeExecutable.sh を作成して次のようにスクリプトと JAR ファイルを結合して実行可能ファイルにするための内容を記述(ファイル名は適当に)
```
#!/bin/bash
  
cat bin/exec.sh build/libs/hoge.jar > build/libs/hoge
chmod 755 build/libs/hoge
```

build.gradle を編集して実行可能ファイルにするためのスクリプトを呼び出す

task executable(type: Exec) {
    dependsOn "build"
    commandLine '/bin/bash', 'bin/makeExecutable.sh'
}

gradle で executable を実行すると、build タスク実行後に executable タスクが実行される。
```
./gradlew executable
```

(参考)

コマンド

タスク一覧表示
gradle tasks
実行
gradle run
依存関係表示
gradle dependencies
実行時の依存関係だけを表示
gradle dependencies --configuration runtime
配布用ファイルを作成
gradle assembleDist
コンパイル
gradle compileKotlin
gradle compileJava
gradle compileTestKotlin
gradle compileTestJava
JARファイル作成
gradle build
- テストをスキップ
  gradle build -x test

Tips

build.gradle に指定したライブラリから参照されている(依存している)ライブラリを一覧表示
```
./gradlew dependencies --configuration runtimeClasspath
```
gradle プロジェクトで使用している gradle のバージョンを上げる
```
./gradlew wrapper --gradle-version "8.14.3"
```
最新に上げる場合は
```
./gradlew wrapper --gradle-version "latest"
```
gradle プロセスを常駐かさせない(ロックファイルの衝突防止)
--no-daemon を指定
```
./gradlew build --no-daemon
```

トラブル対応

build ができない(IDLE 状態で止まる)
ESET をインストールしている場合は、ファイアウォール設定を対話型に変更して、Java から外部への接続を適切に許可する。
Gradle のキャッシュがおかしくなった
./gradlew clean build --refresh-dependencies

Gradle could not start your build. でビルドが実行できない
次のメッセージが表示される

  FAILURE: Build failed with an exception.
  
* What went wrong:
Gradle could not start your build.
> Cannot create service of type BuildSessionActionExecutor using method LauncherServices$ToolingBuildSessionScopeServices.createActionExecutor() as there is a problem with parameter #21 of type BuildLifecycleAwareVirtualFileSystem.
            > Could not create service of type FileAccessTimeJournal using GradleUserHomeScopeServices.createFileAccessTimeJournal().
               > Timeout waiting to lock journal cache (/Users/xxx/.gradle/caches/journal-1). It is currently in use by another Gradle instance.
                 Owner PID: 7328
                 Our PID: 7822
                 Owner Operation: 
                 Our operation: 
                 Lock file: /Users/xxx/.gradle/caches/journal-1/journal-1.lock

別の gradle プロセスが動いていて、ロックを獲得できない? 模様
Owner PID に表示されているプロセスID(7328)を指定してプロセスを kill。

kill 7328