Java中注解与解析

注解

注解概述

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

示例代码

import org.junit.Test;

public class Demo01 {
    @Test //注解-Annotation
    public void test01(){
        
    }
    @Test //注解-Annotation
    public void test02(){
        
    }
}

注解的作用

​ 对Java中类、方法、成员变量做标记，然后进行特殊处理，至于到底做何种处理由业务需求来决定。

例如：JUnit框架中，标记； 注解@Test的方法可以被当成测试方法执行，二没有标记的就不能当成测试方法。

自定义注解

​ 顾名思义，自定义注解就是自己做一个注解来使用。

格式

 public @interface 注解名称{
        public  属性类型(Java支持的数据类型基本上都支持) 属性名() default 默认值;
    }

示例代码

/*
    自定义注解，格式及语法
 */
public @interface MyBook {
    String name();
    String[] authors();
    double price();
}
/*
    使用自定义注解:类、方法、成员变量
 */
@MyBook(name="精通Java",authors={"黑马","dlel"},price=99.9)
public class Demo02 {

    @MyBook(name="精通Java",authors={"黑马","dlel"},price=99.9)
    public Demo02(){

    }

    @MyBook(name="精通Java",authors={"黑马","dlel"},price=99.9)
    public static void main(String[] args) {
        @MyBook(name="精通Java",authors={"黑马","dlel"},price=99.9)
        int age = 22;
    }
}

特殊属性

​ value属性，如果只有一个value属性的情况下，使用value属性的时候可以省略value名称不写！但是如果有多个属性, 且多个属性没有默认值，那么value名称是不能省略的。

示例代码1

/*
    特殊属性:
        只有一个属性，属性名可以省略不写
        有多个属性，有默认值的属性名可省略不写; 无默认值不可省略
 */
public @interface Book {
    String value();
}
// 方式1
//@Book(value="精通JavaEE")
// 方式2:只有一个value，可以省略属性名
@Book("java")
public class Demo03 {

}

元注解

​ 注解 注解的注解

元注解常见注解

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

@Target的可使用的值

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

• TYPE，类，接口
• FIELD, 成员变量
• METHOD, 成员方法
• PARAMETER, 方法参数
• CONSTRUCTOR, 构造器
• LOCAL_VARIABLE, 局部变量

示例代码

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

// @Target 约束注解只能在那些地方使用 这里：方法和成员变量
@Target({ElementType.METHOD,ElementType.FIELD}) // 元注解
public @interface MyTest {

}
package com.etime.demo01;
//@MyTest 错误：MyTest中元注解约束只能在方法和成员变量上 注解
public class Demo01 {

    @MyTest
    private String name;
    @MyTest
    public static void main(String[] args) {

    }
}

@Retention的可使用的值

​ Retention的可使用的值定义在RetentionPolicy枚举类中，常用值如下

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

// @Target 约束注解只能在那些地方使用 这里：方法和成员变量
@Target({ElementType.METHOD,ElementType.FIELD}) // 元注解
@Retention(RetentionPolicy.RUNTIME)// 元注解 一直存在
public @interface MyTest {

}

注解的解析

什么是注解的解析

​ 注解的解析就是判断是否存在注解，存在注解就解析出内容。

注解解析相关接口

• Annotation: 注解的顶级接口，注解都是Annotation类型的对象
• AnnotatedElement:该接口定义了与注解解析相关的解析方法
• 所有的类成分Class, Method , Field , Constructor，都实现了AnnotatedElement接口他们都拥有解析注解的能力：

AnnotatedElement接口

方法	说明
Annotation[] getDeclaredAnnotations()	获得当前对象上使用的所有注解，返回注解数组。
T getDeclaredAnnotation(Class annotationClass)	根据注解类型获得对应注解对象
boolean isAnnotationPresent(Class annotationClass)	判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false

解析注解的技巧

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

代码示例

// 注解
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {
    String value();
    double price() default 100;
    String[] author();
}
// 使用注解
@Book(value = "西游记",price = 99,author = {"吴承恩","xxx","cc"})
public class BookStore {

    @Book(value = "红楼梦",price = 199,author = {"曹雪芹","xxx","cc"})
    public void test(){

    }
}
// 解析注解
import java.lang.reflect.Method;
import java.util.Arrays;

/*
    注解的解析
 */
public class Demo02 {

    @Test
    public void parseClass(){
        // 1.先得到类对象
        Class c = BookStore.class;
        // 2.判断这个类上是否存在这个注解
        if (c.isAnnotationPresent(Book.class)) {
            // 3.直接获取该注解对象
            Book book = (Book) c.getDeclaredAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.author()));
        }
    }

    @Test
    public void parseMethod() throws NoSuchMethodException {
        // 1.先得到类对象
        Class c = BookStore.class;
        // 2.或去指定方法对象
        Method m = c.getDeclaredMethod("test");
        // 3.判断方法上是否存在注解
        if (m.isAnnotationPresent(Book.class)) {
            // 4.获取注解
            Book book = m.getDeclaredAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.author()));
        }

    }
}