注解及反射的使用

Love The Way You Lie 2022-12-03 09:46 172阅读 0赞

上一章我讲了连接池，本来是说要讲注解的，讲注解的话要讲好多铺垫才行，算了试着说一说了。

### 注解及反射的使用 ###

*  一、注解是什么？
 *  二、怎么使用
 *   *  @Target
     *  @Retention
     *  @Documented
     *  @Inherited
     *  注解示例
 *  三、反射是什么？
 *   *  反射机制的相关类
     *  反射示例
     *  反射与注解的配合使用
     *  更多玩法

--------------------

好的，下面正式开始

# 一、注解是什么？ #

当然了，这个意义还是要讲。毕竟我一开始对这个注解也很陌生，注解？一想想到注释了  
**注解**（Annotation）**又称** Java **标注**，是 JDK5.0 引入的一种**注释机制**。Java 语言中的类、方法、变量、参数和包等都可以被标注，和 Javadoc（也就是所说的文档注释） 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持**自定义** Java 标注。  
**上面这个太官方了点**  
我就用土鳖的言语说下，**注释** 是为了方便我们阅读代码而标注的。而**注解**的出现我认为是方便我们去实现一些自定义的功能，或者说是方便一些功能的实现。使得我们能够根据注解上的value去操作到对应的属性，或找到对应的类。这使得代码变得更为灵活。

# 二、怎么使用 #

这个注解它是用4个元注解去修饰这个注解。也就是说用元注解规定我们这个自定义注解的作用域等，有下面这四个元注解：  
**1.@Target,  
2.@Retention,  
3.@Documented,  
4.@Inherited**

## @Target ##

@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、  
类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。  
在Annotation类型的声明中使用了target可更加明晰其修饰的目标。  
1.CONSTRUCTOR:用于描述构造器  
2.FIELD:用于描述域  
3.LOCAL\_VARIABLE:用于描述局部变量  
4.METHOD:用于描述方法  
5.PACKAGE:用于描述包  
6.PARAMETER:用于描述参数  
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

## @Retention ##

@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；  
而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取  
（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。  
1.SOURCE:在源文件中有效（即源文件保留）  
2.CLASS:在class文件中有效（即class保留）  
3.RUNTIME:在运行时有效（即运行时保留）

## @Documented ##

@Documented指示某一类型的注释将通过 javadoc 和类似的默认工具进行文档化。应使用此类型来注释这些类型的声明：其注释会影响由其客户端注释的元素的使用。  
如果类型声明是用 Documented 来注释的，则其注释将成为注释元素的公共 API 的一部分。

## @Inherited ##

@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。  
注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。  
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，  
则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，  
直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

**我们使用的时候主要还是使用前面两个，@Target就是告诉编译器，我这个是修饰在类上还是构造方法还是哪里。@Retention就是告诉编译器，我的生命周期有多长，在哪里死去。**

## 注解示例 ##

其实要真正使用上注解，至少还需要搭配上泛型，反射的知识，那我下面先简单写两段代码，看一下这个自定义注解怎么写出来，后面再介绍下反射，泛型的话我想，大家就自己学一下吧，哈哈。有的人可能早就知道了。

/** * * @author T_Antry * @describe 用于与数据库对应 * @target - 标记这个注解应该是那种java成员：类。字段、属性、方法 * @Retention - 标识这个注解怎么保存，只在代码中，还是编入class文件中，或者是在运行时可以反射 * @Documented - 标记这些注解是否包含在用户文档中 * @Inherited - 标记这个注解是继承哪个注解类（默认注解没有继承于任何注解） * return * 2020年8月11日 */
    @Target(ElementType.FIELD)//声明是修饰属性的
    @Retention(RetentionPolicy.RUNTIME)//通常都是选这个属性，运行时存活，因为一般要配合反射使用
    @Documented
    @Inherited
    public @interface MyField { 
    	String value();//声明了一个value的key她的值是string
    }

一般默认都要有一个value，怎么说呢，用于我们通过value去查找到对应的类或者属性。

**现在看一下我写的一个模板类，并将上面写的注解放在属性上方**

/** * * @author T_Antry * @describe 地区模板类 * T_Antry-0718 * 2020年7月19日 */
    public class Area { 
    	@MyField("id")
    	private int id;
    	@MyField("pid")
    	private int pid;
    	@MyField("name")
    	private String name;
    	public Area() { 
    		
    	}
    	public Area(int id, int pid, String name) { 
    		super();
    		this.id = id;
    		this.pid = pid;
    		this.name = name;
    	}
    	public int getId() { 
    		return id;
    	}
    	public void setId(int id) { 
    		this.id = id;
    	}
    	public int getPid() { 
    		return pid;
    	}
    	public void setPid(int pid) { 
    		this.pid = pid;
    	}
    	public String getName() { 
    		return name;
    	}
    	public void setName(String name) { 
    		this.name = name;
    	}
    	
    }

看到这个其实，还没有任何意义，甚至不知道要干嘛，什么鬼注解有屁用。是的，还是毫无卵用。所以这里还是要介绍一下反射。

# 三、反射是什么？ #

反射是java高级特性

JAVA反射机制是在运行状态中，对于任意一个类，都能够知道这个类的所有属性和方法；对于任意一个对象，都能够调用它的任意方法和属性；这种动态获取信息以及动态调用对象方法的功能称为java语言的反射机制。

也就是拿到一个类或对象，就可以通过反射获取它的所有属性等，即使你不知道这个类有些什么。

## 反射机制的相关类 ##

那反射可以拿到类，属性，方法，构造，这些在java中我们也可以称之为对象，既然可以称之为对象，那么他们都有对应的类吧。是的

<table> 
 <thead> 
  <tr> 
   <th>类名</th> 
   <th>对应</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Class</td> 
   <td>代表类的实体，在运行的Java应用程序中表示类和接口</td> 
  </tr> 
  <tr> 
   <td>Field</td> 
   <td>代表类的成员变量（成员变量也称为类的属性）</td> 
  </tr> 
  <tr> 
   <td>Method</td> 
   <td>代表类的方法</td> 
  </tr> 
  <tr> 
   <td>Constroctor</td> 
   <td>代表类的构造方法</td> 
  </tr> 
 </tbody> 
</table>

**获得类相关的方法**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>asSubclass(Class<u> clazz)</u></td> 
   <td>把传递的类的对象转换成代表其子类的对象</td> 
  </tr> 
  <tr> 
   <td>Cast</td> 
   <td>把对象转换成代表类或是接口的对象</td> 
  </tr> 
  <tr> 
   <td>getClassLoader()</td> 
   <td>获得类的加载器</td> 
  </tr> 
  <tr> 
   <td>getClasses()</td> 
   <td>返回一个数组，数组中包含该类中所有公共类和接口类的对象</td> 
  </tr> 
  <tr> 
   <td>getDeclaredClasses()</td> 
   <td>返回一个数组，数组中包含该类中所有类和接口类的对象</td> 
  </tr> 
  <tr> 
   <td>forName(String className)</td> 
   <td>根据类名返回类的对象</td> 
  </tr> 
  <tr> 
   <td>getName()</td> 
   <td>获得类的完整路径名字</td> 
  </tr> 
  <tr> 
   <td>newInstance()</td> 
   <td>创建类的实例</td> 
  </tr> 
  <tr> 
   <td>getPackage()</td> 
   <td>获得类的包</td> 
  </tr> 
  <tr> 
   <td>getSimpleName()</td> 
   <td>获得类的名字</td> 
  </tr> 
  <tr> 
   <td>getSuperclass()</td> 
   <td>获得当前类继承的父类的名字</td> 
  </tr> 
  <tr> 
   <td>getInterfaces()</td> 
   <td>获得当前类实现的类或是接口</td> 
  </tr> 
 </tbody> 
</table>

**获得类中属性相关的方法**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getField(String name)</td> 
   <td>获得某个公有的属性对象</td> 
  </tr> 
  <tr> 
   <td>getFields()</td> 
   <td>获得所有公有的属性对象</td> 
  </tr> 
  <tr> 
   <td>getDeclaredField(String name)</td> 
   <td>获得某个属性对象</td> 
  </tr> 
  <tr> 
   <td>getDeclaredFields()</td> 
   <td>获得所有属性对象</td> 
  </tr> 
 </tbody> 
</table>

**获得类中注解相关的方法**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getAnnotation(Class <strong>&lt;<strong>A</strong>&gt;</strong> annotationClass)</td> 
   <td>返回该类中与参数类型匹配的公有注解对象</td> 
  </tr> 
  <tr> 
   <td>getAnnotations()</td> 
   <td>返回该类所有的公有注解对象</td> 
  </tr> 
  <tr> 
   <td>getDeclaredAnnotation(Class <strong>&lt;<strong>A</strong>&gt;</strong> annotationClass)</td> 
   <td>返回该类中与参数类型匹配的所有注解对象</td> 
  </tr> 
  <tr> 
   <td>getDeclaredAnnotations()</td> 
   <td>返回该类所有的注解对象</td> 
  </tr> 
 </tbody> 
</table>

**获得类中方法相关的方法**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getConstructor(Class…&lt;?&gt; parameterTypes)</td> 
   <td>获得该类中与参数类型匹配的公有构造方法</td> 
  </tr> 
  <tr> 
   <td>getConstructors()</td> 
   <td>获得该类的所有公有构造方法</td> 
  </tr> 
  <tr> 
   <td>getDeclaredConstructor(Class…&lt;?&gt; parameterTypes)</td> 
   <td>获得该类中与参数类型匹配的构造方法</td> 
  </tr> 
  <tr> 
   <td>getDeclaredConstructors()</td> 
   <td>获得该类所有构造方法</td> 
  </tr> 
 </tbody> 
</table>

**获得类中构造器相关的方法**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getMethod(String name, Class…&lt;?&gt; parameterTypes)</td> 
   <td>获得该类某个公有的方法</td> 
  </tr> 
  <tr> 
   <td>getMethods()</td> 
   <td>获得该类所有公有的方法</td> 
  </tr> 
  <tr> 
   <td>getDeclaredMethod(String name, Class…&lt;?&gt; parameterTypes)</td> 
   <td>获得该类某个方法</td> 
  </tr> 
  <tr> 
   <td>getDeclaredMethods()</td> 
   <td>获得该类所有方法</td> 
  </tr> 
 </tbody> 
</table>

**类中其他重要的方法**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>isAnnotation()</td> 
   <td>如果是注解类型则返回true</td> 
  </tr> 
  <tr> 
   <td>isAnnotationPresent(Class&lt;? extends Annotation&gt; annotationClass)</td> 
   <td>如果是指定类型注解类型则返回true</td> 
  </tr> 
  <tr> 
   <td>isAnonymousClass()</td> 
   <td>如果是匿名类则返回true</td> 
  </tr> 
  <tr> 
   <td>isArray()</td> 
   <td>如果是一个数组类则返回true</td> 
  </tr> 
  <tr> 
   <td>isEnum()</td> 
   <td>如果是枚举类则返回true</td> 
  </tr> 
  <tr> 
   <td>isInstance(Object obj)</td> 
   <td>如果obj是该类的实例则返回true</td> 
  </tr> 
  <tr> 
   <td>isInterface()</td> 
   <td>如果是接口类则返回true</td> 
  </tr> 
  <tr> 
   <td>isLocalClass()</td> 
   <td>如果是局部类则返回true</td> 
  </tr> 
  <tr> 
   <td>isMemberClass()</td> 
   <td>如果是内部类则返回true</td> 
  </tr> 
 </tbody> 
</table>

**Field类**  
Field代表类的成员变量（成员变量也称为类的属性）。

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>equals(Object obj)</td> 
   <td>属性与obj相等则返回true</td> 
  </tr> 
  <tr> 
   <td>get(Object obj)</td> 
   <td>获得obj中对应的属性值</td> 
  </tr> 
  <tr> 
   <td>set(Object obj, Object value)</td> 
   <td>设置obj中对应属性值</td> 
  </tr> 
 </tbody> 
</table>

**Method类**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>invoke(Object obj, Object… args)</td> 
   <td>传递object对象及参数调用该对象对应的方法</td> 
  </tr> 
 </tbody> 
</table>

**Constructor类**

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>newInstance(Object… initargs)</td> 
   <td>根据传递的参数创建类的对象</td> 
  </tr> 
 </tbody> 
</table>

## 反射示例 ##

首先我先写一个模板类

/** * * @author T_Antry * @describe 学生模板类 * T_Antry-Test * 2020年9月7日 */
    public class Student { 
    	private int id;
    	private String name;
    	public void doSome() { 
    		
    	}
    	public Student() { 
    		// TODO Auto-generated constructor stub
    	}
    	public Student(int id, String name) { 
    		super();
    		this.id = id;
    		this.name = name;
    	}
    	@Override
    	public String toString() { 
    		return "Student [id=" + id + ", name=" + name + "]";
    	}
    	public int getId() { 
    		return id;
    	}
    	public void setId(int id) { 
    		this.id = id;
    	}
    	public String getName() { 
    		return name;
    	}
    	public void setName(String name) { 
    		this.name = name;
    	}
    	
    }

非常简单测试类，只测试属性，其它的暂且不多讲，认真理解一下属性，其它的内容是一样的。也希望通过这样比较简洁的介绍，能够更清楚地了解如何配合注解的使用。

/** * * @author T_Antry * @describe 反射测试 * T_Antry-Test * 2020年9月9日 */
    public class Test { 
    	/** * * @param args * @throws IllegalAccessException * @throws IllegalArgumentException * @describe */
    	public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException { 
    		Student st = new Student(520, "T_Antry");//创建一个实例
    		System.out.println("----------Begin");
    		System.out.println(st);
    		System.out.println("----------");
    		/** * 首先我们要拿到类 */
    		Class<?> c = st.getClass();
    		Field[] fArr = c.getDeclaredFields();//获取本类所有属性，包括私有属性
    		// fArr = c.getFields();//只获取公有属性，且包括继承来的属性
    		for (Field field : fArr) { 
    			field.setAccessible(true);//注意，我们的模板类写的是几个私有成员，这条是开启权限，使得我们都能够操作和读取私有属性的值
    			System.out.println(field.get(st));
    		}
    	}
    }

我们看下运行的结果

![20200909115340532.png_pic_center][]  
可以看到我们通过反射，拿到类中的所有属性，虽然我这边只写了私有属性，大家可以自己写点有公有属性的，也可以写一些父类。可以看到**getDeclaredFields**是可以获得当前类的所有属性，**getFields**是可以获得当前类以及继承的所有父类的公有属性。  
拿到属性之后，我们可以遍历属性并查看传入对象的属性值。但是这边要注意的是需要调用\*\*setAccessible(true)\*\*方法使得我们可以查看私有成员。

## 反射与注解的配合使用 ##

首先在**Student**类中，我找一个属性加上前面注解示例中写的**Myfield**注解，例如我在name属性上加一个注解，且给一个value为"**fuck**"  
想了想还是让大家看下我修改后的类吧

import anno.MyField;
    
    /** * * @author T_Antry * @describe 学生模板类 * T_Antry-Test * 2020年9月7日 */
    public class Student { 
    	private int id;
    	@MyField("fuck")
    	private String name;
    	public void doSome() { 
    		
    	}
    	public Student() { 
    		// TODO Auto-generated constructor stub
    	}
    	public Student(int id, String name) { 
    		super();
    		this.id = id;
    		this.name = name;
    	}
    	
    	@Override
    	public String toString() { 
    		return "Student [id=" + id + ", name=" + name + "]";
    	}
    	public int getId() { 
    		return id;
    	}
    	public void setId(int id) { 
    		this.id = id;
    	}
    	public String getName() { 
    		return name;
    	}
    	public void setName(String name) { 
    		this.name = name;
    	}
    	
    }

现在模板类修改好了，我就可以开始写特使类，接下来我要把类的属性反射出来，同时还要找到带有注解的属性，把它打印出来。  
更新之后的测试类，我在打印上为了更清楚，做了少许修改，可以copy去运行，包导入就行。

**
     * 
     * @author T_Antry
     * @describe 反射测试
     * T_Antry-Test
     * 2020年9月9日
     */
    public class Test { 
    	/** * * @param args * @throws IllegalAccessException * @throws IllegalArgumentException * @describe */
    	public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException { 
    		Student st = new Student(520, "T_Antry");//创建一个实例
    		System.out.println("----------Begin");
    		System.out.println(st);
    		System.out.println("----------反射示例");
    		/** * 首先我们要拿到类 */
    		Class<?> c = st.getClass();
    		Field[] fArr = c.getDeclaredFields();//获取本类所有属性，包括私有属性
    		// fArr = c.getFields();//只获取公有属性，且包括继承来的属性
    		for (Field field : fArr) { 
    			field.setAccessible(true);//注意，我们的模板类写的是几个私有成员，这条是开启权限，使得我们都能够操作和读取私有属性的值
    			System.out.println(field.getName()+":" +field.get(st));
    		}
    		System.out.println("----------反射+注解示例1:没有注解的不打印");
    		for (Field field : fArr) { 
    			field.setAccessible(true);//注意，我们的模板类写的是几个私有成员，这条是开启权限，使得我们都能够操作和读取私有属性的值
    			MyField anno = field.getDeclaredAnnotation(MyField.class);
    			if(null==anno)
    				continue;
    			System.out.println(field.getName()+":" +field.get(st));
    		}
    		
    	}
    }

运行结果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MTUwMDQ5_size_16_color_FFFFFF_t_70_pic_center]  
如图可见，我们只打印了name属性，因为我在name属性上面加了注解，这里检测到有注解，就打印了。

## 更多玩法 ##

当然还有很多玩法，例如你还可以拿到注解上value的值去做一些事请，比如ORM原理就是才有这种做法。  
实际上，我认为，注解可能更经常用于类的上方，随后通过注解去找到对应的类。这种做法十分有利于代码的简洁。但是这个实例，因为还涉及网络技术，服务器，以及整个项目的运转，也可能是我水平不够，就不好一下子介绍完，哈哈。后面有可能的话，希望还是可以将一下Servlet注解原理。

[20200909115340532.png_pic_center]: /images/20221123/2a62a41297a04a7ca622feccb3e6a3bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MTUwMDQ5_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/a243821c32c64794a6d21e86b7249cd7.png