Java 注解总结
注解的作用
注解是是一类用于描述代码信息的的原数据，注解本身并非其注释的代码的一部分。它主要的作用在于：
- 向编译器提供信息以检查编译错误
- 提供编译&部署期间处理时所需要信息，编译/部署软件可以通过处理注解生成代码，XML文件等
- 提供运行时信息，部分注解可以保留到运行时形成部分代码逻辑
JDK中的常用注解
JDK中内置的常用注解有如下几类：
- @Override
- @SuppressWarnings
- @Deprecated
使用方法分别如下：
@Override
@Override 用于标记一个方法重写了父类的一个方法，如果一个方法添加了@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达成了小写，因此成语错误的输出了：
Human dress chloth
如果在为Woman类dressomething方法增加@Override注解:
static class Woman extends Human {
@Override
public void dresssomething() {
System.out.println("Woman dress skirt ");
}
}
那么在编译器期间就会提示如下错误，从而避免在运行时出错：
The method dressomething() of type TestAnnotation.Woman must override or implement a supertype method
@Deprecated
@Depreacated注解用于声明方法,成员，构造函数等内容已经被废弃，编译器如果发现代码使用了被@Deprecated注解的内容会在编译期间提出警告。例如如下代码：
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。
注: 有关详细信息, 请使用 -Xlint:deprecation 重新编译。
@SupressWarning
@SupressWarning可以用于注解类，方法，参数，构造函数等内容。被@SupressWarning注解的内容在编译期间不会提示警告，录入在前一个例子中的main方法增加，编译结果无任何警告。
@SuppressWarnings("deprecation")
public static void main(String[] args) {
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
}
});
thread.start();
thread.destroy();
}
自定义注解
自定义注解的语法非常简单，如下：
@interface AnootationName{}
元注解
在学习自定义注解之前首先来了解几个用于修饰自定义注解的注解，这几个注解用于标注注解的基本行为。
@Target
@Target 用于标注所定义的注解可以作用于哪些内容，他的取值可以是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文件中，编译器可以读取，但是运行时无法读取到 |
| RetentionPolicy.RUNTIME | 会表一到class文件中，运行时也可以通过反射读取 |
@Inherited
@Inherited 用于标注一个注解可以被子类继承，例如：
@Inherited
@interface MyAnnotation{}
@MyAnnotation
class superclas {
}
class Subclass extends Superclass{}
Subclass也被@MyAnnotation标注。
自定义注解语法
标记注解
标记注解中没有任何Field，定义和使用方法如下：
@interface MyAnnotation{}
@MyAnnotation
class superclas {
}
单值注解
单值注解是指，注解中进含有一个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的默认值可以通过 default 关键字制定
- 使用自定义注解时，必须对没有默认值的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();
}
}
}
输出结果如下：
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)
总结：
- @Retention 为RUNTIME的注解可以在运行时通过反射读取
- 注解没有Modifier，主要获取到了Field，class，constructor等内容，即可读取注解
实际应用AndroidEventHub
To Be Continue...
参考文档
Java Annotation
Java Custom Annotation