Offer来了:Java面试核心知识点精讲(原理篇)
上QQ阅读APP看本书,新人免费读10天
设备和账号都新为新人

2.4 注解

2.4.1 注解的概念

注解(Annotation)是Java提供的设置程序中元素的关联信息和元数据(MetaData)的方法,它是一个接口,程序可以通过反射获取指定程序中元素的注解对象,然后通过该注解对象获取注解中的元数据信息。

2.4.2 标准元注解:@Target、@Retention、@Documented、@Inherited

元注解(Meta-Annotation)负责注解其他注解。在Java中定义了4个标准的元注解类型@Target、@Retention、@Documented、@Inherited,用于定义不同类型的注解。

(1)@Target:@Target说明了注解所修饰的对象范围。注解可被用于packages、types(类、接口、枚举、注解类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(循环变量、catch参数等)。在注解类型的声明中使用了target,可更加明确其修饰的目标,target的具体取值类型如表2-1所示。

表2-1

(2)@Retention:@Retention定义了该注解被保留的级别,即被描述的注解在什么级别有效,有以下3种类型。

◎ SOURCE:在源文件中有效,即在源文件中被保留。

◎ CLASS:在Class文件中有效,即在Class文件中被保留。

◎ RUNTIME:在运行时有效,即在运行时被保留。

(3)@Documented:@Documented表明这个注解应该被javadoc工具记录,因此可以被javadoc类的工具文档化。

(4)@Inherited:@Inherited是一个标记注解,表明某个被标注的类型是被继承的。如果有一个使用了@Inherited修饰的Annotation被用于一个Class,则这个注解将被用于该Class的子类。

2.4.3 注解处理器

注解用于描述元数据的信息,使用的重点在于对注解处理器的定义。Java SE5扩展了反射机制的API,以帮助程序快速构造自定义注解处理器。对注解的使用一般包含定义及使用注解接口,我们一般通过封装统一的注解工具来使用注解。

1.定义注解接口

下面的代码定义了一个FruitProvider注解接口,其中有name和address两个属性:

//1:定义注解接口
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public  @interface  FruitProvider  {
 //供应商编号
 public  int  id()  default  -1;
 //供应商名称
 public String name() default "";
 //供应商地址
 public  String  address()  default  "";
}

2.使用注解接口

下面的代码定义了一个Apple类,并通过注解方式定义了一个FruitProvider:

public  class  Apple  {
  //2:使用注解接口
    @FruitProvider(id = 1, name = "陕西红富士集团", address = "陕西省西安市")
    private  String  appleProvider;
    public  void  setAppleProvider(String  appleProvider)  {
      this.appleProvider  =  appleProvider;
    }
    public  String  getAppleProvider()  {
      return  appleProvider;
    }
}

3.定义注解处理器

下面的代码定义了一个FruitInfoUtil注解处理器,并通过反射信息获取注解数据,最后通过main方法调用该注解处理器使用注解:

//3:定义注解处理器
public  class  FruitInfoUtil  {
    public  static  void  getFruitInfo(Class<? >  clazz)  {
      String strFruitProvicer = "供应商信息:";
      Field[] fields = clazz.getDeclaredFields(); //通过反射获取处理注解
      for  (Field  field  :  fields)  {
          if  (field.isAnnotationPresent(FruitProvider.class))  {
                FruitProvider  fruitProvider  =  (FruitProvider)
                          field.getAnnotation(FruitProvider.class);
                    //处理注解信息
              strFruitProvicer = " 供应商编号:" + fruitProvider.id() +
                    " 供应商名称:"+ fruitProvider.name() + " 供应商地址:"+
                      fruitProvider.address();
            System.out.println(strFruitProvicer);
          }
      }
  }
}
public  class  FruitRun  {
  public  static  void  main(String[]  args)  {
      FruitInfoUtil.getFruitInfo(Apple.class);
        //输出结果为:供应商编号:1 供应商名称:陕西红富士集团 供应商地址:陕西省西安市
  }
}