自定义Annotation(二)
  TEZNKK3IfmPf 2023年11月15日 42 0

注解Annotation 很强大,很重要,是不是想要自己能够编写注解呢?

接下来,我们就可以尝试编写简单的注解了。

本文参考菜鸟编程文章: Java 注解(Annotation)

一.一 主要三大类

一.一.一 注解类 Annotation

package java.lang.annotation;

/**
 * @since   1.5
 */
public interface Annotation {
   
    boolean equals(Object obj);

  
    int hashCode();

     toString();

    Class<? extends Annotation> annotationType();
}

是最原始的那个注解类。

一.一.二 作用类型 ElementType

package java.lang.annotation;

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

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

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

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

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

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

    PACKAGE             /* 包声明  */
}

是一个枚举,定义 注解的放置范围。

一.一.三 保留策略 RetentionPolicy

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

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

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

一.二 架构图

自定义Annotation(二)

Annotation 与 RetentionPolicy 是一对一的关系,与 ElementType 是一对多的关系。

Override,Deprecated 等都是 Annotation的子类。

一.三 内置子类作用

(引用于菜鸟编程)

Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

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

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

  • @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

作用在其他注解的注解(或者说 元注解)是:

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

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

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

  • @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

老蝴蝶注:这个在创建新的注解时,非常有用。

从 Java 7 开始,额外添加了 3 个注解:

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

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

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

老蝴蝶注:函数式编程时用的。

二. 创建简单注解 @interface

创建注解,就像创建类,接口一样简单,只不是 类是 Class, 接口是 interface, 而注解是 @interface.
注意,是小写,前面有一个 @

注解里面,只有属性, 没有方法。 @interface 就表示实现了 java.lang.annotation.Annotation 接口。

二.一 创建简单的注解

创建表 注解 Table

//创建表注解 
public @interface Table {


}

创建 Id 主键注解

public @interface Id {
    
}

创建 Column 列注解

public @interface Column {


}

在使用的时候, @Table, @Id, @Column 即可。

二.二 使用 注解

先创建一个简单的pojo, Person ,里面有 id,name,sex,age,desc 五个基本的属性, 并且有相应的构造和 setter,getter方法。

@Table
public class Person implements Serializable {

    @Id
    private int id;
    @Column
    private  String name;
    @Column
    private  char sex;
    @Column
    private int age;
    @Column
    private String desc;

}

三. 添加元注解,表明注解的位置

可以添加四个元注解, @Retention, @Documented, @Target, @Inherited

可以用这四个元注解,来为自定义的新注解添加功能。

三.一 @Target

表示可以定义的范围, 具体看 枚举 ElementType 的取值。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    
    ElementType[] value();
}

如 想使 @Table 只能放置在 类上面,不能放置在方法或者属性上面。

@Target(ElementType.TYPE) //只能放置在类上
public @interface Table {


}

那么,当将 @Table 放置在属性,或者方法上时,就会出错。

自定义Annotation(二)

@Id 和 @Column 定义在属性上面。

@Target(ElementType.FIELD)
public @interface Id {

}
@Target(ElementType.FIELD)
public @interface Column {


}

当然, 范围可以定义多个, 用数组传递即可。

@Target({ElementType.METHOD,ElementType.FIELD})
public @interface Name {
    
}

可以放置在 方法上面,也可以放置在属性上面 。

三.二 @Retention

定义保存的范围。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}

用户自定义的,建议使用 RUNTIME

@Target(ElementType.TYPE) //只能放置在类上
@Retention(RetentionPolicy.RUNTIME) //jvm虚拟机可以载入
public @interface Table {


}

三.三 @Documented

是否生成文档

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

用户自定义的,建议添加 @Documented, 默认不添加 。

三.四 @Inherited

是否继承

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {

}

不建议添加继承。

一般在自定义的注释上面,添加 @Documented, @Target, @Retention 三个元注解即可。

四. 添加属性

注解,里面的是格式是: 数据类型 属性值

属性值,可以有一个,也可以有多个,也可以是数组形式, 可以添加默认值。

如果属性只有一个的话, 均采用 value 属性。 规定,如果一个注解只有一个属性值,并且该属性值为 value 的话,那么可以省略 value属性。

如果属性没有默认值,那么必须提供该属性的值。

四.一 添加一个属性值

@Target(ElementType.TYPE) //只能放置在类上
@Retention(RetentionPolicy.RUNTIME) //jvm虚拟机可以载入
@Documented
@Inherited
public @interface Table {

    //添加一个属性值, 表名 
    String tableName();

}

应用到 Person 上面

@Table(tableName="person")
public class Person implements Serializable {

}

四.二 添加多个属性值

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME) //jvm虚拟机可以载入
@Documented
public @interface Column {

    //列名
    String name();
    //长度
    int length();

}

应用到 Person 上面

@Column(name = "name",length = 50)
    private  String name;

四.三 添加默认值

用 default 默认值 即可。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME) //jvm虚拟机可以载入
@Documented
public @interface Id {

    //默认列名是 id
    String name() default "id";

    //默认长度是 11 int 类型 
    int length() default 11;
}

应用到 Person 上面

@Id
 private int id;

四.四 添加数组类型

@Target({ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME) //jvm虚拟机可以载入
@Documented
public @interface Name {

    //填入值,数组形式
    String[] value() default {"两个蝴蝶飞"};
    //注入
    String comment() default "一个快乐的程序员";
}

一个自定义的注解, 只有添加了作用范围和 属性值,才算比较完整,才可以使用。

一定要掌握创建注解的流程, 先创建基本的,再添加作用范围,后添加属性。

【版权声明】本文内容来自摩杜云社区用户原创、第三方投稿、转载,内容版权归原作者所有。本网站的目的在于传递更多信息,不拥有版权,亦不承担相应法律责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@moduyun.com

  1. 分享:
最后一次编辑于 2023年11月15日 0

暂无评论

TEZNKK3IfmPf