JAVA自定义注解与解析

Bertha 。 2024-04-17 20:53 64阅读 0赞

注解是一种提供便捷性的配置方法。其本质是一个继承于Annotation的**普通接口**，它需要有解析它的代码才可以起到作用。

下面展示了SpringBoot web开发中经常使用的`@Controller`注解，可以看出它的定义方式和接口的定义很像。

//SpringBoot中@Controller注解的源码
    
    @Target({ ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Component
    public @interface Controller { 
        @AliasFor(
            annotation = Component.class
        )
        String value() default "";
    }

注解的解析的方法有两种，一种是编译时期的**直接扫描**，一种是运行时期的**反射**。编译时期的扫描是指编译器在对JAVA源代码时，检测到某些注解修饰，会执行相应的处理，例如@Override。一旦编译器检测到某个方法被修饰了 @Override 注解，编译器就会检查当前方法的方法签名是否真正重写了父类的某个方法，也就是比较父类中是否具有一个同样的方法签名。

# 一、注解的分类 #

Java中注解可以大致分为三类。其中，自带的标准注解比较简单，此处不再赘述。元注解是注解的注解，用在自定义注解中。

**1、Java自带的标准注解**

包括@Override、@Deprecated和@SuppressWarnings，分别用于标明重写某个方法、标明某个类或方法过时、标明要忽略的警告，用这些注解标明后编译器就会进行检查。

**2、元注解**

元注解是用于定义注解的注解，包括@Retention、@Target、@Inherited、@Documented，@Retention用于标明注解被保留的阶段，@Target用于标明注解使用的范围，@Inherited用于标明注解可继承，@Documented用于标明是否生成javadoc文档。

**3、自定义注解**

可以根据自己的需求定义注解，并可用元注解对自定义注解进行注解。

# 二、元注解 #

要想自定义注解，就必须先了解元注解。元注解是用于修饰注解的注解，通常用在注解的定义上。JAVA 中有以下几个『元注解』：

> @Target：注解的作用目标  
> @Retention：注解的生命周期  
> @Documented：注解是否应当被包含在 JavaDoc 文档中  
> @Inherited：是否允许子类继承该注解

### 1、@Target ###

`@Target`表明注解用在什么地方，它的取值情况如下：

*  ElementType.TYPE:用于描述类、接口或enum声明
 *  ElementType.FIELD:用于描述实例变量
 *  ElementType.METHOD
 *  ElementType.PARAMETER
 *  ElementType.CONSTRUCTOR
 *  ElementType.LOCAL\_VARIABLE
 *  ElementType.ANNOTATION\_TYPE 另一个注释
 *  ElementType.PACKAGE 用于记录java文件的package信息

### 2、@Retention ###

`@Retention`表示什么时候使用该注解，它的取值情况如下：

*  RetentionPolicy.SOURCE
    
    在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。@Override告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()写成了toStrring()\{double r\}，而且我也没有使用@Override注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。
 *  RetentionPolicy.CLASS
    
    在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。
 *  RetentionPolicy.RUNTIME
    
    始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

### 3、@Documented ###

`@Documented`表示注解是否将包含在JavaDoc中

### 4、@Inherited ###

`@Inherited`表示是否允许子类继承该注解。注意：默认注解是不允许继承的。

--------------------

# 三、自定义注解与注解解析 #

引用[博主LIUCQW的自定义注解的例子][LIUCQW]，写的很完善很棒。此处直接引用。

自定义的注解：

@Target(ElementType.FIELD)//注解的作用范围，就是注解是用在什么地方的
    @Retention(RetentionPolicy.RUNTIME)//注解的级别，就是注解能留存到什么时候
    @Documented
    @Inherited
    public @interface MyAnnotation {
        public String value();//注解可以接收的参数
    }

在其他的类中使用该注解：

public class People {
        @MyAnnotation("liu")  //使用自定义的注解，将注解接收的参数赋值给对应的变量
        private String name;
        public People() {
            Inject.injectfeild(this);  //在构造函数中触发对注解的解析
        }
        public String getName(){
            return name;
        }
    }

对注解进行解析，使得注解可以实现对应的功能。

public class Inject {
        public static void injectfeild(Object o){
             Class<?> clazz = o.getClass();  //获得传进来的类
             Field[] fields = clazz.getDeclaredFields();//通过反射获取类的域（全局变量）
             for (Field field : fields) { 
                // 查看这个字段是否有我们自定义的注解类标志的  
                 if (field.isAnnotationPresent(MyAnnotation.class)) {  
                     MyAnnotation inject = field.getAnnotation(MyAnnotation.class);  //获取到我们的注解
                     String value=inject.value();//获取注解的参数
                     field.setAccessible(true);
                     try {
                        field.set(o, value);//为我们的字段赋值
                    } catch (IllegalArgumentException | IllegalAccessException e) {
    
                        e.printStackTrace();
                    }
                 }
             }
        }
    }

最后，测试注解是否生效

public class Test {
    
        public static void main(String[] args) {
            People people=new People();
            System.out.println(people.getName());  //输出liu, 注解生效
        }
    
    }

--------------------

# 四、注解原理 #

虚拟机规范定义了一系列和注解相关的属性表，也就是说，无论是字段、方法或是类本身，如果被注解修饰了，就可以被写进字节码文件。属性表有以下几种：

RuntimeVisibleAnnotations：运行时可见的注解  
RuntimeInVisibleAnnotations：运行时不可见的注解  
RuntimeVisibleParameterAnnotations：运行时可见的方法参数注解  
RuntimeInVisibleParameterAnnotations：运行时不可见的方法参数注解  
AnnotationDefault：注解类元素的默认值  
看虚拟机的这几个注解相关的属性表的目的在于，让大家从整体上构建一个基本的印象，注解在字节码文件中是如何存储的。

所以，对于一个类或者接口来说，Class 类中提供了以下一些方法用于反射注解。

getAnnotation：返回指定的注解  
isAnnotationPresent：判定当前元素是否被指定注解修饰  
getAnnotations：返回所有的注解  
getDeclaredAnnotation：返回本元素的指定注解  
getDeclaredAnnotations：返回本元素的所有注解，不包含父类继承而来的

创建一个Test注解举例说明：

//创建Test注解，声明作用于类并保留到运行时，默认值为default
    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Test {
        String value() default "default";
    }
    
    ------------------------
    
    //使用注解
    @Test("test")
    public class AnnotationTest {
        public void test(){
        	Test t = AnnotationTest.class.getAnnotation(Test.class);  
    		tm = AnnotationTest.class.getDeclaredMethod("test",null).getAnnotation(TestMethod.class);  
    		AnnotationTest.class.getDeclaredField("field").getAnnotation(MyAnTargetField.class);  
    		...
        }
    }

从java源码到class字节码是由编译器完成的，编译器会对java源码进行解析并生成class文件，而注解也是在编译时由编译器进行处理，编译器会对注解符号处理并附加到class结构中，根据jvm规范，class文件结构是严格有序的格式，唯一可以**附加信息到class结构中的方式就是保存到class结构的attributes属性**中。我们知道对于类、字段、方法，在class结构中都有自己特定的表结构，而且各自都有自己的属性，而对于注解，作用的范围也可以不同，可以作用在类上，也可以作用在字段或方法上，这时编译器会对应将注解信息存放到类、字段、方法自己的属性上。

在我们的AnnotationTest类被编译后，在对应的AnnotationTest.class文件中会包含一个RuntimeVisibleAnnotations属性，由于这个注解是作用在类上，所以此属性被添加到类的属性集上。即Test注解的键值对value=test会被记录起来。**而当JVM加载AnnotationTest.class文件字节码时，就会将RuntimeVisibleAnnotations属性值保存到AnnotationTest的Class对象中，于是就可以通过AnnotationTest.class.getAnnotation(Test.class)获取到Test注解对象，进而再通过Test注解对象获取到Test里面的属性值。**

这里可能会有疑问，Test注解对象是什么？其实注解被编译后的本质就是一个继承Annotation接口的接口，所以@Test其实就是“public interface Test extends Annotation”，当我们通过AnnotationTest.class.getAnnotation(Test.class)调用时，JDK会通过动态代理生成一个实现了Test接口的对象，并把将RuntimeVisibleAnnotations属性值设置进此对象中，此对象即为Test注解对象，通过它的value()方法就可以获取到注解值。

Java注解实现机制的整个过程如上面所示，它的实现需要编译器和JVM一起配合。

--------------------

推荐博客：https://blog.csdn.net/xsp\_happyboy/article/details/80987484  
参考博客：https://www.iteye.com/blog/uule-2436297  
参考博客：https://www.cnblogs.com/yangming1996/p/9295168.html

[LIUCQW]: https://blog.csdn.net/u010590685/article/details/47066865