01、注解是什么
注解(Annotation)是在 Java 1.5 时引入的概念,同 class 和 interface 一样,也属于一种类型。注解提供了一系列数据用来装饰程序代码(类、方法、字段等),但是注解并不是所装饰代码的一部分,它对代码的运行效果没有直接影响(这句话怎么理解呢?),由编译器决定该执行哪些操作。
来看一段代码,我随便写的,除了打印到控制台的那句宣传语,其他都不重要,嘻嘻。
public class AutowiredTest {
@Autowired
private String name;
public static void main(String[] args) {
System.out.println("沉默王二,一枚有趣的程序员");
}
}
注意到 @Autowired
这个注解了吧?它本来是为 Spring 容器注入 Bean 的,现在被我无情地扔在了成员变量 name 的身上,但这段代码所在的项目中并没有启用 Spring,意味着 @Autowired
注解此时只是一个摆设。
我之所以举这个无聊的例子就是为了证明一个观点:注解对代码的运行效果没有直接影响,明白我的用意了吧?
02、注解的生命周期
注解的生命周期有 3 种策略,定义在 RetentionPolicy 枚举中。
1)SOURCE:在源文件中有效,被编译器丢弃。
2)CLASS:在编译器生成的字节码文件中有效,但在运行时会被处理类文件的 JVM 丢弃。
3)RUNTIME:在运行时有效。这也是注解生命周期中最常用的一种策略,它允许程序通过反射的方式访问注解,并根据注解的定义执行相应的代码。
03、注解装饰的目标
注解的目标定义了注解将适用于哪一种级别的 Java 代码上,有些注解只适用于方法,有些只适用于成员变量,有些只适用于类,有些则都适用。
截止到 Java 9,注解的类型一共有 11 种,定义在 ElementType 枚举中。
1)TYPE:用于类、接口、注解、枚举
2)FIELD:用于字段(类的成员变量),或者枚举常量
3)METHOD:用于方法
4)PARAMETER:用于普通方法或者构造方法的参数
5)CONSTRUCTOR:用于构造方法
6)LOCAL_VARIABLE:用于变量
7)ANNOTATION_TYPE:用于注解
8)PACKAGE:用于包
9)TYPE_PARAMETER:用于泛型参数
10)TYPE_USE:用于声明语句、泛型或者强制转换语句中的类型
11)MODULE:用于模块
04、开始撸注解
说再多,都不如撸个注解来得让人心动。撸个什么样的注解呢?一个字段注解吧,它用来标记对象在序列化成 JSON 的时候要不要包含这个字段。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface JsonField {
public String value() default "";
}
1)JsonField 注解的生命周期是 RUNTIME,也就是运行时有效。
2)JsonField 注解装饰的目标是 FIELD,也就是针对字段的。
3)创建注解需要用到 @interface
关键字。
4)JsonField 注解有一个参数,名字为 value,类型为 String,默认值为一个空字符串。
为什么参数名要为 value 呢?有什么特殊的含义吗?
当然是有的,value 允许注解的使用者提供一个无需指定名字的参数。举个例子,我们可以在一个字段上使用 @JsonField(value = "沉默王二")
,也可以把 value =
省略,变成 @JsonField("沉默王二")
。
那 default ""
有什么特殊含义吗?
当然也是有的,它允许我们在一个字段上直接使用 @JsonField
,而无需指定参数的名和值。