Java笔记九——注解（Annotation）使用注解定义注解

74 阅读 0 评论 49 点赞

我是靠谱客的博主满意裙子，最近开发中收集的这篇文章主要介绍Java笔记九——注解（Annotation）使用注解定义注解，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

使用注解

注解是一种作用标注的特殊“元数据”，可以被编译器打包进入class文件，可以在编译、类加载、运行阶段被读取，并做相应处理。

注解的分类

编译器使用的注解
例如@Override:让编译器检查该方法是否正确实现了重写。（看看你方法名打错没、参数列表正确与否啊，贴心小棉袄）。
@SuppressWarnings:抑制编译器发生警告
这类注解不会被编译进.class文件
工具处理.class文件使用的注解
工具加载类的时候做一些动态修改，会被编译进入.class文件，加载结束后注解不会存在于内存中，底层库使用，不用自己处理。
程序运行期能够读取的注解
加载后就一直存在于JVM中，。例如，一个配置了@PostConstruct的方法会在调用构造方法后自动被调用（这是Java代码读取该注解实现的功能，JVM并不会识别该注解）。

基本Annotation

java.lang包下存在着5个基本的Annotation

@Override——重写注解
检查实现父类方法时一些拼写错误，是否正确实现父类方法
@Deprecated——过时注解
为了兼容老版本java程序，把某些方法设置为过时。
Date对象中的toLocalString()就被设置成过时了


@Deprecated
public String toLocaleString() {
DateFormat formatter = DateFormat.getDateTimeInstance();
return formatter.format(this);
}

如果程序调用这个方法，IDE就会出现一条横杠，说明该方法过时。

@SuppressWarnings——抑制编译器警告注解
@SafeVarargs ——Java 7“堆污染”抑制警告
堆污染：不是泛型的集合赋值给带泛型的集合的时候，容易发生堆污染。用得少
@FunctionalInterface——指定该接口时函数式接口

定义注解

使用@interface语法来定义注解，格式如下：

public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

注解的参数类似无参数方法，可以用default设定一个默认值（强烈推荐）。最常用的参数应当命名为value。

定义一个注解时，还可以定义配置参数。配置参数可以包括：
所有基本类型；

String；
枚举类型；
基本类型、String、Class以及枚举的数组。
配置参数必须是常量

元注解

元注解可以修饰其他注解

@Target
使用@Target可以定义Annotation能够被应用于源码的哪些位置：
类或接口：ElementType.TYPE；
字段：ElementType.FIELD；
方法：ElementType.METHOD；
构造方法：ElementType.CONSTRUCTOR；
方法参数：ElementType.PARAMETER。
例如，定义注解@Report可用在方法上，我们必须添加一个@Target(ElementType.METHOD)：

@Target(ElementType.METHOD)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

实际上@Target定义的value是ElementType[]数组，只有一个元素时，可以省略数组的写法。

Retention——定义了Annotation的生命周期
仅编译期：RetentionPolicy.SOURCE；
仅class文件：RetentionPolicy.CLASS；
运行期：RetentionPolicy.RUNTIME。
如果@Retention不存在，则该Annotation默认为CLASS。因为通常我们自定义的Annotation都是RUNTIME，所以，务必要加上@Retention(RetentionPolicy.RUNTIME)这个元注解：

@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

Repeatable——定义Annotation是否可重复（用得不多）
Inherited
使用@Inherited定义子类是否可继承父类定义的Annotation。@Inherited仅针对@Target(ElementType.TYPE)类型的annotation有效，并且仅针对class的继承，对interface的继承无效：

@Inherited
@Target(ElementType.TYPE)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

在使用的时候，如果一个类用到了@Report,则它的子类默认也定义了该注解：

自定义Annotation

1、用@interface定义注解
2、添加参数、默认值
把最常用得参数定义为value()
3、用元注解配置注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

必须设置@Target和@Retention，@Retention一般设置为RUNTIME，因为我们自定义的注解通常要求在运行期读取。一般情况下，不必写@Inherited和@Repeatable。

处理注解

使用反射API读取Annotation的方法包括：

判断某个注解是否存在于Class、Field、Method或Constructor：

Class.isAnnotationPresent(Class)
Field.isAnnotationPresent(Class)
Method.isAnnotationPresent(Class)
Constructor.isAnnotationPresent(Class)

判断@Report是否存在于Person类：Person.class.isAnnotationPresent(Report.class);
2. 使用反射API读取Annotation：

Class.getAnnotation(Class)
Field.getAnnotation(Class)
Method.getAnnotation(Class)
Constructor.getAnnotation(Class)

例如：

// 获取Person定义的@Report注解:
Report report = Person.class.getAnnotation(Report.class);
int type = report.type();
String level = report.level();

使用反射API读取Annotation有两种方法。方法一是先判断Annotation是否存在，如果存在，就直接读取：

Class cls = Person.class;
if (cls.isAnnotationPresent(Report.class)) {
Report report = cls.getAnnotation(Report.class);
...
}

第二种方法是直接读取Annotation，如果Annotation不存在，将返回null：

Class cls = Person.class;
Report report = cls.getAnnotation(Report.class);
if (report != null) {
...
}

使用注解

注解如何使用，完全由程序自己决定。例如，JUnit是一个测试框架，它会自动运行所有标记为@Test的方法。

例子：@Range注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {
int min() default 0;
int max() default 255;
}

使用@Range注解：

public class Person {
@Range(min=1, max=20)
public String name;
@Range(max=10)
public String city;
}

编写Person实例中String字段长度是否满足@Range的定义的检查方法：

void check(Person person) throws IllegalArgumentException, ReflectiveOperationException {
// 遍历所有Field:
for (Field field : person.getClass().getFields()) {
// 获取Field定义的@Range:
Range range = field.getAnnotation(Range.class);
// 如果@Range存在:
if (range != null) {
// 获取Field的值:
Object value = field.get(person);
// 如果值是String:
if (value instanceof String) {
String s = (String) value;
// 判断值是否满足@Range的min/max:
if (s.length() < range.min() || s.length() > range.max()) {
throw new IllegalArgumentException("Invalid field: " + field.getName());
}
}
}
}
}