java 注解简述

潇洒

发布于 2023-10-20 09:50:00

1550

发布于 2023-10-20 09:50:00

文章被收录于专栏：石头岛

前言

注解(annotation)相当于一个运行于内存当中的自定义类型的数据存储区域，理解以后才发现它的好用，就是数据存储区，相当于一个运行在内存当中的XML，所有的注解数据在JDK加载完类以后，就可以被使用。

JDK内置注解

三个基本内置注解： 1.@override 2.@Deprecated //加在类或方法上，标注为过时 3.@SuppressWarnings //制编译器

元注解 MetaData

元注解使用和创建注解的方式，让自己可以创建自己的注解。元数据/元注解作用：就是负责注解其他注解。 Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation 类型作说明。

Java5.0定义的元注解： @Documented 标记生成javadoc @Inherited 标记继承关系 @Retention 注解的生存期 @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声明

示例

@Target(ElementType.TYPE)
public @interface MyAnnotation {
  /**
    * 数据表名称注解，默认值为类名称
    * @return
    */
  public String tableName() default "className";
}

@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的枚举类型值。

//测试时不能自动引入，所以放在这里
import java.lang.annotation.RetentionPolicy;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
  public String name() default "fieldName";
  public String setFuncName() default "setField";
  public String getFuncName() default "getField";
  public boolean defaultDBValue() default false;
}

这里RetentionPolicy的属性值是RUTIME，这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理。

注意，不可以省略不写 Retention，否则会出现拿不到注解的情况，测试中，忘了写 RUNTIME 结果怎么都是 null。所以如果默认不写应该不是 RUNTIME 的。下次再写时可以测试一下不写的情况。

测试代码

测试只测试了成员变量的测解，还城需要对参数，方法进行测试。

添加注解

/**
 * Created by liukai on 2016/7/12.
 * 用于 成员属性中的注解
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
//测试中忘了添加这 RUNTIME，默认是public
@interface FieldAnnotion {
  String fileName() default "";
}

测试类：

public static void test2() {
  Class<User> userClass = User.class;
  Field[] fields = userClass.getDeclaredFields();
  System.out.println(fields.length);
  if (fields != null && fields.length > 0) {
    for (Field field : fields) {
      FieldAnnotion annotation = field.getAnnotation(FieldAnnotion.class);
      System.out.println(annotation.fileName());
    }
  }
}

实体类

public class User {

  @FieldAnnotion(fileName = "user_name")      //通过注解设置
  private String name;

  @FieldAnnotion(fileName = "age")      //通过注解设置
  private Integer age;

  @FieldAnnotion(fileName = "address")      //通过注解设置
  private String address;

  setter/getter...
}

@Documented

添加这个注解后，用到这个注解的程序可以被添加到javadoc中成为公共API。

@Target(ElementType.TYPE)
@Documented
public @interface MyAnnotation {
}

@Inherited

是一种标记注解。阐述了某个被注解的类型是被继承的。如果使用了@Inherited的注解类型被用于一个类，则这个注解将被用于该类的子类。条件： 1.注解于接口中，无效。 2.只能放在父类的类头中，放在父类的方法中无效，子类无法继承。

自定义注解 @interface

注解的作用是可以利用反射来获取数据

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式： public @interface 注解名 {定义体}

注解参数的可支持数据类型：

1.所有基本数据类型（int,float,boolean,byte,double,char,long,short) 2.String类型 3.Class类型 4.enum类型 5.Annotation类型 6.以上所有类型的数组

Annotation类型里面的参数该怎么设定: 第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

使用注解

通过反射获取注解中的值特别注意：每个注解，可以设置给不给默认值，如果注解中有 default 值的话，则在使用时可以不需要给注解赋;如果没有设置默认值，则一定要在对象是设置注解的值，否则一运行就报错。

1.定义一个自定义注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
  public String name() default "testing...";
  int id();                //default 可以不写修饰符
 }

解释： ElemengType.TYPE 元素类型，其实就是成员变量，JDK 的API中也称做元素注意。特别注意 id 这个注解在对象的成员变量上使用的时候，一定要设置值，因为，上面代码中没有设置默认值，运行会报错。可以通过设置默认值来避免。

2.反射来获取注解的数据

@MyAnnotation(id = 22)
//name有默认值，可写可不写，id没有默认值，一定要赋值。
public class TestMain {
  public static void main(String[] args) {
    Class<TestMain> clazz = TestMain.class;
    MyAnnotation ma = clazz.getAnnotation(MyAnnotation.class);
    System.out.println(ma.name());
    System.out.println(ma.id());
    }
}

结果： testing... 22

注意，如果不在TestMain中设值id=22 直接在注解接口中给id一个默认也是一样可以的。