java —— 全面解析 Annotation

一、什么是注解?

  Java 中这样定义:java 提供了一种源程序中元素关联任何信息和任何元数据的途径和方法,也就是说注解不会响程序代码的执行,无论增加、删除 Annotation,代码都始终如一的执行,注解只是多出了一种数据的配置,依靠程序通过反射的方式获取注解中的数据。

  在 java 编程中我们经常会看到如下代码:

  JDK 中常见的注解:

  Mybatis 框架使用注解方式实现的 CRUD 数据库操作: 

  上图中被红框标注的就是注解及使用。

二、注解的分类 

  1、按照运行机制分为
  源码注解:注解只在源码中存在,编译成.class文件就不存在了
  编译时注解:注解在源码和.class文件中都存在(如:JDK内置系统注解)
  运行时注解:在运行阶段还起作用,甚至会影响运行逻辑的注解(如:Spring中@Autowried)

  2、按照来源分为
  JDK内置注解、元注解、自定义注解、第三方注解

  3、元注解:注解的注解,也就是定义注解时,java 程序给出的标准(这个标准也是注解)。

三、自定义注解

  1、自定义注解的语法要求

  (1)自定义注解的通用模板  

    

  (2)成员

  成员类型是受限的,合法的类型包括基本数据类型及String,Calss,Anootation,Enumreation 还有以上所有类型的数组

  如果注解已有一个成员,则成员名必须取名为Vaue(),在使用的时可以忽略成员名和赋值号(=)

  注解类可以没有成员,没有成员的注解成为表示注解

  (3)元注解

    @Target({ElementType.METHOD,ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    @Documented

java 给出的元注解的属性说明   


@Target:

    

   @Target 说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

  作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

  取值(ElementType)有:

    1.CONSTRUCTOR:用于描述构造器
    2.FIELD:用于描述域
    3.LOCAL_VARIABLE:用于描述局部变量
    4.METHOD:用于描述方法
    5.PACKAGE:用于描述包
    6.PARAMETER:用于描述参数
    7.TYPE:用于描述类、接口(包括注解类型) 或enum声明


@Retention:

  @Retention 定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

  作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

  取值(RetentionPoicy)有:

    1.SOURCE:在源文件中有效(即源文件保留)
    2.CLASS:在class文件中有效(即class保留)
    3.RUNTIME:在运行时有效(即运行时保留)

  Retention meta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。


 @Inherited:

  @Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

  注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

  当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。


@Documented:

  @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。


 四、自定义注解实践

   注解是不会改变程序运行方式,获取注解的数据是通过 java 的反射机制。我们都知道通过反射得到类的类类型Class对象我们可以获得类的属性对象(Filed)、构造函数对象(Constructor)、方法对象(Method),不例外也可以获得注释对象(Annotation)。

  备注:Class 类实现了 java.lang.reflect.AnnotatedElement 接口——注解处理器类库

 <T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解,如果该类型注解不存在,则返回null。
 Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
 boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false.
 Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。(如果没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响。 

   简单的注解数据操作:数据表(user)的字段和对应的实体类(Test)成员属性不同,现在要通过注解的方式生成正确的 sql 语句。

  数据库表  USER 字段:user_id  ,  user_name ,user_age,user_address

  定义注解 Table  (实现表名与类名对应)

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Table {
    String value();
}

  定义注解 Column (实现字段与属性对应)

/**Target 注解的作用域  :
 *  CONSTRUCTOR 构造方法声明,FIELD 字段声明,
 *  LOCAL_VARIABLE 局部变量声明 ,
 *  METHOD 方法声明,PACKAGE 包声明,
 *  PARAMETER 参数声明,TYPE 类接口。
 *  
 *  
 *  Retention  生命周期 
 *  SOURCE 只在源码显示,编译时会丢弃,
 *  CLASS 编译时会记录到class中,运行时忽略,
 *  RUNTIME 运行时存在,可以通过反射读取。
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Column {
    
    String value();

}

  使用注解的实体类Test

@Table("user")
public class Test {
    
    @Column("user_id")
    private int id;
    @Column("user_name")
    private String name;
    @Column("user_age")
    private int age;
    @Column("user_address")
    private String address;
    

    public Test(int id, String name, int age, String address) {
        super();
        this.id = id;
        this.name = name;
        this.age = age;
        this.address = address;
    }
    
    public Test(){}

    @Override
    public String toString() {
        return "Test [id=" + id + ", name=" + name + ", age=" + age
                + ", address=" + address + "]";
    }

    public String getVaule(){
        return "( "+ id+ ",'"+ name + "',"+age + ",'"+address + "')";
    }

    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;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }


}
Test

  实现 insert sql 语句过程如下:

import java.lang.reflect.Field;
public class TestSelfAnnotation {
    @SuppressWarnings({ "unchecked", "rawtypes" })
    public static void main(String[] args) {
        Test t = new Test(1212,"彩色",12,"家庭地址");
        Class cls = t.getClass();//得到Test 类的 Class 类
        StringBuffer sb = new StringBuffer(); //方便字符串拼接
        sb.append("insert into  ");
        if(cls.isAnnotationPresent(Table.class)){//判断类是否有这种注解(Table)
            //得到该注解的对象
            Table table =(Table) cls.getAnnotation(Table.class);
            String tableName = table.value();//得到 table value的数据
            sb.append(tableName + "(");
            Field [] fields = cls.getDeclaredFields();//得到当前类的所有成员属性
            for (Field field : fields) {
                field.setAccessible(true);//得到非公开属性的访问权限=>public 
                if(field.isAnnotationPresent(Column.class)){//判断属性是否有该类型的注解
                    Column c = field.getAnnotation(Column.class);
                    sb.append(c.value()+",");
                }
            }
            sb.substring(0,sb.length()-1);
            sb.append(") value ").append(t.getVaule());
            System.out.println(sb.toString());
        }
    }
}
输出结果:insert into  user(user_id,user_name,user_age,user_address,) value ( 1212,'彩色',12,'家庭地址')

annotation 需要理解:

原文地址:https://www.cnblogs.com/SacredOdysseyHD/p/8409832.html