kotlin-idiomatic-refactorer-spring-aware

作者: kotlin

重構 Kotlin 程式碼,使其更清晰、更符合慣用設計,同時不破壞 Spring 行為、序列化、持久化或公開合約。適用於…

npx skills add https://github.com/kotlin/kotlin-backend-agent-skills --skill kotlin-idiomatic-refactorer-spring-aware

Kotlin Idiomatic Refactorer Spring Aware

Source mapping: Tier 2 high-value skill derived from Kotlin_Spring_Developer_Pipeline.md (SK-20).

Mission

Improve the codebase's Kotlin quality without trading away framework correctness. Prefer refactorings that increase clarity and reduce accidental complexity while preserving behavior.

Read First

  • The current implementation and its tests.
  • Public signatures, annotations, and serialization or persistence boundaries.
  • Build plugins and framework constraints already discovered in project context.
  • Existing code style and module-boundary conventions.

Refactor In This Order

  1. Characterize current behavior with tests or existing callers.
  2. Identify whether the code is transport DTO, domain logic, entity, configuration, or framework glue.
  3. Apply the smallest idiomatic improvement that materially helps readability or safety.
  4. Re-check proxy, serialization, and persistence compatibility.
  5. Keep changes incremental unless the user explicitly wants a larger rewrite.

High-Value Kotlin Moves

  • Prefer constructor injection and immutable dependencies.
  • Replace imperative branching with when when it improves exhaustive reasoning.
  • Use sealed class or sealed interface for closed result or error domains.
  • Use data class for pure transport or value models, not for JPA entities.
  • Use value classes for domain primitives when the surrounding framework stack can support them safely.
  • Prefer explicit null-handling over scattered !!.
  • Use extension functions only when they improve discoverability and do not obscure ownership or layering.

Advanced Refactoring Traps

  • More concise is not always clearer. Scope functions can hide control flow and receiver identity quickly.
  • A beautiful Kotlin one-liner can become unreadable when side effects, logging, or transactions are involved.
  • Value classes are excellent domain tools but may require extra care for Jackson, JPA, validation, and map keys.
  • Sequence and lazy pipelines are not automatically faster, especially around JPA or repeated iteration.
  • Converting mutable services to expression-heavy style must not hide exception paths or operational logging.
  • Replacing explicit classes with generic helper abstractions often harms Spring traceability and domain clarity.
  • Refactoring null handling can silently change API semantics if null, absent, and default were distinct before.

Kotlin Language Nuances

  • Public inline functions, default arguments, and generated overloads can affect binary compatibility for library modules more than teams expect.
  • A read-only Kotlin collection type does not guarantee an immutable backing collection. Refactors that assume true immutability can still leak mutation.
  • copy() on data classes is convenient but can weaken domain invariants when state transitions should stay explicit.
  • Exhaustive when over sealed hierarchies improves safety, but only if the hierarchy is truly closed in the relevant module boundary.
  • Reified generics and extension-heavy DSLs can improve ergonomics while making stack traces and Java interop worse. Use them where the tradeoff is worth it.

Expert Heuristics

  • Prefer refactors that make invalid states harder to represent, not only code shorter to read.
  • Keep business transitions explicit when the domain has invariants, auditing, or transactional significance.
  • If a refactor improves local beauty but obscures logs, traces, or step-by-step debugging, it is probably not worth it.
  • In shared modules, treat source compatibility and binary compatibility as separate review questions.

Spring-Aware Safety Rules

  • Do not refactor proxy-reliant classes in ways that remove needed openness or change bean boundaries accidentally.
  • Do not convert entities into data classes or over-lean value objects without checking persistence support.
  • Do not change constructor shapes for DTOs or config classes without checking Jackson and configuration binding.
  • Do not move logic into extension functions that cross architecture layers implicitly.
  • Do not hide important framework interactions behind clever utility abstractions.

Output Contract

Return these sections:

  • Refactoring intent: what quality problem is being solved.
  • Safe transformations: the concrete Kotlin improvements that are appropriate here.
  • Framework constraints: the Spring, Jackson, JPA, or config rules that limit the refactor.
  • Minimal patch plan: incremental changes in a safe order.
  • Verification: which tests or runtime checks protect behavior.

Guardrails

  • Do not refactor for aesthetics alone when risk is non-trivial.
  • Do not introduce advanced Kotlin constructs just to prove idiomatic knowledge.
  • Do not compress code until debugability suffers.
  • Do not change public contracts without calling that out explicitly.

Quality Bar

A good run of this skill leaves the code more Kotlin-native and still boringly reliable in Spring. A bad run produces elegant Kotlin that is harder to debug, harder to evolve, or incompatible with framework behavior.

來自 kotlin 的更多技能

kotlin-backend-jpa-entity-mapping
kotlin
Kotlin 的 data class 很適合用於 DTO,但對 JPA 實體來說卻很危險。Hibernate 依賴於 data class 所破壞的識別語義:基於所有欄位的 equals / hashCode 會在狀態變更後破壞 Set / Map 的成員資格,而自動生成的 copy() 則會建立受管實體的分離副本。
kotlin-tooling-agp9-migration
kotlin
Android Gradle Plugin 9.0 使得 Android 應用程式與函式庫外掛在同一個模組中與 Kotlin Multiplatform 外掛不相容。此技能將引導您完成遷移。
kotlin-tooling-cocoapods-spm-migration
kotlin
將 KMP 專案從 CocoaPods(kotlin("native.cocoapods"))遷移至 Swift Package Manager(swiftPMDependencies DSL)——將 pod() 替換為 swiftPackage(),…
kotlin-tooling-immutable-collections-0-5-x-migration
kotlin
將 Kotlin(及 Java)程式碼從 kotlinx.collections.immutable 0.3.x / 0.4.x 遷移至最新的 0.5.x 版本。0.5.x 系列重新命名了所有回傳副本的方法…
kotlin-tooling-java-to-kotlin
kotlin
使用嚴謹的四步驟轉換方法,將 Java 原始碼轉換為慣用的 Kotlin,並在每一步驟檢查五個不變量。支援框架感知轉換,能處理註解站點目標、函式庫慣用語及 API 保留。
kotlin-tooling-native-build-performance
kotlin
診斷並修復針對 iOS 的 Kotlin Multiplatform 專案中,Kotlin/Native 編譯與連結緩慢的問題。當使用者回報 iOS 或…速度緩慢時使用。
kotlin-spring-proxy-compatibility
kotlin
Diagnose and prevent Kotlin plus Spring proxy failures around `@Transactional`, `@Cacheable`, `@Async`, method security, retry, configuration proxies, and JPA…
ci-cd-containerization-advisor
kotlin
為 Kotlin 加 Spring 應用程式設計可重現的建置、映像檔與部署管線,包括 CI 驗證、分層容器、部署安全性……