Java 注解總結(jié)
注解的作用
注解是是一類用于描述代碼信息的的原數(shù)據(jù)嘴拢，注解本身并非其注釋的代碼的一部分存皂。它主要的作用在于：
- 向編譯器提供信息以檢查編譯錯誤
- 提供編譯&部署期間處理時所需要信息旱眯，編譯/部署軟件可以通過處理注解生成代碼软族，XML文件等
- 提供運(yùn)行時信息床牧，部分注解可以保留到運(yùn)行時形成部分代碼邏輯
JDK中的常用注解
JDK中內(nèi)置的常用注解有如下幾類：
- @Override
- @SuppressWarnings
- @Deprecated
使用方法分別如下：
@Override
@Override 用于標(biāo)記一個方法重寫了父類的一個方法，如果一個方法添加了@Override注解侄榴，編譯器會檢查該方法父類是否存在可以被重寫的同名方法雹锣，如果沒有則提示編譯錯誤，例如：
package com.annotation.test;
public class TestAnnotation {
public static void main(String[] args) {
Human woman = new Woman();
woman.dressSomething();
}
static class Human {
protected void dressSomething() {
System.out.println("Human dress chloth");
}
}
static class Woman extends Human {
public void dresssomething() {
System.out.println("Woman dress skirt ");
}
}
}
編譯Woman類是不小心將some達(dá)成了小寫癞蚕，因此成語錯誤的輸出了：
Human dress chloth
如果在為Woman類dressomething方法增加@Override注解:
static class Woman extends Human {
@Override
public void dresssomething() {
System.out.println("Woman dress skirt ");
}
}
那么在編譯器期間就會提示如下錯誤蕊爵，從而避免在運(yùn)行時出錯：
The method dressomething() of type TestAnnotation.Woman must override or implement a supertype method
@Deprecated
@Depreacated注解用于聲明方法,成員，構(gòu)造函數(shù)等內(nèi)容已經(jīng)被廢棄桦山，編譯器如果發(fā)現(xiàn)代碼使用了被@Deprecated注解的內(nèi)容會在編譯期間提出警告攒射。例如如下代碼：
public class TestAnnotation {
public static void main(String[] args) {
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
}
});
thread.start();
thread.destroy();
}
}
編譯時提示如下警告：
javac TestAnnotation.java
注: TestAnnotation.java使用或覆蓋了已過時的 API。
注: 有關(guān)詳細(xì)信息, 請使用 -Xlint:deprecation 重新編譯恒水。
@SupressWarning
@SupressWarning可以用于注解類会放，方法，參數(shù)寇窑，構(gòu)造函數(shù)等內(nèi)容鸦概。被@SupressWarning注解的內(nèi)容在編譯期間不會提示警告，錄入在前一個例子中的main方法增加甩骏，編譯結(jié)果無任何警告。
@SuppressWarnings("deprecation")
public static void main(String[] args) {
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
}
});
thread.start();
thread.destroy();
}
自定義注解
自定義注解的語法非常簡單先慷，如下：
@interface AnootationName{}
元注解
在學(xué)習(xí)自定義注解之前首先來了解幾個用于修飾自定義注解的注解饮笛，這幾個注解用于標(biāo)注注解的基本行為。
@Target
@Target 用于標(biāo)注所定義的注解可以作用于哪些內(nèi)容论熙，他的取值可以是java.lang.annotation.ElementType中的一種福青，具體如下：
| 枚舉值 | 作用域 |
|---|---|
| TYPE | class，interface，enum |
| FIELD | fields |
| METHOD | method |
| CONSTRUCTOR | constructors |
| LOCAL_VARIABLE | local variables |
| ANNOTATION_TYPE | annotation |
| PARAMETER | parameter |
@Retention
@Retention 用于說明注解可以保留到哪些階段无午，起取值和含義如下：
| 值 | 作用 |
|---|---|
| RetentionPolicy.SOURCE | 在編譯期間被丟掉媒役，在class文件中不存在 |
| RetentionPolicy.CLASS | 會編譯到class文件中，編譯器可以讀取宪迟，但是運(yùn)行時無法讀取到 |
| RetentionPolicy.RUNTIME | 會表一到class文件中酣衷，運(yùn)行時也可以通過反射讀取 |
@Inherited
@Inherited 用于標(biāo)注一個注解可以被子類繼承，例如：
@Inherited
@interface MyAnnotation{}
@MyAnnotation
class superclas {
}
class Subclass extends Superclass{}
Subclass也被@MyAnnotation標(biāo)注次泽。
自定義注解語法
標(biāo)記注解
標(biāo)記注解中沒有任何Field穿仪，定義和使用方法如下：
@interface MyAnnotation{}
@MyAnnotation
class superclas {
}
單值注解
單值注解是指，注解中進(jìn)含有一個Field意荤，定義及使用方法如下：
@Target(ElementType.METHOD)
@interface SingleValueAnnotation{
String description() default "default";
}
@SingleValueAnnotation
String getDescription() {
return "null";
}
@SingleValueAnnotation(description = "WOW")
String getDescptionAlt() {
return "invalid";
}
多值注解
多至注解是指啊片，注解中包含一個以上的Field，定義和使用如下:
@Target(ElementType.METHOD)
@interface MultiValueAnnotation {
String description() default "dafault";
int seed();
Class<?> myClass();
}
@MultiValueAnnotation(seed = 0, myClass = TestAnnotation.class)
void printValues() {
}
多值注解和單值注解有下面幾個地方需要注意：
- 自定義注解中的Field的類型只能是玖像，原始類型紫谷，String，枚舉捐寥，class笤昨，注解
- 自定義注解中的Field的默認(rèn)值可以通過 default 關(guān)鍵字制定
- 使用自定義注解時，必須對沒有默認(rèn)值的Field賦值
示例
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
public class TestAnnotation {
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@interface MarkerAnnotation {
}
@Target(ElementType.CONSTRUCTOR)
@interface OneValueAnnotation {
String descrpiton() default "Hellow World";
}
@Target({
ElementType.METHOD, ElementType.FIELD
})
@Retention(RetentionPolicy.RUNTIME)
@interface MultiValuieAnnotation {
String description();
int seed() default 2018;
}
@MarkerAnnotation
static class Human {
@MultiValuieAnnotation(description = "mName", seed = 2017)
String mName;
@OneValueAnnotation
public Human() {
mName = "human";
}
@MultiValuieAnnotation(description = "eat")
public void eat() {
System.out.println("Humant eat");
}
}
static class Woman extends Human {
@Override
public void eat() {
System.out.println("Woman eat");
}
}
public static void main(String[] args) {
MarkerAnnotation humanMarkerAnnotation = Human.class.getAnnotation(MarkerAnnotation.class);
System.out.println("humanMarkerAnnotation: " + humanMarkerAnnotation);
MarkerAnnotation womanMarkerAnnotation = Woman.class.getAnnotation(MarkerAnnotation.class);
System.out.println("womanMarkerAnnotation:" + womanMarkerAnnotation);
try {
OneValueAnnotation humanConstructorAnnotation = Human.class.getConstructor()
.getAnnotation(OneValueAnnotation.class);
System.out
.println("humanConstructorAnnotation:" + humanConstructorAnnotation);
MultiValuieAnnotation humanFieldAnnotation = Human.class.getDeclaredField("mName")
.getAnnotation(MultiValuieAnnotation.class);
System.out.println("humanFieldAnnotation:" + humanFieldAnnotation);
MultiValuieAnnotation humantMethodAnnotation = Human.class.getMethod("eat")
.getAnnotation(MultiValuieAnnotation.class);
System.out.println("humantMethodAnnotation:" + humantMethodAnnotation);
} catch (NoSuchMethodException | SecurityException | NoSuchFieldException e) {
e.printStackTrace();
}
}
}
輸出結(jié)果如下：
humanMarkerAnnotation: @com.annotation.test.TestAnnotation$MarkerAnnotation()
womanMarkerAnnotation:@com.annotation.test.TestAnnotation$MarkerAnnotation()
humanConstructorAnnotation:null
humanFieldAnnotation:@com.annotation.test.TestAnnotation$MultiValuieAnnotation(seed=2017, description=mName)
humantMethodAnnotation:@com.annotation.test.TestAnnotation$MultiValuieAnnotation(seed=2018, description=eat)
總結(jié)：
- @Retention 為RUNTIME的注解可以在運(yùn)行時通過反射讀取
- 注解沒有Modifier上真，主要獲取到了Field咬腋，class，constructor等內(nèi)容睡互，即可讀取注解
實(shí)際應(yīng)用AndroidEventHub
To Be Continue...
