Kotlin Spring Boot 最佳实践指南：构建高质量后端应用

kotlin-springboot by github/awesome-copilot

7,600 周安装量

27,200 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/github/awesome-copilot --skill kotlin-springboot

开发开发运维

🇨🇳中文介绍

使用 Kotlin 开发 Spring Boot 的最佳实践

你的目标是帮助我编写高质量、符合 Kotlin 语言习惯的 Spring Boot 应用程序。

项目设置与结构

构建工具： 使用 Maven (pom.xml) 或 Gradle (build.gradle) 并配合 Kotlin 插件 (kotlin-maven-plugin 或 org.jetbrains.kotlin.jvm)。
Kotlin 插件： 对于 JPA，启用 kotlin-jpa 插件，以便自动使实体类成为 open 类，而无需编写样板代码。
Starters： 像往常一样使用 Spring Boot starters（例如 spring-boot-starter-web、spring-boot-starter-data-jpa）。

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

依赖注入与组件

主构造函数： 始终使用主构造函数进行必需的依赖注入。这是 Kotlin 中最符合语言习惯且最简洁的方法。
不可变性： 在主构造函数中将依赖项声明为 private val。在任何地方都优先使用 val 而不是 var，以促进不可变性。
组件注解： 像在 Java 中一样使用 @Service、@Repository 和 @RestController 注解。

外部化配置： 使用 application.yml，因为它具有良好的可读性和层次结构。
类型安全属性： 将 @ConfigurationProperties 与 data class 结合使用，以创建不可变的、类型安全的配置对象。
配置文件： 使用 Spring Profiles (application-dev.yml、application-prod.yml) 来管理特定环境的配置。
密钥管理： 切勿硬编码密钥。使用环境变量或专门的密钥管理工具，如 HashiCorp Vault 或 AWS Secrets Manager。

Web 层（控制器）

RESTful API： 设计清晰且一致的 RESTful 端点。
DTO 使用数据类： 为所有 DTO 使用 Kotlin 的 data class。这可以免费提供 equals()、hashCode()、toString() 和 copy() 方法，并促进不可变性。
验证： 在 DTO 数据类上使用带有注解（@Valid、@NotNull、@Size）的 Java Bean 验证 (JSR 380)。
错误处理： 使用 @ControllerAdvice 和 @ExceptionHandler 实现全局异常处理器，以提供一致的错误响应。

业务逻辑： 将业务逻辑封装在 @Service 类中。
无状态性： 服务应该是无状态的。
事务管理： 在服务方法上使用 @Transactional。在 Kotlin 中，这可以应用于类级别或函数级别。

数据层（仓库）

JPA 实体： 将实体定义为类。请记住，它们必须是 open 的。强烈建议使用 kotlin-jpa 编译器插件来自动处理此问题。
空安全： 利用 Kotlin 的空安全特性（?）在类型级别明确定义哪些实体字段是可选的或必需的。
Spring Data JPA： 通过扩展 JpaRepository 或 CrudRepository 来使用 Spring Data JPA 仓库。
协程： 对于响应式应用程序，在数据层利用 Spring Boot 对 Kotlin 协程的支持。

伴生对象记录器： 声明记录器的惯用方式是在伴生对象中。

companion object {
    private val logger = LoggerFactory.getLogger(MyClass::class.java)
}

参数化日志记录： 使用参数化消息（logger.info("正在处理用户 {}...", userId)）以提高性能和清晰度。

JUnit 5： JUnit 5 是默认选择，并且可以与 Kotlin 无缝协作。
符合习惯的测试库： 为了编写更流畅、更符合 Kotlin 习惯的测试，可以考虑使用 Kotest 进行断言，使用 MockK 进行模拟。它们是专为 Kotlin 设计的，提供了更具表现力的语法。
测试切片： 使用测试切片注解，如 @WebMvcTest 或 @DataJpaTest，来测试应用程序的特定部分。
Testcontainers： 使用 Testcontainers 与真实的数据库、消息代理等进行可靠的集成测试。

协程与异步编程

suspend 函数： 对于非阻塞的异步代码，在控制器和服务中使用 suspend 函数。Spring Boot 对协程有很好的支持。
结构化并发： 使用 coroutineScope 或 supervisorScope 来管理协程的生命周期。

🇺🇸English

Spring Boot with Kotlin Best Practices

Your goal is to help me write high-quality, idiomatic Spring Boot applications using Kotlin.

Project Setup & Structure

Build Tool: Use Maven (pom.xml) or Gradle (build.gradle) with the Kotlin plugins (kotlin-maven-plugin or org.jetbrains.kotlin.jvm).
Kotlin Plugins: For JPA, enable the kotlin-jpa plugin to automatically make entity classes open without boilerplate.
Starters: Use Spring Boot starters (e.g., spring-boot-starter-web, spring-boot-starter-data-jpa) as usual.
Package Structure: Organize code by feature/domain (e.g., com.example.app.order, com.example.app.user) rather than by layer.

Dependency Injection & Components

Primary Constructors: Always use the primary constructor for required dependency injection. It's the most idiomatic and concise approach in Kotlin.
Immutability: Declare dependencies as private val in the primary constructor. Prefer val over var everywhere to promote immutability.
Component Stereotypes: Use @Service, @Repository, and @RestController annotations just as you would in Java.

Configuration

Externalized Configuration: Use application.yml for its readability and hierarchical structure.
Type-Safe Properties: Use @ConfigurationProperties with data class to create immutable, type-safe configuration objects.
Profiles: Use Spring Profiles (application-dev.yml, application-prod.yml) to manage environment-specific configurations.
Secrets Management: Never hardcode secrets. Use environment variables or a dedicated secret management tool like HashiCorp Vault or AWS Secrets Manager.

Web Layer (Controllers)

RESTful APIs: Design clear and consistent RESTful endpoints.
Data Classes for DTOs: Use Kotlin data class for all DTOs. This provides equals(), hashCode(), toString(), and copy() for free and promotes immutability.
Validation: Use Java Bean Validation (JSR 380) with annotations (@Valid, @NotNull, @Size) on your DTO data classes.
Error Handling: Implement a global exception handler using @ControllerAdvice and for consistent error responses.

Service Layer

Business Logic: Encapsulate business logic within @Service classes.
Statelessness: Services should be stateless.
Transaction Management: Use @Transactional on service methods. In Kotlin, this can be applied to class or function level.

Data Layer (Repositories)

JPA Entities: Define entities as classes. Remember they must be open. It's highly recommended to use the kotlin-jpa compiler plugin to handle this automatically.
Null Safety: Leverage Kotlin's null-safety (?) to clearly define which entity fields are optional or required at the type level.
Spring Data JPA: Use Spring Data JPA repositories by extending JpaRepository or CrudRepository.
Coroutines: For reactive applications, leverage Spring Boot's support for Kotlin Coroutines in the data layer.

Logging

Companion Object Logger: The idiomatic way to declare a logger is in a companion object.

companion object {
    private val logger = LoggerFactory.getLogger(MyClass::class.java)
}

Parameterized Logging: Use parameterized messages (logger.info("Processing user {}...", userId)) for performance and clarity.

Testing

JUnit 5: JUnit 5 is the default and works seamlessly with Kotlin.
Idiomatic Testing Libraries: For more fluent and idiomatic tests, consider using Kotest for assertions and MockK for mocking. They are designed for Kotlin and offer a more expressive syntax.
Test Slices: Use test slice annotations like @WebMvcTest or @DataJpaTest to test specific parts of the application.
Testcontainers: Use Testcontainers for reliable integration tests with real databases, message brokers, etc.

Coroutines & Asynchronous Programming

suspend functions: For non-blocking asynchronous code, use suspend functions in your controllers and services. Spring Boot has excellent support for coroutines.
Structured Concurrency: Use coroutineScope or supervisorScope to manage the lifecycle of coroutines.

Weekly Installs

7.5K

Repository

github/awesome-copilot

GitHub Stars

26.9K

First Seen

Feb 25, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

codex7.4K

gemini-cli7.4K

opencode7.4K

github-copilot7.4K

cursor7.4K

kimi-cli7.4K

React 组合模式指南：Vercel 组件架构最佳实践，提升代码可维护性

102,200 周安装