注解的使用和具体案例

文章目录

      • 1.注解概念
      • 2.Java自带的注解
      • 3.注解类(接口)
      • 4.枚举类ElementType(与@Target使用)
      • 5.枚举类RetentionPolicy(与@Retention使用)
      • 6.自定义注解(注解的使用案例:)

1.注解概念

Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,
Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌
入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容
 。 当然它也支持自定义 Java 标注。

2.Java自带的注解

@Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。

@Deprecated - 标记过时方法。如果使用该方法,会报编译警告。

@SuppressWarnings - 指示编译器去忽略注解中声明的警告。
作用在其他注解的注解(或者说 元注解)是:

@Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。

@Documented - 标记这些注解是否包含在用户文档中。

@Target - 标记这个注解应该是哪种 Java 成员。

@Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
从 Java 7 ,额外添加了 3 个注解:

@SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

@FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。

@Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

3.注解类(接口)

//注解的本质其实是一个接口

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

4.枚举类ElementType(与@Target使用)

//定义注解作用的位置是类还是其他部位
package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口(包括注释类型)或枚举声明  */

    FIELD,              /* 字段声明(包括枚举常量)  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

5.枚举类RetentionPolicy(与@Retention使用)

//定义注解的有效范围:存在于编译器/ 类对应的class文件/ 运行时,且能被JVM读取

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中,并且可由JVM读入 */
}

6.自定义注解(注解的使用案例:)

1.用用注解对实体操作,实体在数据库中为表,有列有行
创建Table接口,作用于类

  /**
 * @Description:
 * @Author one world
 * @Date 2020/8/14 0014 11:00
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
    String value() default "";
}

2.创建Coulmn接口,作用于属性

  @Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Coulmn {
    String value() default "";
}

3.以学生成绩表为例,加上我们自定义的注解

/**
 * @Description:
 * @Author one world
 * @Date 2020/8/14 0014 11:04
 */
@Table("grades")
public class Grade {
   private int id;

   @Coulmn("name")
   private String name;
   @Coulmn("grade")
   private String grade;

    public String getGrade() {
        return grade;
    }

    public void setGrade(String grade) {
        this.grade = grade;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

4.测试注解:

public class TestAnno {
    public static void main(String[] args) {
        Class clazz = Grade.class;
        getCoulmn(clazz);

    }
    public static void getCoulmn(Class clazz){
        Field[] fields=clazz.getDeclaredFields();
        String name = "";
        if(clazz.isAnnotationPresent(Table.class)){
        //Table注解你就当他是一个类用就行了 获取本类中Table注解
            Table table = (Table)clazz.getAnnotation(Table.class);
            //table.value()相当于方法的调用
            System.out.println("类注解为:"+table.value());
        }else{
            System.out.println("类没有注解");
        }
        for(Field field:fields){
        //判断属性前有无注解
            if(field.isAnnotationPresent(Coulmn.class)){
            //获取带Coulmn注解的
                Coulmn coulmn = field.getAnnotation(Coulmn.class);
                //得到值
                 name = coulmn.value();
                System.out.println("带注解的列:"+name);

            }else{
                System.out.println("未带注解的列:"+field.getName());
            }
        }
    }
}

5.结果输出:
注解的使用和具体案例_第1张图片
这里的话,主要是为了后面对DAO中查询方式以泛型+反射+注解的方式来封装查询实体,简化代码。

你可能感兴趣的:(Java基础)