Java java.lang.reflect.Field.getAnnotation()用法及代码示例

描述

这个java.lang.reflect.Field.getAnnotation(Class<T> annotationClass)如果存在这样的注释，则方法返回此元素的指定类型的注释，否则为 null。

声明

以下是声明java.lang.reflect.Field.getAnnotation(Class<T> annotationClass)方法。

public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

参数

annotationClass− 注释类型对应的 Class 对象。

返回

如果此元素上存在指定注释类型的此元素的注释，否则为 null。

异常

NullPointerException- 如果给定的注释类为空。

示例

下面的例子展示了 java.lang.reflect.Field.getAnnotation(Class<T> annotationClass) 方法的用法。

package com.tutorialspoint;

import java.lang.annotation.Annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Field;

public class FieldDemo {

   public static void main(String[] args) throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
      Field field = SampleClass.class.getField("sampleField");
      Annotation annotation = field.getAnnotation(CustomAnnotation.class);
      if(annotation instanceof CustomAnnotation){
         CustomAnnotation customAnnotation = (CustomAnnotation) annotation;
         System.out.println("name:" + customAnnotation.name());
         System.out.println("value:" + customAnnotation.value());
      }
   }
}

@CustomAnnotation(name = "SampleClass",  value = "Sample Class Annotation")
class SampleClass {

   @CustomAnnotation(name="sampleClassField",  value = "Sample Field Annotation")
   public String sampleField;
    
   public String getSampleField() {
      return sampleField;
   }

   public void setSampleField(String sampleField) {
      this.sampleField = sampleField;
   }
}

@Retention(RetentionPolicy.RUNTIME)
@interface CustomAnnotation {
   public String name();
   public String value();
}

让我们编译并运行上面的程序，这将产生以下结果 -

name:sampleClassField
value:Sample Field Annotation