mirror of
https://gitee.com/mybatis-flex/mybatis-flex.git
synced 2025-12-07 17:18:24 +08:00
d22176dbb4
原文档写的 kapt 版本为 1.9.2，会导致依赖无法被找到，实际上 kapt 的版本应该是 1.9.20。并且添加了与 SpringBoot 连用容易产生的问题 Signed-off-by: 林钟一六 <1477007136@qq.com>
112 lines
3.0 KiB
Markdown
112 lines
3.0 KiB
Markdown
# 在 Kotlin 中使用注解处理器
|
||
|
||
> 在 Kotlin 中想要使 `@Table` 等注解生效十分简单。只需要使用 KAPT 即可。
|
||
> 如果您正在使用 SpringBoot + Kotlin 的开发方式，请将 kapt 的版本保持与 kotlin("jvm") / kotlin("plugin.spring") 一致
|
||
|
||
## 在 Gradle 中使用
|
||
|
||
1、应用 Gradle 插件：`kotlin-kapt`
|
||
|
||
**【Kotlin】**
|
||
|
||
```kotlin
|
||
plugins {
|
||
// 如果正在使用 SpringBoot，请保持 kapt 插件版本与 Spring 插件、kotlin JVM 插件一致
|
||
// 如你的插件版本是（如果项目是使用 Spring Initializr 生成的话，是会自带下面两个插件）：
|
||
// kotlin("jvm") version "1.9.20" <- 注意版本
|
||
// kotlin("plugin.spring") version "1.9.20" <- 注意版本
|
||
// 那么你的 kapt 版本也需要与其一致，否则将会改变项目使用的 Kotlin 版本，可能会引发兼容性问题
|
||
kotlin("kapt") version "1.9.20"
|
||
}
|
||
```
|
||
|
||
**【Groovy】**
|
||
|
||
```groovy
|
||
plugins {
|
||
id 'org.jetbrains.kotlin.kapt' version '1.9.20'
|
||
}
|
||
```
|
||
|
||
2、在 dependencies 块中使用 kapt 配置添加相应的依赖项
|
||
|
||
**【Kotlin】**
|
||
|
||
```kotlin
|
||
dependencies {
|
||
kapt("com.mybatis-flex:mybatis-flex-processor:1.5.6")
|
||
}
|
||
```
|
||
|
||
**【Groovy】**
|
||
|
||
```groovy
|
||
dependencies {
|
||
kapt 'com.mybatis-flex:mybatis-flex-processor:1.5.6'
|
||
}
|
||
```
|
||
|
||
## 在 Maven 中使用
|
||
|
||
1、 将以下kapt配置插入指定位置。
|
||
|
||
```xml
|
||
<execution>
|
||
<id>kapt</id>
|
||
<goals>
|
||
<goal>kapt</goal>
|
||
</goals>
|
||
<configuration>
|
||
<annotationProcessorPaths>
|
||
<path>
|
||
<groupId>com.mybatis-flex</groupId>
|
||
<artifactId>mybatis-flex-processor</artifactId>
|
||
<version>1.5.6</version>
|
||
</path>
|
||
</annotationProcessorPaths>
|
||
</configuration>
|
||
</execution>
|
||
```
|
||
|
||
你需要使 KAPT 在 compile 前工作，将其插入到 `kotlin-maven-plugin` 中的 compile 前，然后将 compile 的时机改为 `process-sources`
|
||
|
||
```xml
|
||
<plugin>
|
||
<groupId>org.jetbrains.kotlin</groupId>
|
||
<artifactId>kotlin-maven-plugin</artifactId>
|
||
<version>${kotlin.version}</version>
|
||
<executions>
|
||
<!--上述代码需插入到此处，compile前-->
|
||
<execution>
|
||
<id>compile</id>
|
||
<!--将此处的phase改为process-sources-->
|
||
<phase>process-sources</phase>
|
||
<goals>
|
||
<goal>compile</goal>
|
||
</goals>
|
||
</execution>
|
||
<execution>
|
||
<id>test-compile</id>
|
||
<phase>test-compile</phase>
|
||
<goals>
|
||
<goal>test-compile</goal>
|
||
</goals>
|
||
</execution>
|
||
</executions>
|
||
</plugin>
|
||
```
|
||
|
||
2、 令 KAPT 在构建前运行
|
||
|
||
以 IDEA 举例：
|
||
|
||
1. 点击 Maven 图标
|
||
2. 找到对应项目
|
||
3. 点击插件
|
||
4. 点击 kotlin
|
||
5. 右击 kotlin:kapt，在选项中点击“**构建前执行**”，以让 KAPT 能够正确的生成代码。
|
||
|
||
|
||
|
||
> 关于 KAPT 更详细的说明，请看[Kotlin官网说明](https://book.kotlincn.net/text/kapt.html)，或[Kotlin语言中文站](https://www.kotlincn.net/docs/reference/kapt.html)。
|