Kotlin2でdataクラスの copyメソッドを禁止する/Data class copy function to have the same visibility as constructor

by A1

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

© 2024 Loglass Inc. Kotlin1.9まで private constructorで外部からコンストラクタの使用を禁止し、Factoryメソッドでのインスタンス生成を強制したつもりでも... data class PositiveInteger private constructor(val number: Int) { companion object { // 0より大きい値しか受け付けないFactoryメソッド fun create(number: Int): PositiveInteger? = if (number > 0) PositiveInteger(number) else null } } fun main() { val positiveNumber = PositiveInteger.create(42) ?: return }

Slide 6

Slide 6 text

Slide 7

Slide 7 text

© 2024 Loglass Inc. Kotlin1.9まで仕方ないので、意図しないところでcopyを呼び出さないようにArchUnitでチェックしていた。 @Test fun `ドメイン層のデータクラスに付属する copyメソッドを呼び出すことはできない `() { val allApplicationClasses = ClassFileImporter() .withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS) .importPackages("com.example") methods() .should(BanDomainLayerDataClassCopyCondition) .check(allApplicationClasses) } private object BanDomainLayerDataClassCopyCondition : ArchCondition("data classのcopyは、同じクラス内でしかコールすることができない ") { override fun check(method: JavaMethod, events: ConditionEvents) { if (method.name != "copy\$default") return method.callsOfSelf.forEach { caller -> // this.copyは許容する if (method.owner != caller.originOwner) events.add(SimpleConditionEvent.violated(method,"エラーメッセージ ")) } } }

Slide 8

Slide 8 text

Slide 9

Slide 9 text

© 2024 Loglass Inc. タイムライン ● フェーズ1: 2.0.20　←今ここ ○ 警告が表示されるようになった。 ○ @ConsistentCopyVisibilityで2.2以降の動作を先行してオプトイン可能。 ○ @ExposedCopyVisibilityで明示的にcopyメソッドを公開可能。 ● フェーズ2: 2.2（予定） ○ 警告表示だった箇所がエラーに変わり、copyメソッドを呼び出せなくなる。 ○ 互換性のためバイナリから消える訳ではない。 ● フェーズ3: 2.3 or 2.4（予定） ○ copyメソッドの可視性はプライマリコンストラクタと同じになる。 ○ 役割を終えた@ConsistentCopyVisibilityは廃止される。 Kotlin2から

Slide 10

Slide 10 text

Slide 11

Slide 11 text

© 2024 Loglass Inc. 先行して試す @ConsistentCopyVisibilityを指定して2.2の動作をオプトインできる。 @ConsistentCopyVisibility data class PositiveInteger private constructor(val number: Int) { companion object { fun create(number: Int): PositiveInteger? = if (number > 0) PositiveInteger(number) else null } } fun main() { val positiveNumber = PositiveInteger.create(42) ?: return val negativeNumber = positiveNumber.copy(number = -1) // Cannot access 'fun copy(number: Int = ...): PositiveInteger': it is private in '/PositiveInteger'. }

Slide 12

Slide 12 text

© 2024 Loglass Inc. 先行して試すアノテーションを個別のクラスに付与するのは現実的ではないので、コンパイラオプションで一括指定して、エラーになった箇所を少しずつ直すと良さそう。 // build.gradle.kts tasks { named("compileKotlin", KotlinCompilationTask::class.java) { compilerOptions { freeCompilerArgs.add("-Xconsistent-data-class-copy-visibility") } } }

Slide 13

Slide 13 text

© 2024 Loglass Inc. 先行して試す明示的に許可したい場合は、@ExposedCopyVisibilityを付与することも可能。 @ExposedCopyVisibility data class PositiveInteger private constructor(val number: Int) { companion object { fun create(number: Int): PositiveInteger? = if (number > 0) PositiveInteger(number) else null } } fun main() { val positiveNumber = PositiveInteger.create(42) ?: return // エラーにならない val negativeNumber = positiveNumber.copy(number = -1) }