Android アプリの Gradle ビルドで、compileDebugKotlin が Kotlin の可視性のエラー 1 件だけで止まりました。
原因は、public の関数が internal の型(SoundEvent)を戻り値の型引数に含んでいたことです。
その関数を internal にして、同じ形の公開漏れもまとめて直したら、ビルドは最後まで通りました。
症状
試験用のモジュールの debug のソースをコンパイルするところで失敗しました。製品本体(app)のコンパイルは通っていて、止まったのは試験用のモジュールだけです。
> Task :productUiVerification:compileDebugKotlin FAILED
e: file:///.../src/debug/java/.../Stage78FixtureActivities.kt:194:9 'public' function exposes its 'internal' return type argument 'SoundEvent'.
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':productUiVerification:compileDebugKotlin'.
エラーは 1 件だけで、ビルドは始めてから約 3 分で止まりました。
環境
- Windows
- Android の Gradle ビルド(オフライン、ヒープ 4096MB)
- 失敗したタスク:
:productUiVerification:compileDebugKotlin(試験用モジュールの debug のソース)
原因
Kotlin では、public の宣言が、それより公開の範囲が狭い型を外に見せてはいけません。メッセージの return type argument とあるとおり、戻り値の型そのものでなくても、戻り値の型引数(List<…> の … の部分など)に internal の型が入っているだけで、このエラーになります。
今回は、試験の下ごしらえ(fixture)用の関数が public になっていました(Kotlin では修飾子なしも public です)。その関数が internal の SoundEvent を型引数に含む値を返していたので、コンパイラーに止められました。
どちらにそろえるかで、直し方は 2 つあります。
| 直し方 | 影響 |
|---|---|
関数のほうを internal にする |
公開の範囲が狭まるだけ。SoundEvent の守りはそのまま |
SoundEvent のほうを public にする |
本来隠しておきたい型が外から見えるようになる |
SoundEvent を internal にしていたのは意図した設計だったので、関数のほうを狭めました。
解決手順
- ビルドのログから、エラーの行だけを抜き出す(PowerShell)。
powershell
Select-String -Path .\build.log -Pattern '^e: |FAILED|What went wrong' -Encoding utf8 | Select-Object -First 25 | % { $_.Line }
- エラーの出たファイルと行(今回は
Stage78FixtureActivities.kt:194)の関数にinternalを付ける。 - 同じファイルや同じ fixture 一式に、
internalの型を返す(型引数に含む)publicの関数がほかに無いかを探し、あれば同じくinternalにする。 - もう一度ビルドする。
今回は 3 の「同じ形の公開漏れ」もまとめて直してからビルドし直し、ビルドは合格、JVM の試験も 218 件すべて合格しました。
再発防止・気づき
- 修飾子なし=
publicなので、internalの型を扱う試験用の関数には最初からinternalを付けておくと、この手のエラーを踏みません。 - エラーが 1 件でも、直すときは fixture 一式を見て同じ形をまとめて直しておくと、あとで別の関数を足したときに同じエラーを踏みにくくなります。
- 製品本体のコンパイルが通っていても、試験用のモジュールの debug のソースは別にコンパイルされます。本体が通ったからといって安心できません。