JAVA 注解校验 java test注解

转载

IT智行领袖 2023-07-27 12:52:50

文章标签 JAVA 注解校验 java 学习 System 成员变量 文章分类 Java 后端开发

注解概述

自定义注解

元注解

注解解析

注解概述

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

注解的作用

对Java中类、方法、成员变量做标记，然后进行特殊处理。

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

自定义注解

自定义注解 --- 格式：自定义注解就是自己做一个注解来使用。

格式和具体使用如下：

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

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

//标记类
@Mybook(name="《JAVA核心卷一1》",authors = {"aaa", "bbb"}, price = 30.65)
public class Test1 {
    //标记构造类型
    @Mybook(name="《JAVA核心卷一2》",authors = {"aaa", "bbb"}, price = 30.65)
    private Test1(){

    }
    //标记方法
    @Mybook(name="《JAVA核心卷一3》",authors = {"aaa", "bbb"}, price = 30.65)
    public static void main(String[] args) {

    }
}

注解只有一个字段（属性value），名字value可省略不写：如下代码

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

@Book("《JAVA核心卷一1》")
public class Test2 {
    //标记构造方法
    @Book("《JAVA核心卷一2》")
    private Test2(){
    }
}

元注解

元注解：注解注解的注解。

常用的元注解有两个：

1.@Target: 约束自定义注解只能在哪些地方使用，标记范围

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

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

2.@Retention：申明注解的生命周期，存活范围

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

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

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

@Retention(RetentionPolicy.RUNTIME) //元注解：注解注解的注解   不会消失，一直存在
@Target({ElementType.METHOD, ElementType.FIELD})    //元注解---Mytest只能注解方法和成员变量
public @interface Mytest {
}

//@Mytest   会错误，因为只能注解成员变量和方法
public class Test3 {
    @Mytest
    private String name;
    //@Mytest   会错误，因为只能注解成员变量和方法
    public Test3(){}
    @Mytest
    public String getName() {
        return name;
    }
    @Mytest
    public void setName(String name) {
        this.name = name;
    }
}

注解解析

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

相关的接口：

Annotation: 注解的顶级接口，注解都是Annotation类型的对象

AnnotatedElement：该接口定义了与注解解析相关的解析方法

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

注解解析的方法如下表

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

实例如下：

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

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface Boook {
    String name();
    double price() default 99.9;
    String[] author();
}

@Boook(name = "我爱JAVA1", author = {"aaa", "bbb"}, price = 30.65)
public class Test4 {

    @Boook(name = "我爱JAVA2", author = {"AAA", "BBB"}, price = 30.65)
    public void test(){

    }
}

import java.lang.reflect.Method;
import java.util.Arrays;

public class Test5 {
    public void parseClass() throws NoSuchMethodException {
        //1.获取类对象
        Class c = Test4.class;
        //2.判断这个类上面是否存在这个注解
        if(c.isAnnotationPresent(Boook.class)){
            //3.获取该注解对象
            Boook book = (Boook) c.getDeclaredAnnotation(Boook.class);
            System.out.println("----类------");
            System.out.println("书名："+book.name());
            System.out.println("价格："+book.price());
            System.out.println("作者："+Arrays.toString(book.author()));
        }
        Method method = c.getDeclaredMethod("test");
        if(method.isAnnotationPresent(Boook.class)){
            //3.获取该注解对象
            Boook book = (Boook) method.getDeclaredAnnotation(Boook.class);
            System.out.println("----方法------");
            System.out.println("书名："+book.name());
            System.out.println("价格："+book.price());
            System.out.println("作者："+Arrays.toString(book.author()));
        }
    }

    public static void main(String[] args) throws NoSuchMethodException {
        Test5 t = new Test5();
        t.parseClass();
    }
}

JAVA 注解校验 java test注解_JAVA 注解校验