Kotlin 注解

2024 年 8 月 29 日 | 阅读 2 分钟

注解用于在编译时将元数据附加到类、接口、参数等等。注解可以被编译器使用，并在运行时进行反射。我们可以根据注解的值来更改数据或程序的含义。

Kotlin 元注解

我们可以在声明注解时添加元信息。以下是一些元注解：

注解名称	用途
@Target	它针对所有可能的元素类型，这些元素可以使用该注解进行注解。
@Retention	它指定注解是否存储在已编译的类文件中，或者它是否通过反射在运行时可见。
@Repeatable	此元注解确定注解是否可以在单个代码元素上应用两次或更多次。
@MustBeDocumented	此元文档指定注解是公共 API 的一部分，应包含在类或方法中。

使用注解的示例

@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION,
AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.EXPRESSION)
@Retention(AnnotationRetention.SOURCE)
@MustBeDocumented
annotation class MyClass

声明注解

通过在类前面放置 annotation 修饰符来声明注解。

注解构造函数

也可以注解类的构造函数。这可以通过为构造函数声明添加 constructor 关键字并在其之前放置注解来完成。

class MyClass@Inject constructor( dependency: MyDependency){
//. . . 
} 

注解属性访问器

class MyClass{
var a: MyDependency? = null
                    @Inject set
}

使用构造函数作为注解

我们也可以使用构造函数作为注解。使用构造函数作为注解需要参数。

annotation class MyClass(val why: String)
@MyClass("parameter") class Foo{
}

用作注解的参数不能是可空类型。这是因为 JVM 不支持 null 作为注解属性的值。

我们还可以使用一个注解作为另一个注解的参数，在这种情况下，它不能带有前缀 @ 字符。例如：

annotation class ReplaceWith(val expression: String)
annotation class Deprecated(
val message: String,
val replaceWith: ReplaceWith = ReplaceWith(""))
@Deprecated("This function is deprecated, use === instead", ReplaceWith("this === other"))

Kotlin 还指定一个类可以通过使用 KClass 来获取注解的参数。 Kotlin 编译器自动将其转换为 java 类，这导致正常查看注解和参数。

import kotlin.reflect.KClass
annotation class MyClass(val arg1: KClass<*>, val arg2: KClass<out Any>)
@MyClass(String::class, Int::class) class Foo

使用 TYPE 注解的示例

创建 java 注解接口 Ann.java

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface  Ann{
int value();
}

创建一个使用注解接口 Ann 的 MyClass.kt 类。

@Ann(value = 10)
class MyClass{

}
fun main (args: Array<String>){
var c = MyClass()
var x = c.javaClass.getAnnotation(Ann::class.java)
    if(x!=null){
println("Value:"+x?.value)
    }
}

输出