Java自定义注解并通过反射读取

柔情只为你懂 2023-06-21 08:49 13阅读 0赞

### Java自定义注解并通过反射读取 ###

*  自定义注解
 *  元注解
 *   *  @Target
     *  @Retention
 *  使用反射机制读取注解信息

# 自定义注解 #

1.  使用@interface自定义注解，自动继承了java.lang.annotation接口
2.  格式为：
    
     *  public @interface 注解名 \{定义体\}
     *  其中的每个方法实际上是声明了一个配置参数
     *  方法的名称就是参数的名称
     *  返回值的参数就是参数的类型（返回值类型只能是基本类型、Class、String、enum）
     *  可以通过default来声明参数的默认值。
     *  如果只有一个参数成员，一般参数名为value
3.  注意：注解元素必须要有值。我们定义注解元素时，经常使用空字符串、0作为默认值。 也经常使用负数(比如：-1)表示不存在的含义

# 元注解 #

1.  元注解的作用就是负责注解其他注解。Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明。
2.  这些类型和它们所支持的类在java.lang.annotation包中可以 找到

*  @Target
 *  @Retention
 *  @Documented
 *  @Inherited

## @Target ##

1.  作用：用于描述注解的使用范围（即:被描述的注解可以用在什么地方）

<table> 
 <thead> 
  <tr> 
   <th>所修饰范围</th> 
   <th>取值ElementType</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>package 包</td> 
   <td>PACKAGE</td> 
  </tr> 
  <tr> 
   <td>类、接口、枚举、Annotation类型</td> 
   <td>TYPE</td> 
  </tr> 
  <tr> 
   <td>类型成员（方法、构造方法、成员变量、枚举值）</td> 
   <td>CONSTRUCTOR：用于描述构造器<br>FIELD：用于描述域<br>METHOD：用于描述方法</td> 
  </tr> 
  <tr> 
   <td>方法参数和本地变量</td> 
   <td>LOCAL_VARIABLE:用于描述局部变量<br>PARAMETER:用于描述参数</td> 
  </tr> 
 </tbody> 
</table>

1.  例如：@Target(value=ElementType.TYPE)

## @Retention ##

1.  作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期

<table> 
 <thead> 
  <tr> 
   <th>取值RetentionPolicy</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SOURCE</td> 
   <td>在源文件中有效（即源文件保留）</td> 
  </tr> 
  <tr> 
   <td>CLASS</td> 
   <td>在class文件中有效（即class保留）</td> 
  </tr> 
  <tr> 
   <td>RUNTIME</td> 
   <td>在运行时有效（即运行时保留）<br>为Runtieme可以被反射机制读取</td> 
  </tr> 
 </tbody> 
</table>

# 使用反射机制读取注解信息 #

try { 
    	Class clazz = Class.forName("com.wj.test.annotation.WjtStudent");
    	 
    	//获得类的所有有效注解 
    	Annotation[] annotations=clazz.getAnnotations(); 
    	for (Annotation a : annotations) { 
    			System.out.println(a); 
    		}
    		//获得类的指定的注解 
    		WjTable wt = (WjTable) clazz.getAnnotation(WjTable.class);  
    		System.out.println(wt.value()); 
    		//获得类的属性的注解 
    		Field f = clazz.getDeclaredField("studentName"); 
    		WjField wjField = f.getAnnotation(WjField.class); 
    		System.out.println(wjField.columnName()+"--"+wjField.type()+"--"+wjField.length()); 
    } catch (Exception e) { 
    		e.printStackTrace(); 
    	}