深入理解java注解的实现原理

Myth丶恋晨 2023-06-13 03:29 5阅读 0赞

# 前言 #

在Spring 2.0及早期时代，Web项目开发是通过配置文件 xml来实现 Bean 的依赖注入，有多少个Bean，就在xml配置问价中加多少个，这样一来在 Bean 的数量越来越多的时候，xml的配置也就会越来越复杂，显得格外的冗余，很多代码都是一个模式，需要做下封装才好。Spring 2.0 在xml配置文件上做了一定的优化，让配置看起来越来越简单，但是并没语完全解决xml冗余的问题。  
而在后来的 Spring 3.0 时代，可以使用 Spring 提供的 Java 注解来取代曾经 xml 配置上的所产生的问题，Spring 使得项目开发配置变得简单了许多

# 一、什么是注解 #

自Java5.0版本引入注解之后，注解就成为了Java平台中非常重要的一部分。注解也叫元数据，例如我们常见的 ==@Override和 @Deprecated，注解是 JDK1.5版本开始引入的一个特性，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解，注解可以用一个词来描述：元数据，即一种描述数据的数据。所以，可以说注解就是源代码的元数据

## 二、注解的分类 ##

**1、一般常用的注解可以分为三类：**

一类是系统带的如@Override，这类注解对其标注的目标的处理在JVM层面进行；另一类是我们自定义的注解，自己定义的注解自己要进行解析。还有一类是描述注解的注解，共有4个，分别是：  
**  a、@Documented 注解是否将包含在JavaDoc中**

**  **@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文    档化。Documented是一个标记注解，没有成员  
**  b、@Retention 注解的生命周期**

RetentionPolicy.SOURCE（编译结束后失效如@Override）、RetentionPolicy.CLASS（JVM加载类的时候失效，默认。不能 通  过反射获取）、**RetentionPolicy.RUNTIME（始终不失效，一般用于自定义注解，可通过反射获取）**

**  c、@Target 注解用在什么地方，是Annotation所修饰的对象范围，****分别有几个地方：**

**  ElementType.TYPE: **         类上  
**  ElementType.FIELD:**         成员变量  
**  ElementType.METHOD ： **方法  
**  ElementType.PARAMETER：** 参数  
**  ElementType.CONSTRUCTOR：** 构造方法  
**  ElementType.LOCAL\_VARIABLE：** 本地变量  
**  ElementType.ANNOTATION\_TYPE：** 另一个注释  
**  ElementType.PACKAGE：** 包上

**  源代码如下：**

@Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Target {
        /**
         * Returns an array of the kinds of elements an annotation type
         * can be applied to.
         * @return an array of the kinds of elements an annotation type
         * can be applied to
         */
        ElementType[] value();
    }

其中只有一个元素ElementType，再看看它的源码如下：

public enum ElementType {
        /** Class, interface (including annotation type), or enum declaration */
        TYPE,
        /** Field declaration (includes enum constants) */
        FIELD,
        /** Method declaration */
        METHOD,
        /** Formal parameter declaration */
        PARAMETER,
        /** Constructor declaration */
        CONSTRUCTOR,
        /** Local variable declaration */
        LOCAL_VARIABLE,
        /** Annotation type declaration */
        ANNOTATION_TYPE,
        /** Package declaration */
        PACKAGE,
        /**
         * Type parameter declaration
         *
         * @since 1.8
         */
        TYPE_PARAMETER,
        /**
         * Use of a type
         *
         * @since 1.8
         */
        TYPE_USE
    }

ElementType是一个枚举类定义注解可以作用的类型上，上面例子中演示了TYPE，FIELD，METHOD，PARAMETER 4种可以  作用的目标

**  d、@Inherited 注解作用被子类继承**

@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的     annotation类型被用于一个class，则这个annotation将被用于该class的子类

## 三、注解的定义 ##

### 1、注解定义： ###

注解就是用来描述包、类、成员变量、方法或者参数的元数据，注解本身也是一个类（Java里一切都是对象）。配置过Spring的同学肯定很清楚，Spring中的Bean需要在xml里面声明，比如说一个Bean他的构造方法是啥，他依赖哪些其他bean，初始化变量值是多少，这些都是描述性的数据告知Spring按照这个描述去创建这个Bean。我们随便找个例子：

**这些对类和变量等的描述实际上就是元数据，而这些都可以用注解取代，因为注解也是元数据。**比如@Component注解标注在一个类上就可以说明该类是一个bean，@Autowire标注在成员变量上就直接给该成员变量赋值。看起来注解标注在代码上耦合性更强了，但实际上本着约定优于配置的原则，代码更加清晰，也容易维护。

## 2、XML和注解区别， ##

**注解： **是一种分散式的元数据，与源代码紧绑定。，

**xml：** 是一种集中式的元数据，与源代码无绑定

## 三、如何自定义注解 ##

### 3.1 定义一个注解需要几步？ ###

首先、@Target肯定要有；  
其次、生命周期尽量RUNTIME；  
然后、使用@interface声明；  
再次、内部只支持基本类型、String类型和枚举类型；  
最后、所有属性都必须写成field（），并可提供默认值default；

### 3.2 如何使用注解？ ###

首先、在对应位置（@Target）标注；  
然后、给注解中的属性赋值；

@Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @interface Company {
       public enum Status {RUNNING, CLOSED}
       String name() default "NETEASE"； //有默认值
       Status status() default Status.RIUNNING;
       String location（）；//没有默认值
    } 
    public class Demo{
        @Company（name="阿里巴巴"，status=Company.Status.RUNNING,location="北京"）
        public void companyInfo（）{}
    }
    @interface Country{
      String value（）；
    }
    @Country（"中国"）
    public void method(){};

上面是第一个自定义注解的例子，该注解需要标注在方法上，在运行期间一直存在。如果注解中只有一个属性可以命名为value（）这种的好处是注解标注的时候不用写value=xxx而是直接写xxx即可。

### 3.3 注解标注完如何处理？ ###

首先、定义一个注解处理类和注解处理方法；如果你熟悉反射代码，就会知道反射可以获取类名、方法和实例变量对象。所有这些对象都有getAnnotation()这个方法用来返回修饰它们的注解信息。因此可以通过反射获取注解标注的类或者方法或者变量等等并对其做相应处理；

import java.lang.reflect.Field;
    public class AnnotationProccessor {
        public  static void process(Demo demo){
            Class demoClazz = Demo.class;
              for(Method method : demoClazz.getMethods()) {
                 Company companyAnnotation = (Company)method.getAnnotation(Company.class);
                 if(companyAnnotation !=null) {
                    System.out.println(" Method Name : "+ method.getName());
                    System.out.println(" name : "+ companyAnnotation.name());
                    System.out.println(" Status : "+ companyAnnotation.status());
         }
      } 
    }

上面的类只对特定的类进行了处理，在Spring中一个如@Service这种注解，Spring在启动IOC容器的时候会对每个类进行扫描，把所有标注@Component及其子注解如@Service的类进行Bean处理。

参考文章：

### [Java中的注解是如何工作的？][Java] ###

### **[Java注解工作机制][Java 1]** ###

### **[深入理解Java注解原理][Java 2]** ###

[Java]: https://blog.csdn.net/zxd1435513775/article/details/89973721
[Java 1]: https://blog.csdn.net/KouLouYiMaSi/article/details/80589089
[Java 2]: https://mp.weixin.qq.com/s?__biz=MzAxMjY1NTIxNA==&mid=2454441897&idx=1&sn=729688d470c94560c1e73e79f0c13adc&chksm=8c11e0a8bb6669be1cc4daee95b221ba437d536d598520d635fac4f18612dded58d6fddb0dce&scene=21#wechat_redirect