java 非常好用的反射框架Reflections介紹

更新時(shí)間：2021年04月08日 10:08:17 作者：wei906

這篇文章主要介紹了java 反射框架Reflections的使用，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

Reflections通過(guò)掃描classpath，索引元數(shù)據(jù)，并且允許在運(yùn)行時(shí)查詢(xún)這些元數(shù)據(jù)。

使用Reflections可以很輕松的獲取以下元數(shù)據(jù)信息：

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

2）獲取某個(gè)注解的所有類(lèi)型/字段變量，支持注解參數(shù)匹配。

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

4）獲取特定簽名方法。

通常的用法有：

引入依賴(lài)jar

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

項(xiàng)目中使用：

// 初始化工具類(lèi)
Reflections reflections = new Reflections(new ConfigurationBuilder().forPackages(basePackages).addScanners(new SubTypesScanner()).addScanners(new FieldAnnotationsScanner()));
 
// 獲取某個(gè)包下類(lèi)型注解對(duì)應(yīng)的類(lèi)
Set<Class<?>> typeClass = reflections.getTypesAnnotatedWith(RpcInterface.class, true);
 
// 獲取子類(lèi)
Set<Class<? extends SomeType>> subTypes = reflections.getSubTypesOf(SomeType.class);
 
// 獲取注解對(duì)應(yīng)的方法
Set<Method> resources =reflections.getMethodsAnnotatedWith(SomeAnnotation.class);
 
// 獲取注解對(duì)應(yīng)的字段
Set<Field> ids = reflections.getFieldsAnnotatedWith(javax.persistence.Id.class);
 
// 獲取特定參數(shù)對(duì)應(yīng)的方法
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"));

具體也可以參見(jiàn)官方文檔

補(bǔ)充：Java中的反射：框架設(shè)計(jì)的靈魂

反射：框架設(shè)計(jì)的靈魂

框架：半成品軟件?？梢栽诳蚣艿幕A(chǔ)上進(jìn)行軟件開(kāi)發(fā)，簡(jiǎn)化編碼

反射：將類(lèi)的各個(gè)組成部分封裝為其他對(duì)象，這就是反射機(jī)制

好處：

1.可以在程序運(yùn)行過(guò)程中，操作這些對(duì)象。

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

獲取Class對(duì)象的方式：

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

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

2.類(lèi)名.class：通過(guò)類(lèi)名的屬性class獲取

多用于參數(shù)的傳遞

3.對(duì)象.getClass()：getClass()方法在Object類(lèi)中定義著。

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

結(jié)論：

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

例如我們有一個(gè)Person類(lèi)

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 +
                '}';
    }
}

我們寫(xiě)一個(gè)Demo用三種方式來(lái)獲取Class對(duì)象

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

Class對(duì)象功能：

獲取功能：

1.獲取成員變量們

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

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

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

Field getDeclaredField(String name)

2.獲取構(gòu)造方法們

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

3.獲取成員方法們：

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

4.獲取全類(lèi)名

String getName() * Field：成員變量

操作：

5.設(shè)置值

void set(Object obj, Object value)

6.獲取值

get(Object obj)

7.忽略訪(fǎng)問(wèn)權(quán)限修飾符的安全檢查

setAccessible(true):暴力反射

Constructor:構(gòu)造方法

創(chuàng)建對(duì)象：

T newInstance(Object… initargs)

如果使用空參數(shù)構(gòu)造方法創(chuàng)建對(duì)象，操作可以簡(jiǎn)化：Class對(duì)象的newInstance方法* Method：方法對(duì)象

執(zhí)行方法：

Object invoke(Object obj, Object… args)

獲取方法名稱(chēng)：

String getName:獲取方法名

同樣對(duì)于上面的Person類(lèi)我們對(duì)其新增帶參數(shù)和不帶參數(shù)的sleep方法并且寫(xiě)一個(gè)Demo來(lái)獲取這些成員變量，構(gòu)造方法以及成員方法

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");//設(shè)置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);
        //獲取構(gòu)造方法
        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);
        }
    }
}

運(yùn)行結(jié)果如下：

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()

案例

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

實(shí)現(xiàn)：

1. 配置文件

2. 反射

步驟：

1. 將需要?jiǎng)?chuàng)建的對(duì)象的全類(lèi)名和需要執(zhí)行的方法定義在配置文件中

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

3. 使用反射技術(shù)來(lái)加載類(lèi)文件進(jìn)內(nèi)存

4. 創(chuàng)建對(duì)象

5. 執(zhí)行方法

為了實(shí)現(xiàn)創(chuàng)建任意類(lèi)的對(duì)象，并且執(zhí)行其中任意方法，我們?cè)僭蠵erson.java文件基礎(chǔ)上新增Student.java,代碼如下：

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

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

className=man.Student
methodName=sleep

接著我們來(lái)寫(xiě)這個(gè)案例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);
        //獲取配置文件中定義的數(shù)據(jù)
        String className = pro.getProperty("className");
        String methodName = pro.getProperty("methodName");
        //加載該類(lèi)進(jìn)內(nèi)存
        Class cls = Class.forName(className);
        Object obj = cls.newInstance();
        Method method = cls.getMethod(methodName);
        method.invoke(obj);
    }
}

這樣我們只需改變配置文件中的信息而不需要去改變?nèi)魏未a就可以實(shí)現(xiàn)類(lèi)以及類(lèi)中的方法,整個(gè)目錄結(jié)構(gòu)如下