FAQ

FAQにない質問がありますか？ #coil タグが付いた StackOverflow を確認するか、Github discussions を検索してください。

CoilはJavaプロジェクト、またはKotlinとJavaが混在するプロジェクトで使用できますか？

はい！ こちらをご覧ください。

画像をプリロードするにはどうすればよいですか？

ターゲットを指定せずに画像リクエストを開始します。

val request = ImageRequest.Builder(context)
    .data("https://example.com/image.jpg")
    .build()
imageLoader.enqueue(request)

これにより、画像がプリロードされ、ディスクキャッシュとメモリキャッシュに保存されます。

ディスクキャッシュにのみプリロードしたい場合は、次のようにデコードとメモリキャッシュへの保存をスキップできます。

val request = ImageRequest.Builder(context)
    .data("https://example.com/image.jpg")
    // メモリキャッシュへの書き込みを無効にします。
    .memoryCachePolicy(CachePolicy.DISABLED)
    // 画像をメモリにデコードするための時間やメモリを無駄にしないよう、デコードステップをスキップします。
    .decoderFactory(BlackholeDecoder.Factory())
    .build()
imageLoader.enqueue(request)

ロギングを有効にするにはどうすればよいですか？

ImageLoaderを構築する際に、logger(DebugLogger()) を設定してください。

::: Note DebugLogger はデバッグビルドでのみ使用してください。

:::

Java 8 または Java 11 をターゲットにするにはどうすればよいですか？

Coilは Java 8 バイトコード (bytecode) を必要とします。これは Android Gradle Plugin 4.2.0 以降および Kotlin Gradle Plugin 1.5.0 以降ではデフォルトで有効になっています。これらのプラグインの古いバージョンを使用している場合は、Gradleビルドスクリプトに以下を追加してください。

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

Coil 3.2.0 以降、coil-compose および coil-compose-core には Java 11 バイトコードが必要です。

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
    }
    kotlinOptions {
        jvmTarget = "11"
    }
}

Compose MultiplatformでSkikoのバージョン警告が表示されるのはなぜですか？

Coilが依存しているSkikoのバージョンがCompose Multiplatformのものより古い場合、Compose Multiplatformは次のような警告を表示します。

w: Skiko dependencies' versions are incompatible.

Skikoのバージョンは通常、バイナリ互換性を維持しているため、この警告は一般的に無視しても安全です。Coilのリリースは、Compose Multiplatformの安定版 (stable) リリースとそのSkikoバージョンを追跡しています。そのため、この警告が表示された場合は、まずCoilを最新バージョンにアップデートしてください。

注意: 原則として、最新のCoilリリースが依存しているバージョンと互換性がない場合を除き、Compose Multiplatformのアルファ版 (alpha) やベータ版 (beta) で使用されているSkikoバージョンに合わせるためだけの新しいリリースは行われません。

それでも警告が表示される場合は、以下のGradleプロパティを設定することで無視できます。

org.jetbrains.compose.library.compatibility.check.disable=true

ただし、このGradleプロパティは、Coilだけでなくすべてのライブラリに対してCompose Multiplatformライブラリの互換性チェックを無効にします。CoilとそのSkiko依存関係に対してのみ警告を無効にするには、ルートの build.gradle.kts ファイルに以下のコードスニペットを追加してください。

dependencies {
    components {
        all {
            if (id.group == "io.coil-kt.coil3") {
                allVariants {
                    withDependencies {
                        val hadSkikoDependency = removeAll {
                            it.group == "org.jetbrains.skiko" && it.name == "skiko"
                        }
                        if (hadSkikoDependency) {
                            // `0.150.0` を使用しているCompose Multiplatformのバージョンに合わせたSkikoバージョンに置き換えてください。
                            add("org.jetbrains.skiko:skiko:0.150.0")
                        }
                    }
                }
            }
        }
    }
}

開発スナップショットを取得するにはどうすればよいですか？

リポジトリの一覧にスナップショットリポジトリを追加します。

Gradle (.gradle):

allprojects {
    repositories {
        maven { url 'https://central.sonatype.com/repository/maven-snapshots/' }
    }
}

Gradle Kotlin DSL (.gradle.kts):

allprojects {
    repositories {
        maven("https://central.sonatype.com/repository/maven-snapshots/")
    }
}

次に、最新のスナップショットバージョンを使用して、同じアーティファクトに依存させます。

::: Note スナップショットは、CIをパスした main ブランチへの新しいコミットごとにデプロイされます。これらには破壊的変更が含まれる可能性や、不安定な場合があります。自己責任で使用してください。

:::

CoilでProguardを使用するにはどうすればよいですか？

CoilでProguardを使用するには、設定にこれらのProguardルールを追加してください。

また、Ktor、OkHttp、Coroutines 用のカスタムルールを追加する必要がある場合もあります。

::: Note Androidのデフォルトのコードシュリンカー（code shrinker）である R8を使用している場合、Coil用にカスタムルールを追加する必要はありません。ルールは自動的に追加されます。 :::