lex.mybatis-flex-kotlin-ksp.1.0.1.source-code.KSPEnvironment.kt Maven / Gradle / Ivy

Go to download
package com.mybatisflex.kotlin.ksp

import com.google.devtools.ksp.getClassDeclarationByName
import com.google.devtools.ksp.processing.*
import com.mybatisflex.kotlin.ksp.internal.config.flex.MybatisFlexConfiguration
import com.mybatisflex.kotlin.ksp.internal.config.ksp.KspConfiguration
import com.mybatisflex.kotlin.ksp.internal.util.TABLE_DEF
import com.mybatisflex.kotlin.ksp.internal.util.file.isFlexConfigFile
import com.mybatisflex.kotlin.ksp.internal.util.file.properties
import java.io.File

/**
 * 用于初始化KSP环境，将KSP环境中的对象赋值给全局变量，方便后续使用
 *
 * @author CloudPlayer
 */
internal fun initKspEnvironment(environment: SymbolProcessorEnvironment) {
    codeGenerator = environment.codeGenerator
    logger = environment.logger
    options = environment.options
    kotlinVersion = environment.kotlinVersion
}

lateinit var codeGenerator: CodeGenerator

lateinit var logger: KSPLogger

lateinit var options: Map

lateinit var kotlinVersion: KotlinVersion

/**
 * 初始化Flex配置文件对应的单例，使得配置文件中的配置项可以被方便地读取.
 * @param configFile Flex 配置文件，即 mybatis-flex.config.
 */
fun initFlexConfigs(configFile: File) {
    if (!configFile.isFlexConfigFile) {
        logger.warn("${configFile.absolutePath} not exist.")
        return
    }
    val properties = configFile.properties
    MybatisFlexConfiguration.configs.forEach {
        val value: String? = properties.getProperty(it.key)
        value?.let(it::initValue)
    }
}

/**
 * 初始化所有 mybatis-flex.config 配置文件。
 *
 * 此方法会遍历所有 mybatis-flex.config 文件，从根项目开始初始化直至子项目。
 *
 * @param configFiles 需要初始化的配置文件列表。
 * @author CloudPlayer
 */
fun initConfigs(configFiles: List) {
    for (i in configFiles.lastIndex downTo 0) {
        val value = configFiles[i]
        initFlexConfigs(value)
        initKspConfigs(value)
    }
}

fun initKspConfigs(configFile: File) {
    if (!configFile.isFlexConfigFile) {
        logger.warn("${configFile.absolutePath} not exist.")
        return
    }
    val properties = configFile.properties
    KspConfiguration.configs.forEach {
        val value: String? = properties.getProperty(it.key)
        value?.let(it::initValue)
    }
}

/**
 * 当配置文件中存在非法的配置项时，会打印警告信息
 *
 * @author CloudPlayer
 */
fun illegalValueWarning(key: String, value: String) {
    logger.warn(
        "Illegal value: `$value` for mybatis-flex configuration key: `$key`," +
                " please check the file `mybatis-flex.config`."
    )
}

/**
 * 检查 TableDef 的子类是否可以重写 `fun as(alias: String): QueryTable` 方法。
 *
 * 对于 flex 核心库版本高于 1.8.4 的项目，此属性返回 true，否则返回 false。
 *
 * @author CloudPlayer
 */
var isOverridable = false
    private set

/**
 * 用于初始化 [isOverridable] 属性。
 */
fun checkOverridable(resolver: Resolver) {
    val tableDef = resolver.getClassDeclarationByName(TABLE_DEF.canonicalName)!!.asStarProjectedType()
    val queryTable = resolver.getClassDeclarationByName("com.mybatisflex.core.query.QueryTable")!!.asStarProjectedType()
    isOverridable = queryTable.isAssignableFrom(tableDef)
}