KotlinユーザのためのJSpecify入門 / JSpecify 101 for Kotlin Devs

集まれKotlin好き！Kotlin愛好会 vol.55で発表した内容です。

Transcript

1. Kotlinユーザのための JSpecify入門 2024年11月 Kotlin愛好会 Kengo TODA 1
2. JSpecifyとはなんぞ Kotlinでクラスファイルをコンパイルするとorg.jetbrains.annotations パッケージのアノテー ションを使ってnull-abilityに関する情報を補足します。 これはJetBrainsが独自に実装したパッケージで他のツールとの互換性に課題があります。たとえば JSR305やFindBugsが提供しているアノテーションとの互換はありませんし、SpotBugsやPMDといっ た静的解析ツールによるサポートも限定的です。 そこで業界標準アノテーションを作ってこの問題を解決しようとしているのがJSpecifyです。2024 年7月にv1.0リリースもされたので、今からnull-abilityをアノテーションで表明するならJSpecifyが おすすめです！ 2
3. アノテーションを javap -v で覗いてみる $ javap -v Sample RuntimeInvisibleAnnotations: 0: #13() org.jetbrains.annotations.NotNull RuntimeInvisibleAnnotations: 0: #15() org.jetbrains.annotations.Nullable class Sample { fun notNull(): Object = Object() fun nullable(): Object? = Object() } 3
4. 4 https://speakerdeck.com/eller86/goodbye-jsr305-hello-jspecify
5. ※ Java SE 8でTYPE_USEが使えるようになった（JSR 308） 5 https://speakerdeck.com/eller86/goodbye-jsr305-hello-jspecify
6. KotlinにとってのJSpecify Kotlinでは、JSpecifyアノテーションを尊重して警告を出すことができます。 またKotlin 2.1.0からはエラーとして扱うことを目指しています。なお1.5.20以降であれば、オプ ションでエラーとして扱うこともできます。 6 https://kotlinlang.org/docs/whatsnew1520.html#support-for-jspecify-nullness-annotations compilerOptions { freeCompilerArgs = listOf( "-Xjspecify-annotations=strict", "-Xtype-enhancement-improvements-strict-mode", ) }
7. JSpecifyは今後どうなるか JSpecifyはコミュニティ主導の実装とは言え、最もよく議論・ドキュメントされたアノテーションと しては既に利用価値がある。FindBugsやJSR305などのTYPE_USE未対応アノテーションよりは優先 的に採用したいし、TYPE_USE以外もサポートしてしまっているJetBrainsアノテーションと比べても 有利な面はある。 一方でJava言語公式のDraft JEPとしてnullness markerを作ろうという議論があり、その進展によっ てはKotlinにとってのJSpecifyがオワコン化する可能性は否定できない。 7 https://bugs.openjdk.org/browse/JDK-8303099
8. まとめ • Kotlinは2.1.0からJSpecifyを尊重しエラーとして扱うようになる予定 • 自家製JavaライブラリをKotlinから読んでいる場合、JavaライブラリのAPIをJSpecifyアノ テーションで修飾すると良い ◦ その引数や戻り値のnullnessをうまく扱える • 一方でJSpecifyがデファクトスタンダードになるかは未知数のため、とりあえず採用するとし ても今後の動きは見たほうが良いかも。 8