注解

注解是将元数据附加到代码的一种手段。要声明一个注解，在类前面加上 annotation 修饰符：

annotation class Fancy

可以通过给注解类添加元注解来指定注解的附加属性：

@Target 指定哪些元素种类可以用该注解（例如类、函数、属性和表达式）；
@Retention 可以指定注解信息是否保存到已编译的类文件中，以及是否在运行时通过反射可见（默认情况下，这两个属性都是 true）；
@Repeatable 允许在单个元素上多次使用相同的注解；
@MustBeDocumented 指定注解是公共 API 的一部分，并应包含在生成的 API 文档中显示的类或方法签名中。

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

用法

@Fancy class Foo {
    @Fancy fun baz(@Fancy foo: Int): Int {
        return (@Fancy 1)
    }
}

如果需要为一个类的主构造函数添加注解，需在构造函数声明中使用 constructor 关键字，并在其前面添加注解：

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

你还可以给属性访问器添加注解：

class Foo {
    var x: MyDependency? = null
        @Inject set
}

构造函数

注解可以有带参数的构造函数。

annotation class Special(val why: String)

@Special("example") class Foo {}

允许的参数类型有：

对应于 Java 基本类型的类型（例如 Int, Long 等）
字符串
类（Foo::class）
枚举
其他注解
上述类型的数组

注解参数不能有可空类型，因为 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 类，以便 Java 代码可以正常访问这些注解和参数。

import kotlin.reflect.KClass

annotation class Ann(val arg1: KClass<*>, val arg2: KClass<out Any>)

@Ann(String::class, Int::class) class MyClass

实例化

在 Java 中，注解类型是一种接口形式，因此你可以实现它并使用一个实例。作为这种机制的替代，Kotlin 允许你在任意代码中调用注解类的构造函数，并类似地使用生成的实例。

annotation class InfoMarker(val info: String)

fun processInfo(marker: InfoMarker): Unit = TODO()

fun main(args: Array<String>) {
    if (args.isNotEmpty())
        processInfo(getAnnotationReflective(args))
    else
        processInfo(InfoMarker("default"))
}

在这个 KEEP 中了解更多关于注解类实例化的信息。

Lambdas

注解也可以用于 lambdas。它们将被应用到 lambda 的 invoke() 方法中，lambda 的主体会被生成到这个方法中。这对于像 Quasar 这样的框架很有用，Quasar 使用注解进行并发控制。

annotation class Suspendable

val f = @Suspendable { Fiber.sleep(10) }

注解使用位置目标

当你注解一个属性或主构造函数参数时，会从相应的 Kotlin 元素生成多个 Java 元素，因此在生成的 Java 字节码中注解有多个可能的位置。要具体指定注解应如何生成，请使用以下语法：

class Example(@field:Ann val foo,    // 注释 Java 字段
              @get:Ann val bar,      // 注释 Java getter
              @param:Ann val quux)   // 注释 Java 构造函数参数

同样的语法也可以用于注解整个文件。为此，请在文件的顶层添加一个目标为 file 的注解，放在 package 声明之前，或者如果文件位于默认包中，则放在所有 import 声明之前：

@file:JvmName("Foo")

package org.jetbrains.demo

如果你有多个具有相同目标的注解，可以通过在目标后添加方括号，并将所有注解放在方括号内来避免重复目标：

class Example {
     @set:[Inject VisibleForTesting]
     var collaborator: Collaborator
}

支持使用注解的位置目标的完整列表如下：

file
property （具有此目标的注解对 Java 不可见）
field
get （属性 getter）
set （属性 setter）
receiver （扩展函数或属性的接收者参数）
param （构造函数参数）
setparam （属性 setter 参数）
delegate （存储委托实例的字段，用于委托属性）

要注释扩展函数的接收者参数，请使用以下语法：

fun @receiver:Fancy String.myExtension() { ... }

如果未指定使用位置目标，系统会根据这个注解的 @Target 注解自动选择目标。如果有多个适用目标，将优先选择以下列表中的第一个作为适用目标：

param
property
field

Java 注解

Java 注解与 Kotlin 100% 兼容：

import org.junit.Test
import org.junit.Assert.*
import org.junit.Rule
import org.junit.rules.*

class Tests {
    // 应用 @Rule 注解到属性 getter
    @get:Rule val tempFolder = TemporaryFolder()

    @Test fun simple() {
        val f = tempFolder.newFile()
        assertEquals(42, getTheAnswer())
    }
}

由于用 Java 编写的注解的参数顺序未定义，因此你不能使用常规函数调用语法来传递参数。相反，你需要使用具名参数语法：

// Java
public @interface Ann {
    int intValue();
    String stringValue();
}

// Kotlin
@Ann(intValue = 1, stringValue = "abc") class C

就像在 Java 中一样，特殊情况是 value 参数；其值可以在没有显式名称的情况下指定：

// Java
public @interface AnnWithValue {
    String value();
}

// Kotlin
@AnnWithValue("abc") class C

数组作为注解参数

如果 Java 中 value 参数是数组类型，那么它在 Kotlin 中变成了 vararg 参数：

// Java
public @interface AnnWithArrayValue {
    String[] value();
}

// Kotlin
@AnnWithArrayValue("abc", "foo", "bar") class C

对于其他数组类型的参数，你需要使用数组字面量语法或 arrayOf(...)：

// Java
public @interface AnnWithArrayMethod {
    String[] names();
}

@AnnWithArrayMethod(names = ["abc", "foo", "bar"]) 
class C

访问注解实例的属性

注解实例的值在 Kotlin 代码中作为属性暴露：

// Java
public @interface Ann {
    int value();
}

// Kotlin
fun foo(ann: Ann) {
    val i = ann.value
}

禁止生成 JVM 1.8+ 注解目标的能力

如果一个 Kotlin 注解在其 Kotlin 目标中包含 TYPE ，则该注解在其 Java 注解目标列表中映射到 java.lang.annotation.ElementType.TYPE_USE。这就像 Kotlin 目标 TYPE_PARAMETER映射到 Java 目标 java.lang.annotation.ElementType.TYPE_PARAMETER 一样。这对于 API 级别低于 26 的 Android 客户端来说是一个问题，因为这些目标在 API 中不存在。

为了避免生成 TYPE_USE 和 TYPE_PARAMETER 注解目标，请使用新的编译器参数 -Xno-new-java-annotation-targets。

可重复注解

就像在 Java 中一样，Kotlin 也支持可重复注解，可以多次应用于单个代码元素。要使你的注解可重复，请使用 @kotlin.annotation.Repeatable 元注解标记其声明。这将使其在 Kotlin 和 Java 中都可重复。Java 可重复注解在 Kotlin 端也得到了支持。

与 Java 使用的方案的主要区别是没有容器注解（containing annotation），Kotlin 编译器会自动生成一个预定义名称的容器注解。对于下面的示例中的注解，编译器会生成容器注解 @Tag.Container：

@Repeatable
annotation class Tag(val name: String)

// 编译器生成 @Tag.Container 包含注解

你可以通过应用 @kotlin.jvm.JvmRepeatable 元注解，并将显式声明的容器注解类作为参数传递，用来自定义容器注解的名称：

@JvmRepeatable(Tags::class)
annotation class Tag(val name: String)

annotation class Tags(val value: Array<Tag>)

要通过反射提取 Kotlin 或 Java 可重复注解，请使用 KAnnotatedElement.findAnnotations() 函数。

在这个 KEEP 中了解更多关于 Kotlin 可重复注解的信息。

Last modified: 08 九月 2024