Java注解(annotation)自定义及应用

时间:2021-07-11 05:48:26

1.注解的理解

  注解相当于一种标记,程序在运行的某个阶段通过获取这个标记中的内容,来让程序执行不同的事情。如果注解加到一个我们自己定义的类上,并达不到某种特定的效果,那么该注解是没有意义的。

2.元注解

  Target 注解标注的地方

  Documented 注解表明这个注解应该被 javadoc工具记录. 默认情况下,javadoc是不包括注解的. 但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中

  Retention 声明的注解处于何种范围中

  Inherited 子类中将获取父类上的注解

3.ElementType

  TYPE(类,接口,注解,枚举)
  FIELD(属性)
  METHOD(方法)
  PARAMETER(参数)
  CONSTRUCTOR(构造器)
  LOCAL_VARIABLE(局部变量)
  ANNOTATION_TYPE(注解类型)
  PACKAGE(包)

  ElementType表示注解标注到java对象的那一个层级上。

4.RetentionPoicy

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

  (1).RetentionPolicy.SOURCE:声明注解只保留在 Java 源程序中,在编译 Java 类时注解信息不会被写入到 Class。
  (2).RetentionPolicy.CLASS:声明注解仅保留在 Class 文件中,JVM 运行时并不会处理它,通过Class 反射无法获取到注解信息。
  (3).RetentionPolicy.RUNTIME:这是最常用的一种声明,Java 反射也可以取得注解的信息。所有用到反射获取的注解都会用到这个配置。

5.自定义注解

  自定义一个注解Action,其使用的关键字为@interface。以下只演示注解到(类,注解,接口或者枚举的情况)

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Action {
    String value() default "";
}

使用注解:

@Action("userAction")
public class UserAction {

}

6.获取注解信息

@Test
public void annotationTest(){
    Class<?> clazz = UserAction.class;
    Action action = clazz.getAnnotation(Action.class) ;
    String value = action.value();
    System.out.println(value);
}

结果输出:userAction,注意凡是通过反射获取注解信息的,一定要Retention为RUNTIME。注解以及反射的应用先写到这里。回家吃饭了!