“反射”作为Java特性之一,为我们程序在运行时动态地获取类的信息、调用对象的方法和操作对象的属性提供了途径。并且通过使用反射,我们可以在编译期间未知具体类型的情况下,对类进行操作。接下来我们将系统重新回顾一下"反射",结合新的应用场景,温故而知新,希望能给予新的启发。
什么是反射技术
Java的反射(reflection)机制是指在程序的运行状态中,可以做以下操作:1)构造任意一个类的对象;2)了解任意一个对象所属的类;3)了解任意一个类的成员变量和方法。调用任意一个对象的属性和方法,这种动态获取程序信息以及动态调用对象的功能称为Java语言的反射机制。
说白了就是得到编译以后的class文件对象,提供了一个Class类型(编译后的class类对象)。
HelloWorld.java -> javac -> HelloWorld.class
Class clz = HelloWorld.class
可操作的反射主体
1)类字节码 Class (本身也是一个类,是Java反射的源头)
2)构造器 Constructor
3)成员变量 Field
4)方法 Method
一般反射要点
1)类名.class
2)对象.getClass()
3)Class.forName("类的全名")
4)使用类的加载器ClassLoader
public class User {private String name;private int age;public User() {}public User(String name, int age){this.name=name;this.age=age;}}
public static void main(String[] args) throws ClassNotFoundException {//通过类名获取Class<User> userClass1 = User.class;//通过对象获取User user = new User();Class<? extends User> userClass2 = user.getClass();//通过全限定名Class<?> userClass3 = Class.forName("priv.muller.reflect.User");//通过类加载器ClassLoader classLoader = Test.class.getClassLoader();Class<?> userClass4 = classLoader.loadClass("priv.muller.reflect.User");System.out.println(userClass1);System.out.println(userClass2);System.out.println(userClass3);System.out.println(userClass4);}
类方法Api
方法名称 | 作用 |
---|---|
getName( ) | 获取 包名+类名 |
getSimpleName( ) | 获取类名 |
getDeclaredConstructor(Class<?>... parameterTypes) | 根据参数,获取构造器,修饰符不影响 |
getDeclaredConstructors() | 获取全部声明的构造器,返回数组,修饰符不影响 |
//获取声明的构造器,根据参数类型匹配Class<User> userClass = User.class;Constructor<User> declaredConstructor = userClass.getDeclaredConstructor(String.class, int.class);System.out.println(declaredConstructor.getName()+","+declaredConstructor.getParameterCount());//获取全部声明的构造器,返回数组,修饰符不影响Constructor<?>[] declaredConstructors = userClass.getDeclaredConstructors();for (Constructor<?> declaredConstructor1 : declaredConstructors) {System.out.println(declaredConstructor1.getName()+","+declaredConstructor1.getParameterCount());}
主要两类反射API
1)get+要获取的东西,例如:获取属性为getField()、获取方法为getMethod(),只能获取公有的东西(public范围)。需注意的是getMethod可以获取到本类及其父类的方法;
2)get+Declared+要获取的东西,例如:获取属性为getDeclaredField()、获取方法为geDeclaredtMethod(),可以获取全部的东西(包括private)。需要注意的是getDeclaredMethod只能获取到本类的方法;
对象创建
反射创建对象有多种方式,常用步骤如下:1)根据全类名获取对应的`Class`对象;2)调用指定参数结构的构造器,生成`Constructor`的实例;3)通过`Constructor`的实例创建对应类的对象,并初始化类属性;
class.getDeclaredConstructor( ).newInstance( )
方法名 | 说明 |
---|---|
T newInstance( ) | 根据类的空参的构造器创建对象,类必须提供空参的构造器和public权限 |
T newInstance(Object...initargs) | 根据指定的构造方法创建对象 |
代码案例
public static void test2() throws Exception {//获取类对象Class<User> clazz = User.class;//获取public空构造函数,并创建对象User user = clazz.getDeclaredConstructor().newInstance();user.setAge(11);user.setName("张三");System.out.println(user);}public static void test3() throws Exception {//获取类对象Class<User> clazz = User.class;//获取指定构造器Constructor constructor = clazz.getConstructor(int.class,String.class);//创建对象User user = (User) constructor.newInstance(21,"李四");System.out.println(user);}
方法和属性
1)通过class获取方法
方法 | 说明 |
---|---|
getMethods() | 获取当前运行类和 父类中声明的方法,需要是public访问权限的方法 |
getDeclaredMethods() | 获取当前运行时类中声明的全部方法,不包含父类中声明的方法 |
2)方法method的方法
getReturnType() | 获取全部的返回值 |
getParameterTypes() | 获取全部的参数 |
getModifiers() | 获取修饰符 |
getExceptionTypes() | 获取异常信息 |
代码案例
public static void test6() throws Exception {//获取类对象Class<User> clazz = User.class;//获取当前运行类和 父类中声明的方法,需要是public访问权限的方法Method[] methods = clazz.getMethods();for(Method method:methods){System.out.println("修饰符="+method.getModifiers()+",返回值="+method.getReturnType().getName()+",整体="+method);}System.out.println("——————————————————");Method[] declaredMethods = clazz.getDeclaredMethods();for(Method method:declaredMethods){System.out.println("修饰符="+method.getModifiers()+",返回值="+method.getReturnType().getName()+",整体="+method);}
}
通过class对象获取属性
方法名 | 说明 |
---|---|
getFields( ) | 获取当前运行类和 父类中声明的属性,需要是public访问权限的属性 |
getDeclaredFields( ) | 获取当前运行时类中声明的全部属性,不包含父类中声明的属性 |
属性Field的方法
方法 | 说明 |
---|---|
getModifiers() | 整数形式返回此Field 的修饰符,整数对应在 java.lang.reflect.Modifier 里面 |
getType() | 返回 Field的属性类型 |
getName() | 返回 Field的名称 |
代码案例
public class Base {public String job;public String getJob() {return job;}public void setJob(String job) {this.job = job;}
}public static void test5() throws Exception {//获取类对象Class<User> clazz = User.class;//都是private,则获取不了; 属性改为public才行Field[] fields = clazz.getFields();for(Field field:fields){System.out.println("属性名="+field.getName()+",属性类型="+field.getType().getName()+",属性修饰符="+field.getModifiers());}System.out.println("——————————————————");// 获取当前运行时类中声明的全部属性,不包含父类中声明的属性Field[] declaredFields = clazz.getDeclaredFields();for(Field field:declaredFields){System.out.println("属性名="+field.getName()+",属性类型="+field.getType().getName()+",属性修饰符="+field.getModifiers());}}//输出结果
属性名=job,属性类型=java.lang.String,属性修饰符=1
——————————————————
属性名=age,属性类型=int,属性修饰符=2
属性名=name,属性类型=java.lang.String,属性修饰符=2
强制属性访问
反射操作时如果构造器、方法、属性 没权限时,可以通过 setAccessible(true)
。修改访问权限,Method和Field、Constructor对象都有setAccessible()方法。
1)构造器
public static void test4() throws Exception {//获取类对象Class<User> clazz = User.class;//获取public空构造函数,并创建对象(把构造函数private私有化)Constructor<User> declaredConstructor = clazz.getDeclaredConstructor();//修改访问权限,true表示暴力反射,攻破权限declaredConstructor.setAccessible(true);User user = declaredConstructor.newInstance();user.setAge(11);user.setName("张三");System.out.println(user);}
2)属性
方法 | 说明 |
---|---|
get(Object obj) | 获取取指定对象obj 上此Field 的属性内容 |
set(Object obj,Object value) | 设置指定对象obj 上此Field 的属性内容 |
代码案例
public class Product {private int price;private String title;private Product(){}@Overridepublic String toString() {return "Product{" +"price=" + price +", title='" + title + '\'' +'}';}}
public static void main(String[] args) throws Exception {Class clazz = Product.class;//创建运行时类的对象//获取类对象//获取public空构造函数,并创建对象Constructor<Product> declaredConstructor = clazz.getDeclaredConstructor();//修改访问权限,true表示保留反射declaredConstructor.setAccessible(true);//创建对象Product product = declaredConstructor.newInstance();System.out.println(product.toString());//获取运行时类中指定变量名的属性Field title = clazz.getDeclaredField("title");//保证当前属性是可访问的title.setAccessible(true);//设置指定对象的的属性值title.set(product,"商品1");//打印对象的title属性值System.out.println(title.get(product));System.out.println(product.toString());}//结果
Product{price=0, title='null'}
商品1
Product{price=0, title='商品1'}
运行类方法
运行类的指定方法步骤:1)获取class对象,创建对象;2)获取方法,invoke调用;
Object invoke(Object obj, Object... args)
invoke用来调用某个类中的方法的,但是它不是通过当前类直接去调用而是通过反射的机制去调用。
参数说明:obj是调用类的实例对象, args:调用方的方法参数,是可变长度的
1)Object 对应原方法的返回值,若原方法无返回值,此时返回null;
2)如果原方法为静态方法,此时形参 obj可为null;
3)如果原方法形参列表为空,则args为null;
4)如果原方法声明为private,则需要在调用此invoke()方法前,调用对象的setAccessible(true)方法;
具体代码
public class User extends Base {private int age;private String name;public User() {}public User(int age, String name) {this.age = age;this.name = name;}private String say(String name){System.out.println("我是"+name+",这个bug不是我写的");return name;}private int say(int age){System.out.println("我今年"+age+"岁,准备找老婆了");return age;}private static void sleep(String name){System.out.println("我是"+name+",这个是静态方法,在睡觉");}//set get方法省略
}public static void test7() throws Exception {//获取类对象Class<User> clazz = User.class;//获取public空构造函数,并创建对象Constructor<User> declaredConstructor = clazz.getDeclaredConstructor();//确保有访问权限,true表示暴力反射declaredConstructor.setAccessible(true);User user = declaredConstructor.newInstance();user.setName("张三");//获取指定的某个方法, 参数1,指明获取的方法的名称 参数2,指明获取的方法的形参列表Method say = clazz.getDeclaredMethod("say", String.class);//保证当前方法是可访问的say.setAccessible(true);//invoke调用,参数1 方法的调用者 参数2 给方法形参赋值的实参,// 返回值 是 对应类中调用的方法的返回值。Object returnValue = say.invoke(user, "李四");System.out.println(returnValue);System.out.println("—————————调用静态方法———————————");//获取指定的某个方法, 参数1,指明获取的方法的名称 参数2,指明获取的方法的形参列表Method sleepMethod = clazz.getDeclaredMethod("sleep",String.class);//保证可以访问sleepMethod.setAccessible(true);//调用静态方法,不需要获取类对象。Object returnValue2 = sleepMethod.invoke(null,"王五");//如果调用的运行时类中的方法没有返回值,则此invoke()返回nullSystem.out.println(returnValue2);}
反射应用案例
单元测试方法运行
实现一个类似junit单元测试的注解,可批量运行某个类的全部加了注解的方法,同时支持配置自定义志兴优先级以及启用开关。
方法:定义注解属性优先级和启用开关,作用范围为Method,测试类通过反射获取方法的注解,根据方法注解的有无和启用开关将其放入执行队列中。执行队列根据优先级排序后,再通过invoke执行。
方法 | 说明 |
---|---|
getAnnotations( ) | 获取类、方法等上的所有注解内容 |
getAnnotation(XXX.class) | 获取到注解的内容 |
isAnnotationPresent(XXX.class) | 判断某个注解是否存在 |
具体代码
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {/*** 测试的优先级,数字越大优先级越高* @return*/int priority() default 0;/*** 是否要启用* @return*/boolean disabled() default false;
}public class TestCase {@Test(priority = 1)public void testCase1() {System.out.println("TestCase1");}@Test(priority = 2)public void testCase2() {System.out.println("TestCase2");}@Test(priority = 0)public void testCase3() {System.out.println("TestCase3");}@Test(priority = 3,disabled = true)public void testCase4() {System.out.println("TestCase4");}// 执行测试用例public static void main(String[] args) throws InvocationTargetException {TestCase testCase = new TestCase();// 获取TestCase类中所有方法Method[] methods = TestCase.class.getDeclaredMethods();// 定义一个List用于存放有Test注解的方法List<Method> methodList = new ArrayList<>();// 遍历所有方法for (Method method : methods) {// 判断方法中是否有Test注解if (method.isAnnotationPresent(Test.class)) {//判断是否不执行Test annotation = method.getAnnotation(Test.class);if(!annotation.disabled()){// 将有Test注解的方法添加到List中methodList.add(method);}}}// 对List中的方法按照优先级进行排序,数字越小越先执行methodList.sort(Comparator.comparingInt(a -> a.getAnnotation(Test.class).priority()));// 遍历List中的方法,执行有Test注解的方法for (Method method : methodList) {try {method.invoke(testCase);} catch (IllegalAccessException | InvocationTargetException e) {e.printStackTrace();}}}
}
JDK动态代理
代理设计模式
为其他对象提供一种代理以控制对这个对象的访问,属于结构型模式。 客户端并不直接调用实际的对象,而是通过调用代理,来间接的调用实际的对象。其有点在于可以在访问一个类时做一些控制,或增加功能,操作代理类无须修改原本的源代码,符合开闭原则,系统具有较好的灵活性和可扩展性。但其会增加系统复杂性和调用链路。
什么是静态代理
由程序创建或特定工具自动生成源代码,在程序运行前,代理类的.class文件就已经存在。通过将目标类与代理类实现同一个接口,让代理类持有真实类对象,然后在代理类方法中调用真实类方法,在调用真实类方法的前后添加我们所需要的功能扩展代码来达到增强的目的。其缺点在于代理类中出现大量冗余的代码,非常不利于扩展和维护。如果接口增加一个方法,除了所有实现类需要实现这个方法外,所有代理类也需要实现此方法。增加了代码维护的复杂度。
传送门:设计模式之结构型模式-CSDN博客
public class StaticProxyPayServiceImpl implements PayService {private PayService payService;public StaticProxyPayServiceImpl(PayService payService){this.payService = payService;}public String callback(String outTradeNo) {System.out.println("StaticProxyPayServiceImpl callback begin");String result = payService.callback(outTradeNo);System.out.println("StaticProxyPayServiceImpl callback end");return result;}public int save(int userId, int productId) {System.out.println("StaticProxyPayServiceImpl save begin");int id = payService.save(userId, productId);System.out.println("StaticProxyPayServiceImpl save end");return id;}
}public class ProxyTest {public static void main(String[] args) {PayService payService = new PayServiceImpl();payService.callback("5555");//- 代理类中出现大量冗余的代码,非常不利于扩展和维护//- 如果接口增加一个方法,除了所有实现类需要实现这个方法外,所有代理类也需要实现此方法。增加了代码维护的复杂度PayService staticPayService = new StaticProxyPayServiceImpl(payService);staticPayService.callback("66666");}
}
什么是动态代理
在程序运行时,运用反射机制动态创建而成,无需手动编写代码。JDK动态代理与静态代理一样,目标类需要实现一个代理接口,再通过代理对象调用目标方法。常见实现方式:1)JDK动态代理:实现了被代理对象的接口, 要求目标对象实现一个接口;2)CGLIB动态代理。
其核心方法在于定义一个java.lang.reflect.InvocationHandler接口的实现类,然后重写invoke方法。
//Object proxy:被代理的对象
//Method method:要调用的方法
//Object[] args:方法调用时所需要参数
public interface InvocationHandler { public Object invoke(Object proxy, Method method, Object[] args) throws Throwable;
}
具体代码
public class JdkProxy implements InvocationHandler {//目标类private Object targetObject;//获取代理对象public Object getProxyInstance(Object targetObject){this. targetObject = targetObject;//绑定关系,也就是和具体的哪个实现类关联return Proxy.newProxyInstance(targetObject.getClass().getClassLoader(),// 目标类的类加载targetObject.getClass().getInterfaces(), // 需要代理的接口,可指定多个this);}public Object invoke(Object proxy, Method method, Object[] args) {Object result = null;try{System.out.println("通过JDK动态代理调用 "+method.getName() +", 打印日志 begin");result = method.invoke(targetObject,args);System.out.println("通过JDK动态代理调用 "+method.getName() +", 打印日志 end");}catch (Exception e){e.printStackTrace();}return result;}
}public class ProxyTest public static void main(String[] args) {PayService payService = new PayServiceImpl();//JDK动态代理JdkProxy jdkProxy = new JdkProxy();//获取代理类对象PayService proxyInstance = (PayService)jdkProxy.getProxyInstance(payService);//目标类新增方法,代理类不需要实现此方法,更好的维护proxyInstance.callback("proxy00000");proxyInstance.save(12,333);}
}