欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Java之注解详解

程序员文章站 2023-11-05 11:44:16
Java-注解文章目录Java-注解一、定义1.1 作用二、预定义注解三、自定义注解3.1 格式3.2 本质3.3 注解内的属性3.4 元注解四、注解解析一、定义注解(Annotation),也叫元数据。一种代码级别的说明。JDK1.5之后引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。1.1 作用①编写文档:通过代码里标识的注解生成文档【生成文档doc文档】②代码分析:通过代码里标识的注解对代码进行分析...

Java-注解

一、定义

注解(Annotation),也叫元数据。一种代码级别的说明。JDK1.5之后引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。

1.1 作用

  • 编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
  • 代码分析:通过代码里标识的注解对代码进行分析【使用反射】
  • 编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

二、预定义注解

jdk内置的一些注解

名称 作用
@Override 检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated 该注解标注的内容,表示已过时
@SuppressWarnings 压制警告
传递参数all @SuppressWarnings("all"),表示压制所有警告
@SafeVarargs 断言声明的构造函数和方法的主体不会对其varargs参数执行潜在的不安全的操作
@FunctionalInterface 用于接口上,表明该接口是一个函数式接口

三、自定义注解

3.1 格式

元注解
public @interface 注解名称{
	属性列表;
}

3.2 本质

对下面自定义注解的class文件反编译

public @interface MyAnno {
    String show1();  // String类型
    int show2();  // 基本数据类型
    MyAnno2 an2(); // 自定义的注解类型
    Season sea(); // 枚举类型
}

反编译后可发现,MyAnno继承了java.lang.annotation.Annotation接口。所以注解本质上是一个接口

//字节码反编译后
public abstract interface MyAnno implements Annotation {
     <ClassVersion=52>
     <SourceFile=MyAnno.java>

     public abstract show1() {} //()Ljava/lang/String;

     public abstract show2() {} //()I

     public abstract an2() {} //()Lanno/MyAnno2;

     public abstract sea() {} //()Lanno/Season; 返回类型--枚举类型
}

3.3 注解内的属性

就是接口中的抽象方法

  1. 属性的返回值类型
    • 基本数据类型,String,枚举,注解,以上类型的一维数组
  2. 定义了属性,使用时需要给属性赋值
    1. 使用default关键字给属性默认初始化值,使用注解时,可以不进行属性的赋值。
    2. 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。
    3. 数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略

自定义注解示例:

  1. 注解内属性允许的属性
public @interface MyAnno {
    String show1();  // String类型
    int show2();  // 基本数据类型
    MyAnno2 an2(); // 注解类型
    Season sea(); // 枚举类型
}

// 枚举类
public enum Season {
    Spring,Summer,Winter,Auto;
}
  1. 带默认值的注解属性
public @interface MyAnno3 {
    String name();
    int age() default 12;  // 带默认值的属性
}
  1. 注解中只有一个属性,并且名称为value
public @interface MyAnno4 {
    String value();
}

使用示例:

@SuppressWarnings("all")  // 忽略所有警告
public class Demo1 {

    @Override  // 表示对父类方法的重写
    public String toString() {
        return "Demo1{}";
    }

    @Deprecated  // 表明该方法已过时
    public void show1(){
   		// ...
    }

    @SuppressWarnings("all") // 忽略该方法的警告
    public void show2(){
        //新方法,替代show1
    }

    @MyAnno3(name = "Yau")
    public void demo1(){
        //调用show1,显示删除线
        show1();
    }

    @MyAnno4("hhhh")
    public void testAnno4(){
        //如果注解里面只要一个属性,并且名字叫valua,那么可以省略不写
    }

    @MyAnno(show1 = "Yangg",show2 = 3,an2 = @MyAnno2,sea = Season.Spring)
    public void testAnno(){
    }
}

3.4 元注解

概念:元注解是用于描述注解的注解

名称 作用
@Target 表示该注解能够作用的范围,它的取值有:
ElementType.TYPE:作用于
ElementType.METHOD:作用于方法
ElementType.FIELD:作用于成员变量
上面是比较常用的几个
@Retention 表示该注解被保留的阶段,它的取值有:
RetentionPolicy.RUNTIME:注解会保留到class字节码文件中,并被JVM读取到
RetentionPolicy.CLASS:注解保留到编译期
RetentionPolicy.SOURCE 注解只在源码阶段保留
@Documented 表示该该注解是否被抽取到api文档中
@Inherited 表示该注解是否被子类继承

使用示例:

/**
 元注解:用于描述注解的注解
   -- @Target:描述注解能够作用的位置
   -- @Retention:描述注解被保留的阶段
   -- @Documented:描述注解是否被抽取到api文档中
   -- @Inherited:描述注解是否被子类继承
 */
//ElementType.TYPE:表示该注解只能作用于类上
@Target(value = {ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(value = RetentionPolicy.RUNTIME)
public @interface YuanAnno {
    String value();
}

四、注解解析

功能:获取注解中定义的属性值

步骤:

  1. 获取注解定义的位置的对象 (例如:Class,Method,Field)

  2. 获取指定的注解(xxx.getAnnotation(注解.class),参数是该注解的Class对象

  3. 调用注解中的抽象方法获取配置的属性值

示例:通过注解执行Dog类的eatFood方法

//实体类
public class Dog {
    public void eatFood(){
        System.out.println("eat....");
    }
}
//自定义注解类
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    //定义类和方法名
    String className();
    String methodName();
}
//测试类
@Pro(className = "anno.an2.Dog",methodName = "eatFood")
public class Test {

    public static void main(String[] args) throws Exception{

        //1.获取该类的字节码文件
        Class<Test> testClass = Test.class;

        //2.获取该类上的注解对象。通过Class对象
        //如果想要获取方法上的注解,可以通过Method对象获取
        Pro anno = testClass.getAnnotation(Pro.class);

        //3.调用注解对象上的抽象方法,获取返回值
        String className = anno.className();
        String methodName = anno.methodName();

        System.out.println(className+"---"+methodName);

        //4.利用反射执行该类方法
        Class<?> DaoClass = Class.forName(className);
        //4.1获取对象
        Object dogObj = DaoClass.newInstance();

        //4.2.获取方法
        Method method = DaoClass.getMethod(methodName);
        //4.3执行方法
        method.invoke(dogObj);
    }
}

本文地址:https://blog.csdn.net/qq_42701294/article/details/107081770