检查kotlinx-serialization-json的bean类是否都加了@Serializable注解

前言

json解析框架有很多,但Kotlin跨平台只能使用kotlinx-serialization-json

而kotlinx-serialization-json使用的时候需要给bean类加上注解,不然运行时会报错,如下:

@Serializable
class HelpBean(
    val key: String,
    val value: String,
)

而官方没有提供检查是否bean类都加注解,或者一键给某个包自动加注解的功能,导致可能会出现运行时的崩溃,所以我们可以自己用ksp写个程序来检查一下

正文

ksp基础使用可以参考:使用KSP处理注解和生成Kotlin代码

我们可以在SymbolProcessor的子类的process方法中这样写:

//获取所有文件的列表
resolver.getAllFiles().filter {
    //过滤只有符合自己要检查的包名的类才去检查是否加了@Serializable注解
    it.packageName.asString() == packageName
}.map {
    //拿到文件中所有的类
    it.declarations.mapNotNull {
        //过滤是Class类型的
        it as? KSClassDeclaration
    }.filter {
        //过滤是Class类型的
        it.classKind == ClassKind.CLASS
    }
}.flatten()
    .forEach {
        //遍历上面拿到的所有符合条件的类,然后获取类上的@Serializable注解
        if (it.getAnnotationsByType(Serializable::class).toList().isEmpty()) {
            //如果没有则打印error日志,如果打印了error日志,则会自动在gradle build过程中报错
            environment.logger.error(
                "class: $it Serializable annotation not added",
                it//将文件位置打印出来
            )
        }
    }
//如果没有报错则说明指定的包中所有类都加了注解了

end,代码注释都很清楚

对Kotlin或KMP感兴趣的同学可以进Q群 101786950

如果这篇文章对您有帮助的话

可以扫码请我喝瓶饮料或咖啡(如果对什么比较感兴趣可以在备注里写出来)