如何在抽象Val实现时强制触发@StringRes资源注解的编译期校验
问题出现的核心原因
你碰到的校验失效问题,本质是注解的标记目标范围和Android Lint的资源校验规则不匹配:
- 你之前用
@get: StringRes标记抽象val,仅给val编译生成的getter方法加了资源注解,没有标记到val属性本身 - Lint做资源ID类型校验时,针对子类override的val初始化赋值语句,只会匹配属性本身关联的注解规则,不会自动关联到编译生成的getter方法上的注解
- 你之前替换成抽象函数能正常触发校验,是因为函数返回值的校验逻辑,是直接和方法上的注解绑定的,扫描返回字面量的逻辑和属性赋值的扫描逻辑是相互独立的
可直接落地的解决方案
不需要强行替换成函数,只要调整注解的标记范围,就能让val场景下的校验正常生效:
方案1:扩展注解目标,兼顾Java互操作
如果项目存在Kotlin和Java的混合开发场景,保留原有@get:StringRes标记不影响Java侧的调用体验,额外补充属性目标的注解即可,父类的抽象val写法调整为:
// 父类抽象属性定义 @get:StringRes @property:StringRes abstract val foo: Int
调整后效果:
- 原有Java侧的校验逻辑不受影响,Java代码调用该属性的getter方法时,依然能正常触发@StringRes的类型提示
- Lint可以正确关联到属性本身的@StringRes校验规则,子类实现时如果写
override val foo = 2,会立刻触发预期的静态检查错误,提示传入的硬编码值不是合法的字符串资源ID
方案2:直接在属性上标记注解
如果项目没有Java互操作的需求,可以直接去掉get目标限定,把注解直接打在val声明上:
// 父类抽象属性定义 @StringRes abstract val foo: Int
该写法的校验效果和方案1完全一致,子类的非资源ID赋值同样会被Lint正常拦截。
补充说明
这类资源ID的类型校验是Android Lint提供的静态检查,不是Kotlin编译器层面的硬拦截,和你之前用抽象函数实现的校验体验完全一致:IDE会在错误代码位置直接标红提示,只要没有手动关闭Lint检查,构建阶段就会中断不符合要求的代码流程。
内容的提问来源于stack exchange,提问作者ligi
相关产品推荐
相关产品推荐

