在 MyBatis-Plus 中,Swagger 模式和 Kotlin 模式是为了支持特定技术栈和开发需求的两种配置选项。它们分别针对 API 文档生成和 Kotlin 语言提供了更好的支持和集成。
Swagger 模式
Swagger 模式主要用于生成 API 文档。在 MyBatis-Plus 中启用 Swagger 模式后,可以利用 Swagger 的注解和工具自动生成 RESTful API 的文档,这对前后端分离开发和接口测试非常有用。
- 特点:
- 自动生成文档: 通过注解自动生成详细的 API 文档,包括请求路径、参数、返回值等信息。
- 集成方便: 结合 Spring Boot 和 Swagger Starter 可以轻松集成,使用注解如
@Api
、@ApiOperation
等标记 API。 - 可视化接口测试: 生成的文档通常会通过 Swagger UI 展示,方便进行接口的在线测试。
Kotlin 模式
Kotlin 模式是为支持 Kotlin 语言开发而设计的模式。Kotlin 作为一种现代化的编程语言,因其简洁性和安全性在 Java 生态中越来越受欢迎。MyBatis-Plus 通过 Kotlin 模式优化了对 Kotlin 特性的支持,使得开发更为便捷和高效。
- 特点:
- Kotlin 语言特性支持: 支持 Kotlin 语言的语法特点,如数据类 (
data class
)、空安全等。 - 简化开发: Kotlin 模式优化了与 Kotlin 语言的兼容性,可以更简洁地编写实体类和数据库操作代码。
- 强类型安全: Kotlin 模式能够更好地利用 Kotlin 的强类型系统,减少运行时错误。
- Kotlin 语言特性支持: 支持 Kotlin 语言的语法特点,如数据类 (
选择
- 如果你正在使用 Java 并需要自动生成 API 文档,Swagger 模式会非常有用。
- 如果你使用 Kotlin 开发 MyBatis-Plus 项目,Kotlin 模式能更好地支持 Kotlin 语言特性,使开发更加高效。
两者可以根据项目的实际需求选择开启或同时使用。
使用
这两个都是在globalConfig中配置
全局配置 (GlobalConfig)
全局配置提供了对代码生成器整体行为的设置,包括输出目录、作者信息、Kotlin 模式、Swagger 集成、时间类型策略等。
方法说明
示例配置
GlobalConfig globalConfig = new GlobalConfig.Builder().disableOpenDir(false) // 允许自动打开输出目录.outputDir("/path/to/output") // 设置输出目录.author("Your Name") // 设置作者名.enableKotlin(true) // 开启 Kotlin 模式.enableSwagger(true) // 开启 Swagger 模式.dateType(DateType.ONLY_DATE) // 设置时间类型策略.commentDate("yyyy-MM-dd") // 设置注释日期格式.build();