注解和反射

什么是注解

• Annotation是从JDK5.0开始引入的技术.

• Annotation的作用：

  • 不是程序本身，可以对程序作出解释.（这一点和注释（comment)没什么区别）
  • 可以被其他程序（比如：编译器等）读取.

• Annotation的格式：

  • 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value=”unchecked”).

• Annotation在哪里使用？

  • 可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

内置注解

--1.@Override：定义在java.lang.Override中，此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明.
--2.@Deprecated:定义在java.lang.Deprecated中，此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择.
--3.@SuppressWarnings:定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息.
--与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就好了.
      @SuppressWarnings("all")
      @SuppressWarnings("unchecked")
      @SuppressWarnings(value={"unchecked","deprecation'"})
      等等……

元注解

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

注解名	作用
@Target	用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
@Retention	表示需要在什么级别保存该注释信息，用于描述注解的生命周期>(SOURCE<CLASS< RUNTIME)
@Document	说明该注解将被包含在javadoc中
@lnherited	说明子类可以继承父类中的该注解

public class Test {
	//定义一个注解
    
	@Target(value= {ElementType.METHOD,ElementType.TYPE})//Target表示注解可以用在哪些地方
	//METHOD：该注解能用在方法上
	//TYPE：该注解能用在类上
	@Retention(value=RetentionPolicy.RUNTIME)//表示注解在什么地方有效
	//RUNTIME 运行时有效
	//CLASS  在类中有效
	// SOURCE 在源码中有效
	@Documented //表示是否将该注解生成在Javadoc文档中
	@Inherited //表示子类可以继承父类的注解
	@interface MyAnnotation{}
	
	
	@MyAnnotation
	public void test() {}

}

自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口

分析：
@interface用来声明一个注解，格式：public @interface 注解名{定义内容}
1.其中的每一个方法实际上是声明了一个配置参数.
2.方法的名称就是参数的名称。
3.返回值类型就是参数的类型（返回值只能是基本类型，Class，String，enum).
4.可以通过default来声明参数的默认值
5.如果只有一个参数成员，一般参数名为value
6.注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值.

反射概述🎈

动态语言和静态语言

动态语言

是一类在运行时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。
主要动态语言：Object-C、C#、JavaScript、PHP、Python等。

静态语言

与动态语言相对应的，运行时结构不可变的语言就是静态语言。如Java、C、C++。
Java不是动态语言，但Java可以称之为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动 态语言的特性。Java的动态性让编程的时候更加灵活！

Java 反射

Java Reflection（什么是反射）

• Reflection（反射）是java被视为动态语言的关键，反射机制允许程序在执行期间借助于Reflection API取得任何类的内部信息。并能操作任意对象的内部属性和方法。

  ​ Class c=Class.forName(“java.lang.String”)

• 加载完类之后，在堆内存的方法区中就会产生一个Class类型的对象（一个类只有一个class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以，我们形象的称之为：反射。

  正常方式：引入需要的 “包类” 名称 → 通过new 实例化 → 取得实例化对象。

反射方法：实例化对象 → getClass（）方法 → 得到完整的”包类”名称。

java反射机制提供的功能

• 在运行时判断任意一个对象所属的类
• 在运行时构造任意一个类的对象
• 在运行时判断任意一个类所具有的成员变量和方法
• 在运行时获取泛型信息
• 在运行时调用任意一个对象的成员变量和方法
• 在运行时处理注解
• 生成动态代理
• ··········

反射的优缺点

优点：

可以实现动态的创建对象和编译，体现出很大的灵活性。

缺点：

对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且满足我们的要求。

这类操作总是慢于直接执行相同的操作。

反射相关的API

java.lang.Class//代表一个类
java.lang.reflect.Method//代表类的方法 
java.lang.reflect.Field//代表类的成员变量
java.lang.reflect.Constructor//代表类的构造器   

Class类

对象照镜子后可以得到的信息：某个类的属性、方法和构造器、某个类到底实现了哪些接口。

对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构(class/interface/enum/annotation/primitive type/void/])的有关信息。

• Class 本身也是一个类
• Class 对象只能由系统建立对象
• 一个加载的类在JVM中只会有一个Class实例
• 一个Class对象对应的是一个加载到JVM中的一个.class文件
• 每个类的实例都会记得自己是由哪个Class 实例所生成
• 通过Class可以完整地得到一个类中的所有被加载的结构
• Class类是Reflection的根源，针对任何你想动态加载、运行的类，唯有先获得相应的Class对象

package day01;
//-----------反射
public class TestRelf {
	
	public static void main(String[] args) throws ClassNotFoundException {
		//通过反射获取类的class对象
		Class c1=Class.forName("day01.User");
		Class c2=Class.forName("day01.User");
		Class c3=Class.forName("day01.User");
		Class c4=Class.forName("day01.User");
		System.out.println(c1);
		//可以发现，以下语句打印出了同样的hashCode，因为一个类在内存中只有一个Class对象
		//一个类被加载后，类的整个结构信息会被封装在Class对象中
		System.out.println(c2.hashCode());
		System.out.println(c3.hashCode());
		System.out.println(c4.hashCode());
	}

}
 class User{
	private String name ;
	private int id;
	private int age;	
     /*
     get/set方法
     构造方法省略
     */
}

执行结果：
    
class day01.User
366712642
366712642
366712642

获取Class类的几种方式

package day01;
//------------获取Class对象的方法------------
public class Test03 {
	public static void main(String[] args) throws ClassNotFoundException {
		Person person=new Student();
		System.out.println("这个人是"+person.name);
		
		//方式一：通过对象获取
		Class c1=person.getClass();
		System.out.println(c1.hashCode());
		//forName获取
		Class c2=Class.forName("day01.Student");
		System.out.println(c2.hashCode());
		//方式三：通过类名.class获取
		Class c3=Student.class;
		System.out.println(c3.hashCode());
		//方式四：基本内置类型的包装类都有一个Type属性
		Class c4=Integer.TYPE;
		System.out.println(c4);
		System.out.println(c4.hashCode());
		
		//获取父类类型
		Class c5=c1.getSuperclass();
		System.out.println(c5);
	}

}

class Person{
	public String name;
	public Person(String name) {
		super();
		this.name = name;
	}
	public Person() {
		super();
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	@Override
	public String toString() {
		return "Person [name=" + name + "]";
	}		
}
   class Student extends Person{
	   public Student() {
		   this.name="学生";
	   }
   }
   class Teacher extends Person{
	   public Teacher() {
		   this.name="老师";
	   }
   }

执行结果：
    
这个人是学生
366712642
366712642
366712642
int
1829164700
class day01.Person

哪些类型可以有Class对象

• class：外部类，成员（成员内部类，静态内部类），局部内部类，匿名内部类。
• interface:接口
• []:数组
• enum:枚举
• annotation:注解@interface
• primitive type:基本数据类型void

package day01;
import java.lang.annotation.ElementType;
//所有类型的Class
public class Test06 {

	public static void main(String[] args) {
		Class c1=Object.class;//类
		Class c2=Comparable.class;//接口
		Class c3=String[].class;//一维数组
		Class c4=int[][].class;//二维数组
		Class c5=Override.class;//注解
		Class c6=ElementType.class;//枚举
		Class c7=Integer.class;//基本数据类型
		Class c8=void.class;//void
		Class c9=Class.class;//Class
		
		System.out.println(c1);
		System.out.println(c2);
		System.out.println(c3);
		System.out.println(c4);
		System.out.println(c5);
		System.out.println(c6);
		System.out.println(c7);
		System.out.println(c8);
		System.out.println(c9);


		int[] a=new int[10];
		int[] b=new int[100];
		System.out.println("一个类只有一个class对象");
		System.out.println(a.getClass().hashCode()); 
		System.out.println(a.getClass().hashCode()); 
	}

}

结果：
class java.lang.Object
interface java.lang.Comparable
class [Ljava.lang.String;
class [[I
interface java.lang.Override
class java.lang.annotation.ElementType
class java.lang.Integer
void
class java.lang.Class
一个类只有一个class对象
366712642
366712642

获取运行时类的完整结构

package day01;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

//获得类的信息
public class Test07 {

	public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, SecurityException, NoSuchMethodException {
	    //Class c1=Class.forName("day01.User01");
		
		User01 user=new User01();
		Class c1=user.getClass();
		//获取类的名字：
		System.out.println(	c1.getName());//包名+类名
		System.out.println(	c1.getSimpleName());//类名
		
		//获得类的属性
		Field[] fields=c1.getFields();//getFields只能找到public属性
		Field[] fields01=c1.getDeclaredFields();//getDeclaredFields可以找到全部属性
		System.out.println("获取类的属性：");
		for (Field field : fields) {
			System.out.println(field);
		}
        for (Field field : fields01) {
			System.out.println(field);
		}
        //获取指定属性
        Field name=c1.getDeclaredField("name");
        System.out.println("获取指定属性："+name);
        
        //获取类的方法：
        Method[] methods=c1.getMethods();//获取本类及其父类的全部public方法
        Method[] method01=c1.getDeclaredMethods();//获得本类（没有父类）的所有方法
        System.out.println("获取类的方法：===========================");
        for (Method method : method01) {
			System.out.println("本类的方法："+method);
		}
        for (Method method : methods) {
			System.out.println("public方法："+method);
		}
        //获取指定的方法： 
        System.out.println("获取指定的方法：==========================");
        Method getName=c1.getMethod("getName", null);
        Method setName=c1.getMethod("setName", String.class);//获取指定方法时需要将方法的参数传进去，以为要考虑到该方法的重载问题，不传参数可能会报错
        System.out.println("getName方法:"+getName);
        System.out.println("setName方法:"+setName);
        
        //获取构造器
        System.out.println("获取构造器=======================");
        Constructor [] Constructor=c1.getConstructors();
        Constructor [] Constructor01=c1.getDeclaredConstructors();
        for (Constructor constructor : Constructor) {
			System.out.println(constructor);
		}
        for (Constructor constructor2 : Constructor01) {
			System.out.println(constructor2);
		}
        //获取指定构造器：
        
        Constructor cc=c1.getDeclaredConstructor(String.class,int.class,int.class);
        System.out.println("有参构造："+cc);
	}

}


class User01{
	private String name ;
	private int id;
	private int age;
	public User01() {
		super();
	}
	public User01(String name, int id, int age) {
		super();
		this.name = name;
		this.id = id;
		this.age = age;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	@Override
	public String toString() {
		return "User01 [name=" + name + ", id=" + id + ", age=" + age + "]";
	}
}

结果：
day01.User01
User01
获取类的属性：
private java.lang.String day01.User01.name
private int day01.User01.id
private int day01.User01.age
获取指定属性:private java.lang.String day01.User01.name
获取类的方法：===========================
本类的方法：public java.lang.String day01.User01.toString()
本类的方法：public java.lang.String day01.User01.getName()
本类的方法：public int day01.User01.getId()
本类的方法：public void day01.User01.setName(java.lang.String)
本类的方法：public void day01.User01.setId(int)
本类的方法：public int day01.User01.getAge()
本类的方法：public void day01.User01.setAge(int)
public方法：public java.lang.String day01.User01.toString()
public方法：public java.lang.String day01.User01.getName()
public方法：public int day01.User01.getId()
public方法：public void day01.User01.setName(java.lang.String)
public方法：public void day01.User01.setId(int)
public方法：public int day01.User01.getAge()
public方法：public void day01.User01.setAge(int)
public方法：public final void java.lang.Object.wait() throws java.lang.InterruptedException
public方法：public final void java.lang.Object.wait(long,int) throws java.lang.InterruptedException
public方法：public final native void java.lang.Object.wait(long) throws java.lang.InterruptedException
public方法：public boolean java.lang.Object.equals(java.lang.Object)
public方法：public native int java.lang.Object.hashCode()
public方法：public final native java.lang.Class java.lang.Object.getClass()
public方法：public final native void java.lang.Object.notify()
public方法：public final native void java.lang.Object.notifyAll()
获取指定的方法：==========================
getName方法:public java.lang.String day01.User01.getName()
setName方法:public void day01.User01.setName(java.lang.String)
获取构造器=======================
public day01.User01()
public day01.User01(java.lang.String,int,int)
public day01.User01()
public day01.User01(java.lang.String,int,int)
有参构造：public day01.User01(java.lang.String,int,int)

动态创建对象执行方法

创建对象

创建类的对象：调用Class对象的newInstance（）方法创建对象。

注意：

• 类必须有一个无参的构造器。
• 类的构造器的访问权限需要足够。

若没有无参的构造器，也能创建对象，只要在操作的时候明确调用类中的构造器，并将参数传递进去之后，才可以实例化操作。

步骤如下：

1. 通过Class类的getDeclaredConstructor（构造参数）取得本类的指定形参类型的构造器。
2. 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需要的各个参数。
3. 通过Constructor实例化对象。

调用指定方法

通过反射，调用类中的方法，通过Method类完成。

1. 通过Class类的getMethod（String name,Class..parameterTypes)方法取得一个Method对象，并设置此方法操作时所需要的参数类型。
2. 之后使用Object invoke（Object obj,Object[] args)进行调用，并向方法中传递要设置的obj对象的参数信息。

关于invoke：

Object invoke(Object obj,Object…args)

• Object 对应原方法的返回值，若原方法无返回值，此时返回null

• 若原方法若为静态方法，此时形参Object obj可为null

• 若原方法形参列表为空，则Object[] args为null

• 若原方法声明为private，则需要在调用此invoke（）方法前，显式调用方法对象的setAccessible(true)方法，将可访问private的方法。

  关于setAccessible：

• Method和Field、Constructor对象都有setAccessible()方法。

• setAccessible作用是启动和禁用访问安全检查的开关。

• 参数值为true则指示反射的对象在使用时应该取消Java语言访问检查。

  • 提高反射的效率。如果代码中必须用反射，而该句代码需要频繁的被调用，那么请设置为true。
  • 使得原本无法访问的私有成员也可以访问

• 参数值为false则指示反射的对象应该实施ava语言访问检查

package day01;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

//动态创建对象，执行方法通过反射
public class Test08 {

	public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, SecurityException, IllegalArgumentException, InvocationTargetException, NoSuchFieldException  {
		System.out.println("创建对象=======================");
		//获取class对象
		Class c1=Class.forName("day01.User02");
		//创建对象
		User02 user1=(User02)c1.newInstance();//通过User02的无参构造创建对象
		System.out.println(user1);
		//通过有参构造器创建对象
		Constructor constructor=c1.getDeclaredConstructor(String.class,int.class,int.class);//获取构造器
	    User02 user2=(User02)constructor.newInstance("sovzn",1024,88);
	    System.out.println("通过有参构造:"+user2);
	    
	    
	    System.out.println("调用方法========================");
	    User02 user3=(User02) c1.newInstance();
	    Method setName =c1.getDeclaredMethod("setName", String.class);//获取setName方法
	    setName.invoke(user3, "shiyaochang");//执行方法
	    System.out.println("user3的name："+user3.getName());
	    
	    System.out.println("操作属性========================");
	    User02 user4=(User02) c1.newInstance();
	    Field name=c1.getDeclaredField("name");//获取属性
	    name.setAccessible(true);//因为name为私有属性，我们需要关闭程序的安全检测，通过setAccessible(true)
	    name.set(user4, "shiyao");
	    System.out.println("user4的name："+user4.getName());
	}

}

class User02{
	private String name ;
	private int id;
	private int age;
	public User02() {
		super();
	}
	public User02(String name, int id, int age) {
		super();
		this.name = name;
		this.id = id;
		this.age = age;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	@Override
	public String toString() {
		return "User01 [name=" + name + ", id=" + id + ", age=" + age + "]";
	}	
	}

结果：
    
创建对象=======================
User01 [name=null, id=0, age=0]
通过有参构造:User01 [name=sovzn, id=1024, age=88]
调用方法========================
user3的name：shiyaochang
操作属性========================
user4的name：shiyao

反射操作注解

1.ORM：

Object relationship Mapping ：对象关系映射

如：

class Student{
int id;
String name;
int age;
}

id	name	age
001	sovzn	3
002	syc	30

• 类和表对应
• 属性和字段对应
• 对象和记录对应

利用注解和反射完成类和表的对应关系：

package day01;

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

//反射操作注解
public class Test10 {

	public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, SecurityException {
     Class c=Class.forName("day01.Student01");//获取class对象
   
    //通过反射获取类注解
    Annotation[] anno= c.getAnnotations();
    for (Annotation annotation : anno) {
		System.out.println(annotation);
	} 
    System.out.println("获取类的注解及值======================="); 
    //获取类的注解的value值
    TableSovzn tableSovzn= (TableSovzn)c.getAnnotation(TableSovzn.class);//获取注解
    String value=tableSovzn.value();
    System.out.println("注解 TableSovzn的值为："+value);
    
    System.out.println("获取类的属性的注解及值======================="); 
	
	Field field=c.getDeclaredField("name");//获取属性
	FieldSovzn fieldSovzn=field.getAnnotation(FieldSovzn.class);//获取属性的注解
	//获取属性的注解的值
	System.out.println("fieldSovzn.columnName:"+fieldSovzn.columnName());
	System.out.println("fieldSovzn.length:"+fieldSovzn.length());
	System.out.println("fieldSovzn.type:"+fieldSovzn.type());
	}

}

//类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableSovzn{
	String value();
}


//属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldSovzn{
	String columnName();
	String type();
	int length();
}



@TableSovzn("db_student")
class Student01{
	@FieldSovzn(columnName="db_id",type="int",length=10)
	private int id;
	@FieldSovzn(columnName="db_age",type="int",length=10)
	private int age;
	@FieldSovzn(columnName="db_name",type="varchar",length=10)
	private String name;
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public Student01(int id, int age, String name) {
		super();
		this.id = id;
		this.age = age;
		this.name = name;
	}
	public Student01() {
		super();
		// TODO Auto-generated constructor stub
	}
	@Override
	public String toString() {
		return "Student [id=" + id + ", age=" + age + ", name=" + name + "]";
	}	
}

结果：
    
@day01.TableSovzn(value=db_student)
获取类的注解及值=======================
注解 TableSovzn的值为：db_student
获取类的属性的注解及值=======================
fieldSovzn.columnName:db_name
fieldSovzn.length:10
fieldSovzn.type:varchar

给个饭钱？

• Post author: Sovzn
• Post link: http://sovzn.github.io/2021/01/19/%E6%B3%A8%E8%A7%A3%E5%92%8C%E5%8F%8D%E5%B0%84/
• Copyright Notice: All articles in this blog are licensed under unless otherwise stated.