淺談Java中的反射框架Reflections 附實例代碼

Reflections通過掃描classpath，索引元數據，并且允許在運行時查詢這些元數據。本篇文章將和大家分享一下這個 Java 中非常好用的反射框架--Reflections，詳情內容如下:

使用Reflections可以很輕松的獲取以下元數據信息：

1）獲取某個類型的所有子類；比如，有一個父類是TestInterface，可以獲取到TestInterface的所有子類。

2）獲取某個注解的所有類型/字段變量，支持注解參數匹配。

3）使用正則表達式獲取所有匹配的資源文件

4）獲取特定簽名方法。

通常的用法有：

引入依賴jar

<dependency>
    <groupId>org.reflections</groupId>
    <artifactId>reflections</artifactId>
    <version>0.9.10</version>
</dependency>

項目中使用：

// 初始化工具類
Reflections reflections = new Reflections(new ConfigurationBuilder().forPackages(basePackages).addScanners(new SubTypesScanner()).addScanners(new FieldAnnotationsScanner()));
 
// 獲取某個包下類型注解對應的類
Set<Class<?>> typeClass = reflections.getTypesAnnotatedWith(RpcInterface.class, true);
 
// 獲取子類
Set<Class<? extends SomeType>> subTypes = reflections.getSubTypesOf(SomeType.class);
 
// 獲取注解對應的方法
Set<Method> resources =reflections.getMethodsAnnotatedWith(SomeAnnotation.class);
 
// 獲取注解對應的字段
Set<Field> ids = reflections.getFieldsAnnotatedWith(javax.persistence.Id.class);
 
// 獲取特定參數對應的方法
Set<Method> someMethods = reflections.getMethodsMatchParams(long.class, int.class);
 
Set<Method> voidMethods = reflections.getMethodsReturn(void.class);
 
Set<Method> pathParamMethods =reflections.getMethodsWithAnyParamAnnotated(PathParam.class);
 
// 獲取資源文件
Set<String> properties = reflections.getResources(Pattern.compile(".*\.properties"));

具體也可以參見官方文檔

補充：Java中的反射：框架設計的靈魂

反射：框架設計的靈魂

框架：半成品軟件。可以在框架的基礎上進行軟件開發(fā)，簡化編碼

反射：將類的各個組成部分封裝為其他對象，這就是反射機制

好處：

1.可以在程序運行過程中，操作這些對象。

2.可以解耦，提高程序的可擴展性。

獲取Class對象的方式：

1.Class.forName(“全類名”)：將字節(jié)碼文件加載進內存，返回Class對象

多用于配置文件，將類名定義在配置文件中。讀取文件，加載類

2.類名.class：通過類名的屬性class獲取

多用于參數的傳遞

3.對象.getClass()：getClass()方法在Object類中定義著。

多用于對象的獲取字節(jié)碼的方式

結論：

同一個字節(jié)碼文件(*.class)在一次程序運行過程中，只會被加載一次，不論通過哪一種方式獲取的Class對象都是同一個。

例如我們有一個Person類

public class Person {
    private String name;
    private int age;
    public Person(){
    }
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + ''' +
                ", age=" + age +
                '}';
    }
}

我們寫一個Demo用三種方式來獲取Class對象

public class Demo1 {
    public static void main(String [] args) throws Exception {
        //1、Class.forName("類名")
        Class cls1 = Class.forName("man.Person");
        System.out.println(cls1);
        //2、類名。class
        Class cls2= Person.class;
        System.out.println(cls2);
        //3、對象.getClass()
        Person p = new Person();
        Class cls3=p.getClass();
        System.out.println(cls3);
    }
}

Class對象功能：

獲取功能：

1.獲取成員變量們

Field[] getFields() ：獲取所有public修飾的成員變量

Field getField(String name) 獲取指定名稱的 public修飾的成員變量

Field[] getDeclaredFields() 獲取所有的成員變量，不考慮修飾符

Field getDeclaredField(String name)

2.獲取構造方法們

Constructor<?>[] getConstructors()
Constructor getConstructor(類<?>… parameterTypes)
Constructor getDeclaredConstructor(類<?>… parameterTypes)
Constructor<?>[] getDeclaredConstructors()

3.獲取成員方法們：

Method[] getMethods()
Method getMethod(String name, 類<?>… parameterTypes)
Method[] getDeclaredMethods()
Method getDeclaredMethod(String name, 類<?>… parameterTypes)

4.獲取全類名

String getName() * Field：成員變量

操作：

5.設置值

void set(Object obj, Object value)

6.獲取值

get(Object obj)

7.忽略訪問權限修飾符的安全檢查

setAccessible(true):暴力反射

Constructor:構造方法

創(chuàng)建對象：

T newInstance(Object… initargs)

如果使用空參數構造方法創(chuàng)建對象，操作可以簡化：Class對象的newInstance方法* Method：方法對象

執(zhí)行方法：

Object invoke(Object obj, Object… args)

獲取方法名稱：

String getName:獲取方法名

同樣對于上面的Person類我們對其新增帶參數和不帶參數的sleep方法并且寫一個Demo來獲取這些成員變量，構造方法以及成員方法

Person.java

public class Person {
    private String name;
    private int age;
    public String a;
    protected String b;
    String c;
    private String d;
    public Person(){
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
    public void eat(){
        System.out.println("eat...");
    }
    public void eat(String food){
        System.out.println("eat..."+food);
    }
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + ''' +
                ", age=" + age +
                ", a='" + a + ''' +
                ", b='" + b + ''' +
                ", c='" + c + ''' +
                ", d='" + d + ''' +
                '}';
    }
}

Demo2.java代碼如下：

public class Demo2 {
    public static void main(String [] args) throws Exception {
        Class<Person> personClass = Person.class;
        //獲取成員變量
        Field[] fields = personClass.getFields();
        for(Field field:fields) {
            System.out.println(field);
        }
        System.out.println("--------------");
        Field a = personClass.getField("a");//獲取a的值
        Person p = new Person();
        Object value=a.get(p);
        System.out.println(value);
        a.set(p, "zhangsan");//設置a的值
        System.out.println(p);
        System.out.println("=============");
        //獲取所有成員變量
        Field[] declaredFields = personClass.getDeclaredFields();
        for (Field declaredField : declaredFields) {
            System.out.println(declaredField);
        }
        Field d = personClass.getDeclaredField("d");
        d.setAccessible(true);//暴力反射
        Object value2 = d.get(p);
        System.out.println(value2);
        //獲取構造方法
        Constructor<Person> constructor = personClass.getConstructor(String.class, int.class);
        System.out.println(constructor);
        Object person = constructor.newInstance("張三", 23);
        System.out.println(person);
        System.out.println("=======");
        Constructor<Person> constructor1 = personClass.getConstructor();
        System.out.println(constructor1);
        Object person1 = constructor1.newInstance();
        System.out.println(person1);
        //獲取成員方法
        Method eat_method = personClass.getMethod("eat");
        Person p1 = new Person();
        eat_method.invoke(p1);
        Method eat_method1 = personClass.getMethod("eat",String.class);
        eat_method1.invoke(p1,"飯");
        System.out.println("---------");
        Method[] methods = personClass.getMethods();
        for (Method method : methods) {
            System.out.println(method);
        }
    }
}

運行結果如下：

public java.lang.String man.Person.a
-------------- null Person{name=‘null', age=0, a=‘zhangsan', b=‘null', c=‘null', d=‘null'}
============= private java.lang.String man.Person.name private int man.Person.age public java.lang.String man.Person.a protected
java.lang.String man.Person.b java.lang.String man.Person.c private
java.lang.String man.Person.d null public
man.Person(java.lang.String,int) Person{name=‘張三', age=23, a=‘null',
b=‘null', c=‘null', d=‘null'}
======= public man.Person() Person{name=‘null', age=0, a=‘null', b=‘null', c=‘null', d=‘null'} eat… eat…飯
--------- public java.lang.String man.Person.toString() public java.lang.String man.Person.getName() public void
man.Person.setName(java.lang.String) public void
man.Person.eat(java.lang.String) public void man.Person.eat() public
void man.Person.setAge(int) public int man.Person.getAge() public
final void java.lang.Object.wait() throws
java.lang.InterruptedException public final void
java.lang.Object.wait(long,int) throws java.lang.InterruptedException
public final native void java.lang.Object.wait(long) throws
java.lang.InterruptedException public boolean
java.lang.Object.equals(java.lang.Object) public native int
java.lang.Object.hashCode() public final native java.lang.Class
java.lang.Object.getClass() public final native void
java.lang.Object.notify() public final native void
java.lang.Object.notifyAll()

案例

需求：寫一個"框架"，不能改變該類的任何代碼的前提下，可以幫我們創(chuàng)建任意類的對象，并且執(zhí)行其中任意方法

實現：

1. 配置文件

2. 反射

步驟：

1. 將需要創(chuàng)建的對象的全類名和需要執(zhí)行的方法定義在配置文件中

2. 在程序中加載讀取配置文件

3. 使用反射技術來加載類文件進內存

4. 創(chuàng)建對象

5. 執(zhí)行方法

為了實現創(chuàng)建任意類的對象，并且執(zhí)行其中任意方法，我們再原有Person.java文件基礎上新增Student.java,代碼如下：

public class Student {
    public void sleep(){
        System.out.println("sleep...");
    }
}

那么我們需要在src目錄下添加pro.properties文件并寫入以下配置信息

className=man.Student
methodName=sleep

接著我們來寫這個案例ReflectTest.java,代碼如下

public class ReflectTest {
    public static void main(String [] args) throws Exception {
        //加載配置文件
        Properties pro = new Properties();
        ClassLoader classLoader = ReflectTest.class.getClassLoader();
        InputStream is = classLoader.getResourceAsStream("pro.properties");
        pro.load(is);
        //獲取配置文件中定義的數據
        String className = pro.getProperty("className");
        String methodName = pro.getProperty("methodName");
        //加載該類進內存
        Class cls = Class.forName(className);
        Object obj = cls.newInstance();
        Method method = cls.getMethod(methodName);
        method.invoke(obj);
    }
}

這樣我們只需改變配置文件中的信息而不需要去改變任何代碼就可以實現類以及類中的方法?,整個目錄結構如下

以上就是 Java 反射框架 Reflections 以及其部分功能操作的全部內容，如果想要繼續(xù)了解更多關于 Java 反射框架 Reflections 的其他內容，請繼續(xù)關注W3Cschool，如果我們的文章對您的學習有所幫助，希望大家能夠多多支持我們。