Java注解的介绍和使用详细讲解

刺骨的言语ヽ痛彻心扉 2023-09-23 14:25 126阅读 0赞

#### 文章目录 ####

*  注解
 *   *  注解基本介绍
     *  自定义注解
     *  元注解
     *  注解解析

## 注解 ##

### 注解基本介绍 ###

**注解概述**:

> Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
> 
> Java 语言中的类、构造器、方法、成员变量、参数等都可以被注解进行标注。

**注解的作用**:

> 对Java中类、方法、成员变量做标记，然后进行特殊处理，至于到底做何种处理由业务需求来决定。
> 
> 例如：JUnit框架中，标记了注解@Test的方法就可以被当成测试方法执行，而没有标记的就不能当成测试方法执行。

![在这里插入图片描述][3f0f8857265742afa0c59a11e86458e4.png_pic_center]

### 自定义注解 ###

**自定义注解**:

> 自定义注解就是自己做一个注解来使用

**自定义注解的格式如下**:

public @interface 注解名称 {
        
      	public 属性类型 属性名() default 默认值 ;
    }

**注意**:

> 自定义注解的默认值可以省略不写;
> 
> 自定义默认是公开的, 可以省略public修饰符

**演示代码**:

> 自定义注解MyBook

public @interface MyBook {
        
        String name();
        String[] authors();
        // 给默认值
        double price() default 88.8;
    }

> 使用自定义注解可以标注类, 变量, 方法等等

@MyBook(name = "Java数据结构", authors = {
        "作者1", "作者2"})
    public class AnnotationDemo {
        
        @MyBook(name = "Java数据结构1", authors = {
        "作者1", "作者2"})
        public static void main(String[] args) {
        
            @MyBook(name = "Java数据结构2", authors = {
        "作者1", "作者2"})
            int num = 0;
        }
    }

**特殊类型**:

> value属性，如果只有一个value属性的情况下，使用value属性的时候可以省略value名称不写!!

public @interface Book {
        
        // 只有一个value属性
        String value(); // 特殊属性
    }

//@Book(value = "/delete")
    
    @Book("cba") // 可以省略不写
    public class AnnotationDemo {
        
    }

> 但是如果有多个属性, 且多个属性没有默认值，那么value名称是不能省略的;
> 
> 如果多个属性都有默认值, 那么value名称又可以省略。

// 多个值,	且其他值都有默认值
    public @interface Book {
        
        String value(); // 特殊属性
        String name() default "一本书";
        double price() default 99.9;
    }

//@Book(value = "/delete")
    
    @Book("cba") // 可以省略不写
    public class AnnotationDemo {
        
    }

### 元注解 ###

**元注解定义**:

> 元注解就是注解的注解

**元注解有两个**:

> @Target: 约束自定义注解只能在哪些地方使用，
> 
> @Retention：申明注解的生命周期

**Target中可使用的值定义在ElementType枚举类中，常用值如下**:

> TYPE，表示该注解只能注解类，接口
> 
> FIELD, 表示该注解只能注解成员变量
> 
> METHOD, 表示该注解只能注解成员方法
> 
> PARAMETER, 表示该注解只能注解方法参数
> 
> CONSTRUCTOR, 表示该注解只能注解构造器
> 
> LOCAL\_VARIABLE, 表示该注解只能注解局部变量

@Target({
        ElementType.FIELD, ElementType.METHOD}) // 表示自定义注解只能对成员变量和方法进行注解
    public @interface MyTest {
        
    }

**Retention中可使用的值定义在RetentionPolicy枚举类中，常用值如下(*一般不用, 希望注解永远存在*)**:

> SOURCE： 注解只作用在源码阶段，生成的字节码文件中不存在
> 
> CLASS： 注解作用在源码阶段，字节码文件阶段，运行阶段不存在，默认值.
> 
> RUNTIME：注解作用在源码阶段，字节码文件阶段，运行阶段（开发常用）

@Retention(RetentionPolicy.RUNTIME) // 表示注解一直存在
    public @interface MyTest {
        
    }

### 注解解析 ###

**注解的解析**:

> 注解的操作中经常需要进行解析，注解的解析就是判断是否存在注解，存在注解就解析出内容。

**与注解解析相关的接口**:

> Annotation: 注解的顶级接口，注解都是Annotation类型的对象
> 
> AnnotatedElement: 注解的元素接口, 该接口定义了与注解解析相关的解析方法

**注解的方法如下**:

> 所有反射的类成分Class, Method , Field , Constructor，都实现了AnnotatedElement接口他们都拥有解析注解的能力

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Annotation[] getDeclaredAnnotations()</td> 
   <td>获得当前对象上使用的所有注解，返回注解数组。</td> 
  </tr> 
  <tr> 
   <td>getDeclaredAnnotation(Class&lt;T&gt; annotationClass)</td> 
   <td>根据注解类型获得对应注解对象</td> 
  </tr> 
  <tr> 
   <td>isAnnotationPresent(Class&lt;Annotation&gt; annotationClass)</td> 
   <td>判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false</td> 
  </tr> 
 </tbody> 
</table>

**解析注解的技巧**:

> 注解在哪个成分上，我们就先拿哪个成分对象。
> 
> 比如注解作用成员方法，则要获得该成员方法对应的Method对象，再来拿上面的注解
> 
> 比如注解作用在类上，则要该类的Class对象，再来拿上面的注解
> 
> 比如注解作用在成员变量上，则要获得该成员变量对应的Field对象，再来拿上面的注解

**注解解析案例练习**:

**步骤如下**:

> 定义注解Book，要求如下：
> 
>  *  包含属性：String value() 书名
>  *  包含属性：double price() 价格，默认值为 100
>  *  包含属性：String\[\] authors() 多位作者
>  *  限制注解使用的位置：类和成员方法上
>  *  指定注解的有效范围：RUNTIME
> 
> 定义BookStore类，在类和成员方法上使用Book注解
> 
> 定义AnnotationDemo测试类获取Book注解上的数据

**演示代码**:

> 实现自定义注解Book

@Target({
        ElementType.TYPE, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Book {
        
        String value();
        double price() default 100;
        String[] authors();
    }

> 定义BookStore类, 在类和成员方法上使用Book注解

@Book(value = "大话西游", authors = {
        "作者a", "作者b"})
    public class BookStore {
        
        @Book(value = "盗梦空间", price = 10.99,authors = {
        "作者1", "作者2"})
        public void bubBook() {
        
            System.out.println("买书成功");
        }
    }

> 定义AnnotationDemo测试类获取Book注解上的数据

public class AnnotationDemo {
        
        public static void main(String[] args) {
        
            // 获取Class类对象
            Class c = BookStore.class;
    
            // 判断该类上是否存在Book.class这个注解对象
            if (c.isAnnotationPresent(Book.class)) {
        
                // 存在获取BookStore类的Book.class这个注解对象
                Book book = (Book) c.getAnnotation(Book.class);
    
                // 查看注解内容
                System.out.println(book.value()); // 大话西游
                System.out.println(book.price()); // 100.0
                System.out.println(Arrays.toString(book.authors())); // [作者a, 作者b]
            }
        }
    }

[3f0f8857265742afa0c59a11e86458e4.png_pic_center]: https://img-blog.csdnimg.cn/3f0f8857265742afa0c59a11e86458e4.png#pic_center