注解,我们在代码里经常在用,但是你知道注解的原理吗?如果让你手写一个你会写吗?
今天,小祥来给大家讲下关于注解的知识
1.什么是注解
注解,英文名叫Annotation,是Java5开始引入的新特征。它提供了一种安全的类似注释的机制,
用来将任何的信息或元数据(metadata)与程序元素(类、方法、成员变量等)进行关联。
为程序的元素(类、方法、成员变量)加上更直观更明了的说明,这些说明信息是与程序的业务逻辑无关,
并且供指定的工具或框架使用。Annotation像一种修饰符一样,
应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。
Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。JDK自己也是有很多内置注解的,比如@override。
2. 注解的原理
注解本质是一个继承了Annotation 的特殊接口,其具体实现类是Java 运行时生成的动态代理类。而我们通过反射获取注解时,返回的是Java 运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解(接口)的方法,会最终调用AnnotationInvocationHandler 的invoke 方法。该方法会从memberValues 这个Map 中索引出对应的值。而memberValues 的来源是Java 常量池。
3.元注解以及都有哪些
元注解,就是JDK自带的注解,就是在我们自定义注解时,注解到我们自定义的注解上的。
提供了四种元注解,
@Documented – 注解是否将包含在JavaDoc中
@Retention – 什么时候使用该注解
@Target – 注解用于什么地方
@Inherited – 是否允许子类继承该注解
(1)@Target – 表示该注解用于什么地方。默认值为任何元素,表示该注解用于什么地方。可用的ElementType 参数包括
● ElementType.CONSTRUCTOR: 用于描述构造器
● ElementType.FIELD: 成员变量、对象、属性(包括enum实例)
● ElementType.LOCAL_VARIABLE: 用于描述局部变量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述参数
● ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明
(2)@Retention – 定义该注解的生命周期
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
(3)@Documented – 一个简单的Annotations 标记注解,表示是否将注解信息添加在java 文档中。
(4)@Inherited – 定义该注释和子类的关系
@Inherited 元注解是一个标记注解,@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的annotation 类型被用于一个class,则这个annotation 将被用于该class 的子类。
4.自定义注解
知道了注解的原理以及定义,我们如何来手写一个自定义的注解呢?
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 自定义注解
*
* @author wzx
* @date 2020/5/20
*/
// 用于描述方法
@Target({ElementType.METHOD})
// 运行时有效
@Retention(RetentionPolicy.RUNTIME)
public @interface XTest {
long time() default -1;
}
我们先用@interface 定义一个我们的注解,加上@Target和@Retention元注解
再写一个简单的实现类:
import java.util.Date;
/**
* 自定义注解实现类
*
* @author wzx
* @date 2020/5/20
*/
public class MyAnnotation {
public void test(){
System.out.println("执行自定义注解");
System.out.println("执行自定义注解结束时间:"+new Date());
}
}
再写一个使用注解的类:
/**
* 自定义注解使用
*
* @author wzx
* @date 2020/5/20
*/
public class TestMyAnnotation {
private MyAnnotation myAnnotation = new MyAnnotation();
@XTest
public void test() {
myAnnotation.test();
}
}
最后利用反射:
import java.lang.reflect.Method;
import java.util.Date;
/**
* 自定义注解反射
*
* @author wzx
* @date 2020/5/20
*/
public class RunMyAnnotation {
// 反射注解
public static void main(String[] args) throws Exception {
System.out.println("执行自定义注解开始时间:" + new Date());
Class clazz = TestMyAnnotation.class;
Method[] ms = clazz.getMethods();
for (Method method : ms) {
boolean flag = method.isAnnotationPresent(XTest.class);
if (flag) {
method.invoke(clazz.newInstance(), null);
}
}
}
}
附上运行结果