Java 注解

Java注解

• 本文参照学习：

  感谢大佬~

• 个人源码地址：https://gitee.com/WSM540

注解

前言：

框架等于：注解 + 反射 + 设计模式~

JDK 5.0 开始, Java 增加了对元数据的支持, 也就是 Annotation(注解) 安闹太湿~

Annotation 其实就是代码里的 特殊标记, 这些标记可以在编译, 类加 载, 运行时被读取, 并执行相应的处理

• 通过：注解 + 反射

  反射扫描对应类的注解，以及注解上面的参数，给类的添加一些通用的操作~

• 开发者，可以：

  不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息

  代码分析工具、开发工具和部署工具：可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用：

• 用于修饰包,类, 构造器, 方 法, 成员变量, 参数, 局部变量的声明

为什么要引用注解：

使用【注解】之前：

• xml 是被广泛的应用于描述元数据， 它以松耦合的方式完成了框架中几乎所有的配置

  但是随着项目越来越庞大： XML 的内容也越来越复杂，一些应用开发人员和架构师发现维护成本变高。

• 人门跟希望出现一些和代码 紧耦合的方式~

  可以更加清晰的了解类的声明~

• 于是就有人提出来一种标记式高耦合的配置方式 注解:

  方法上可以进行注解，类上也可以注解，字段属性上也可以注解，反正几乎需要配置的地方都可以进行注解. 对象代码进行声明管理;

注解需要配合反射一起使用~

Java常见的 Annotation 实例：

@Override

• 限定重写父类方法, 该注解只能用于方法 属于一种标记注解

• //1. 定义一个接口
  interface Info{
      void show();
  }
  //2. 创建一个类,实现接口 info 实现方法~
  class Student implements Info{
      //一般工具都会自动加一个注解, 
      //    表示： 改方法是实现接口的重写方法(); 当然不加也没啥事情,只是一个程序提示~
      @Override
      public void show() {   }
  }

  @Deprecated

• 用于表示所修饰的元素(类, 方法等)已过时，通常是因为 所修饰的结构危险或存在更好的选择

• Date date = new Date(2000,9,9); 
  //这段代码并不会报错：创建一个日期对象 2000-09-09 日期对象;
  //    但 new Date(); 方法上会有一个 删除线， 提示改方法以及淘汰~
  
  //ctrl+右击  查看源码发现,改方法被注解为已淘汰~
  @Deprecated
  public Date(int year, int month, int date) {
      this(year, month, date, 0, 0, 0);
  }

• 这样声明并不是表示，方法不能使用而是不建议 已经有更好的方法了

  JDK是向下兼容的，不然每次更新一些老项目如果不符合就会出错，就不好了~

• 场景：

  如果你的项目中有一个，你写的方法，突然一个大佬也写了一个更好的，你又不想删除曾经的方法

  都是手敲的多少有点舍不得 可以使用该 注解 ，标记一下方法~ 已淘汰

@SuppressWarnings

• 抑制编译器警告
• 当我门定义对象，没有被使用的时候, 编辑器会出现 警告 可以使用该注解， 屏蔽警告⚠

使用注解前面要加 @符号 当作一个修饰符使用，声明在类 方法 属性上！

自定义注解：

目前除了, JDK自带的注解，很多的框架也提供了很多的注解：

• Spring　JPA　Hibernate 很多框架都提供很多注解，实现基于注解开发~

• 自定义注解，并不常见但可以了解...

  自定义注解必须配上注解的信息处理流程才有意义 如果没有解析它的代码，它可能连注释都不如

实现：

• 定义新的 Annotation 类型使用 @interface 关键字
• 自定义注解自动继承了：Java.lang.annotation.Annotation接口

• Annotation 的成员变量

  以无参数方法的形式来声明

  其：方法名和返回值 对应 该成员的 ==名字==和==类型==

• 类型只能是：

  八种基本数据，String，Class，enum，Annotation

MyAnnotation

Idea 工具创建 Annotation 注解类：

MyAnnotation

/** 自定义注解1.0 */
@Retention(RetentionPolicy.RUNTIME)                    //一种元注解: 标识注解的执行生命周期 (什么时候被执行！)
public @interface MyAnnotation {

    //这是自定义注解中,属性的声明方式: 数据类型 参数名;
//    String value();

    //指定成员变量的初始值可使用 default 关键字
    String value() default "wsm";                   /** 如果只有一个参数成员，建议使用参数名为value */
}

TestAnnotation.Java

package com.wsm.anotation;
import java.lang.annotation.Annotation;
/** 步骤2 */
public class TestAnnotation {
    public static void main(String[] args) {
        //使用反射,来完成注解是实习,这里只是简单的输出.
        //  很多时候反射,扫描所有的类,并判断注解的参数 完善类添新的功能~
        Class clazz = Wsm.class;
        Annotation[] annotations = clazz.getAnnotations();      //获取当前类的注解集合~
        for(int i = 0;i < annotations.length;i++){              //输出注解集合的值！
            System.out.println(annotations[i]);
        }
    }
}

/** 步骤1 */
//@MyAnnotation                     //啥也不写默认值~
//@MyAnnotation(value = "abc")      //手动填写
@MyAnnotation("efg")              //如果注解的只有一个属性且属性名是 value: 可以省略不写
class Wsm{
    //一个空的类,使用 自定义注解~
    @MyAnnotation
    public void show(){
        System.out.println("show方法()");
    }
}

• ok，这就是一个最基本是 自定义注解的使用~

• 别忘了自定义注解要加上 @Retention(RetentionPolicy.RUNTIME) 不然类加载时候，扫描不到;

  @Retention 是什么？

  @Retention是一种元注解

元注解Meta-Annotation：

什么是元注解：

Java5.0定义了4个标准的 Meta-Annotation类型 继承了：Java.lang.annotation.Annotation接口

元注解的作用就是负责注解其他注解： 它们被用来提供对其它 注解类型作说明; 修饰注解的注解

JDK 中的元注解 4:

@Retention

• 用于修饰一个 Annotation 定义， 用于指定该 Annotation 的生命 周期

  @Rentention 包含一个 RetentionPolicy 类型的成员变量enum类型 @Rentention 包含一个 RetentionPolicy 类型的成员变量

• RetentionPolicy枚举

  **RetentionPolicy.SOURCE**
  - **注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视**
  
  **RetentionPolicy.CLASS**
  - **当运行Java 程序时, JVM不会保留注解，这是`默认值`**
  - **实例：** `@Override、@Deprecated、@SuppressWarnning`
  
  **RetentionPolicy.RUNTIME**
  - **当运行 Java 程序时, JVM 会保留注释，`程序可以通过反射获取该注释`**
  - **实例：** `@Controller、@Autowired、@RequestMapping`
  - `自定义注解,想要被扫描到,需要添加改注解 @Retention(RetentionPolicy.RUNTIME)`

@Target

• 用于修饰 Annotation 定义, 指定被修饰的 Annotation 能用于 修饰哪些程序元素 默认值：为任何元素

  即：注解可以修饰的元素：类 属性 泛型 enum枚举 方法()...

• JDK5.0

  顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  ElementType.CONSTRUCTOR     可以给构造方法进行注解
  ElementType.FIELD             可以给属性进行注解
  ElementType.LOCAL_VARIABLE     可以给局部变量进行注解
  ElementType.METHOD             可以给方法进行注解
  ElementType.PACKAGE         可以给一个包进行注解
  ElementType.PARAMETER         可以给一个方法内的参数进行注解
  ElementType.TYPE             可以给一个类型进行注解，比如类、接口、枚举

• JDK8.0顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去

  ElementType.TYPE_PARAMETER    可以给一个泛型进行注解
  ElementType.TYPE_USE         表示该注解能写在使用类型的任何语句中 `声明了改类型就不用在声明其它方式了.`

@Documented

• 顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去
• 定义为Documented的注解必须设置Retention值为RUNTIME

@Inherited

• @Inherited 元注解是一个标记注解被标注的类型是被继承的
• A类 使用了带有 @Inherited的注解，B类 继承 A类，B也会拥有A的注解~

JDK8.0 新增元注解

@Repeatable

• 可重复注解 有时候,需要注解在类上多次声明使用可以使用改注解.

JDK8.0 可重复注解使用：

定义可重复的注解容器注解

MyAnnotations

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
    MyAnnotation[] value();             //注解属性,是可重复注解的数组~
}

MyAnnotation

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MyAnnotations.class)           //1.8新增可重复注解,知道注解容器~
public @interface MyAnnotation {
    String value();                         //参数~
}

TestAnnotation.java

import java.lang.annotation.Annotation;

/** 步骤2 */
public class TestAnnotation {
    public static void main(String[] args) {
        //使用反射,来完成注解是实习,这里只是简单的输出.
        //  很多时候反射,扫描所有的类,并判断注解的参数 完善类添新的功能~
        Class clazz = Wsm.class;
        Annotation[] annotations = clazz.getAnnotations();      //获取当前类的注解集合~
        for(int i = 0;i < annotations.length;i++){              //输出注解集合的值！
            System.out.println(annotations[i]);
        }
    }
}

/** 步骤1 */
@MyAnnotation("abc")        //可重复注解,可以一次添加多个属性！
@MyAnnotation("efg")
class Wsm{
    //一个空的类,使用 自定义注解~
    public void show(){
        System.out.println("show方法()");
    }
}

运行结果：

@com.wsm.annotation2.MyAnnotations(value[@com.wsm.annotation2.MyAnnotation(value=abc),@com.wsm.annotation2.MyAnnotation(value=efg)])

输出了多个注解的 value