接下來學(xué)習(xí)Kotlin中的注解(Annotations)和類型別名(Type aliases)法褥。
類型別名(Type aliases) 1.1版本
類型別名為現(xiàn)有類型提供替代名稱。如果類型名稱太長,您可以引入不同的較短的名稱帆吻,并使用新的名稱嫁蛇。
縮短長泛型類型:
typealias NodeSet = Set<Network.Node>
typealias FileTable<K> = MutableMap<K, MutableList<File>>
可以為功能類型提供不同的別名:
typealias MyHandler = (Int, String, Any) -> Unit
typealias Predicate<T> = (T) -> Boolean
可以為內(nèi)部和嵌套類創(chuàng)建新名稱:
class A {
inner class Inner
}
class B {
inner class Inner
}
typealias AInner = A.Inner
typealias BInner = B.Inner
Kotlin中定義的類型別名
類型別名不會(huì)引入新類型齿坷,它們相當(dāng)于相應(yīng)的底層類型,在代碼中添加了typealias Predicate <T>
并使用Predicate<Int>
時(shí)狰闪,Kotlin編譯器始終將其擴(kuò)展為(Int) -> Boolean
。
因此濒生,只要需要一般功能類型尝哆,就可以傳遞類型的變量,反之亦然:
typealias Predicate<T> = (T) -> Boolean // 這里可以看出變量的類型是函數(shù)類型甜攀,參數(shù)是`T`秋泄,返回值是`Boolean`
/*
foo方法的返回值是Boolean,因?yàn)閜的類型為Predicate<Int>规阀,而Predicate<Int>是(Int) -> Boolean恒序。
*/
fun foo(p: Predicate<Int>) = p(42)
fun main(args: Array<String>) {
val f: (Int) -> Boolean = { it > 0 }
println(foo(f)) // prints "true"
val p: Predicate<Int> = { it > 0 } // 這里的Predicate<Int>等同于(Int) -> Boolean
println(listOf(1, -2).filter(p)) // prints "[1]"
}
注解聲明(Annotation Declaration)
與Java一樣,Kotlin中也是有注解的谁撼,同樣是用annotation
關(guān)鍵字聲明:
annotation class Fancy
Kotlin同樣可以通過元注解來自定義注解歧胁,在這里介紹下元注解:
@Retention
注解
指定該注解是否存儲(chǔ)在編譯后的Class文件中,以及它在運(yùn)行時(shí)能否通過反射可見厉碟,有三個(gè)值喊巍,默認(rèn)是AnnotationRetention.RUNTIME
,分別為:
-
AnnotationRetention.SOURCE
:不存儲(chǔ)在編譯后的Class文件箍鼓。 -
AnnotationRetention.BINARY
:存儲(chǔ)在編譯后的Class文件崭参,但是反射不可見。 -
AnnotationRetention.RUNTIME
:存儲(chǔ)在編譯后的Class文件款咖,反射可見何暮。
@Target
注解
表示該注解可以用于什么地方奄喂,類型有
-
AnnotationTarget.CLASS
:類,接口或?qū)ο蠛M荩⒔忸愐舶ㄔ趦?nèi)跨新。 -
AnnotationTarget.ANNOTATION_CLASS
:只有注解類。 -
AnnotationTarget.TYPE_PARAMETER
:Generic type parameter (unsupported yet)
通用類型參數(shù)(還不支持)坏逢。 -
AnnotationTarget.PROPERTY
:屬性域帐。 -
AnnotationTarget.FIELD
:字段,包括屬性的支持字段是整。 -
AnnotationTarget.LOCAL_VARIABLE
:局部變量俯树。 -
AnnotationTarget.VALUE_PARAMETER
:函數(shù)或構(gòu)造函數(shù)的值參數(shù)。 -
AnnotationTarget.CONSTRUCTOR
:僅構(gòu)造函數(shù)(主函數(shù)或者第二函數(shù))贰盗。 -
AnnotationTarget.FUNCTION
:方法(不包括構(gòu)造函數(shù))许饿。 -
AnnotationTarget.PROPERTY_GETTER
:只有屬性的getter
。 -
AnnotationTarget.PROPERTY_SETTER
:只有屬性的setter
舵盈。 -
AnnotationTarget.TYPE
:類型使用陋率。 -
AnnotationTarget.EXPRESSION
:任何表達(dá)式。 -
AnnotationTarget.FILE
:文件秽晚。 -
AnnotationTarget.TYPEALIAS
:@SinceKotlin("1.1")
類型別名瓦糟,Kotlin1.1已可用。
@Repeatable
注解
表示允許在同一申明類型(類赴蝇,屬性菩浙,或方法)的多次使用同一個(gè)注解
@MustBeDocumented
注解
決定了注解是公共API的一部分,因此應(yīng)該包含在用于注解的元素的生成文檔注解中句伶。
實(shí)例
這里聲明一個(gè)Fancy
注解:
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION,
AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.EXPRESSION)
@Retention(AnnotationRetention.SOURCE)
@MustBeDocumented
annotation class Fancy
說明:Fancy
注解可用在類劲蜻,接口、對(duì)象考余、注解類先嬉、方法(不包括構(gòu)造函數(shù))、函數(shù)或構(gòu)造函數(shù)的值參數(shù)和任何的表達(dá)式楚堤,不存儲(chǔ)在編譯后的Class文件疫蔓,可用于生成文檔中。
使用(Usage)
@Fancy class Foo { // 用在類上
@Fancy fun baz(@Fancy foo: Int): Int { // 用在方法上身冬,用在函數(shù)的值參數(shù)上
return (@Fancy 1) // 用在任意表達(dá)式上
}
}
如果需要用到主構(gòu)造函數(shù)上衅胀,就需要添加constructor
關(guān)鍵字,并且在他之前添加注解:
class Foo @Inject constructor(dependency: MyDependency) {
// ...
}
注解屬性訪問器:
class Foo {
var x: MyDependency? = null
@Inject set
}
構(gòu)造方法(Constructors)
帶參數(shù)構(gòu)造函數(shù)的注解:
annotation class Special(val why: String)
@Special("example") class Foo {}
參數(shù)類型可以有:
- 類型對(duì)應(yīng)于Java原始類型(
Int
酥筝,Long
等) - 字符串
- 類(
Foo::class
) - 枚舉
- 其他注解
- 以上類型的數(shù)組
注解參數(shù)必須是nullable
類型滚躯,因?yàn)镴VM不支持將null作為注解屬性的值存儲(chǔ)。
如果注解被用作另一個(gè)注解的參數(shù),它的名稱不以@
字符做為前綴:
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")) // 這里的ReplaceWith注解唄用作另一個(gè)注解的參數(shù)哀九,則不需要加@符號(hào)
如果您需要將類指定為注解的參數(shù)剿配,請(qǐng)使用Kotlin類(KClass
)搅幅。
Kotlin編譯器將自動(dòng)將其轉(zhuǎn)換為Java類阅束,以便Java代碼能夠正常看到注解和參數(shù):
import kotlin.reflect.KClass
annotation class Ann(val arg1: KClass<*>, val arg2: KClass<out Any?>)
@Ann(String::class, Int::class) class MyClass
Lambda
注解也可以用在lambda表達(dá)式中茄唐。
annotation class Suspendable
val f = @Suspendable { Fiber.sleep(10) }
注解使用目標(biāo)(Annotation Use-site Targets)
當(dāng)注解屬性或主構(gòu)造函數(shù)參數(shù)時(shí)息裸,有多個(gè)Java元素是從相應(yīng)的Kotlin元素生成的,因此生成的Java字節(jié)碼中的多個(gè)注解位置沪编,要指定應(yīng)該如何精確地生成注解呼盆,使用以下語法:
class Example(@field:Ann val foo: String, // 標(biāo)注 Java 字段
@get:Ann val bar: String, // 標(biāo)注 Java getter
@param:Ann val quux: String) // 標(biāo)注 Java 構(gòu)造函數(shù)參數(shù)
可以使用相同的語法來注解整個(gè)文件,但必須放在最上面蚁廓,在包指令之前或在所有導(dǎo)入之前:
@file:JvmName("Foo")
package org.jetbrains.demo
如果有一個(gè)使用目標(biāo)(Use-site Targets)具有多個(gè)注解访圃,可以添加方括號(hào)[]
,并將所有注解放在括號(hào)中:
class Example {
@set:[Inject VisibleForTesting]
var collaborator: Collaborator
}
使用例子:
annotation class Ann()
annotation class Annn()
class Example(@field:[Ann Annn] val foo: String) {
@set:[Ann Annn]
var fsoo: String = ""
}
使用目標(biāo)(Use-site Targets)支持的有:
file
-
property
使用此目標(biāo)的注解對(duì)Java不可見 field
-
get
屬性的getter -
set
屬性的setter -
receiver
擴(kuò)展函數(shù)或?qū)傩缘慕邮掌鲄?shù) -
param
構(gòu)造函數(shù)參數(shù) -
setparam
屬性的setter的參數(shù) -
delegate
該字段存儲(chǔ)代理屬性的代理實(shí)例
其中相嵌,要注解擴(kuò)展函數(shù)的接收器參數(shù)腿时,請(qǐng)使用以下語法:
annotation class Fancy
fun @receiver:Fancy String.myExtension() { }
如果不指定使用目標(biāo)(Use-site Targets),則會(huì)根據(jù)所使用注解的@Target
注解來選擇目標(biāo)饭宾。
如果有多個(gè)適用目標(biāo)批糟,則使用以下列表中的第一個(gè)適用目標(biāo):
param
property
field
Java Annotations
Java注解與Kotlin 100%兼容:
import org.junit.Test
import org.junit.Assert.*
import org.junit.Rule
import org.junit.rules.*
class Tests {
// apply @Rule annotation to property getter
@get:Rule val tempFolder = TemporaryFolder()
@Test fun simple() {
val f = tempFolder.newFile()
assertEquals(42, getTheAnswer())
}
}
由于Java中編寫的注解的參數(shù)順序并沒有定義,因此無法使用常規(guī)函數(shù)調(diào)用語法來傳遞參數(shù)看铆,所以就需要使用命名參數(shù)語法:
// Java
public @interface Ann {
int intValue();
String stringValue();
}
在Kotlin中調(diào)用徽鼎,使用命名參數(shù):
// Kotlin
@Ann(intValue = 1, stringValue = "abc") class C
與Java一樣,默認(rèn)的參數(shù)名為value
弹惦,它的值可以被指定而沒有明確的名稱:
// Java
public @interface AnnWithValue {
String value();
}
參數(shù)名為默認(rèn)值的時(shí)候否淤,可以直接寫值:
// Kotlin
@AnnWithValue("abc") class C
如果value
的參數(shù)類型為數(shù)組類型的時(shí)候,在Kotlin中必須使用vararg
這個(gè)參數(shù)類型:
// Java
public @interface AnnWithArrayValue {
String[] value();
}
// Kotlin
@AnnWithArrayValue("abc", "foo", "bar") class C
如果參數(shù)名部位默認(rèn)值并且為數(shù)組類型的時(shí)候:
// Java
public @interface AnnWithArrayMethod {
String[] names();
}
在Kotlin中必須使用arrayOf
棠隐,并且使用命名參數(shù):
// Kotlin
@AnnWithArrayMethod(names = arrayOf("abc", "foo", "bar")) class C
Java注解的實(shí)例的值可以做為Kotlin中的屬性:
// Java
public @interface Ann {
int value();
}
// Kotlin
fun foo(ann: Ann) {
val i = ann.value
}