Java Tutorial da API Reflection com exemplo

O que é reflexão Java?

Java A reflexão é o processo de analisar e modificar todas as capacidades de uma classe em tempo de execução. A API de Reflexão em Java É utilizado para manipular uma classe e seus membros, incluindo campos, métodos, construtores, etc., em tempo de execução.

Uma das vantagens da API de Reflexão é Java É que também pode manipular os membros privados da classe.

O pacote java.lang.reflect fornece várias classes para implementar reflexão. Os métodos da classe java.lang.Class são usados ​​para coletar os metadados completos de uma classe específica.

Classe no pacote java.lang.reflect

Segue uma lista de vário Java aulas No pacote java.lang.reflect para implementar reflexão:

• Campo: Essa classe é usada para reunir informações declarativas, como o tipo de dados, o modificador de acesso, o nome e o valor de uma variável.
• Método: Essa classe é usada para reunir informações declarativas, como o modificador de acesso, o tipo de retorno, o nome, os tipos de parâmetros e o tipo de exceção de um método.
• Construtor: Esta classe é usada para reunir informações declarativas, como o modificador de acesso, o nome e os tipos de parâmetros de um construtor.
• Editar: Esta classe é usada para coletar informações sobre um modificador de acesso específico.

Métodos usados ​​em java.lang.Class

• public String getName(): Retorna o nome da classe.
• public Class getSuperclass(): Retorna a referência da superclasse.
• public Class[] getInterfaces(): Retorna uma matriz de interfaces implementadas pela classe especificada.
• public int getModifiers(): Retorna um valor inteiro representando os modificadores da classe especificada, que precisa ser passado como parâmetro para o método “public static String toString(int i)” que retorna o especificador de acesso para a classe fornecida.

Como obter informações completas sobre uma aula

Para obter informações sobre variáveisPara acessar os métodos e construtores de uma classe, precisamos criar um objeto dessa classe. O exemplo a seguir mostra diferentes maneiras de criar um objeto da classe "Classe":

public class Guru99ClassObjectCreation {
    public static void main(String[] args) throws ClassNotFoundException {
        // 1 - By using Class.forName() method
        Class c1 = Class.forName("Guru99ClassObjectCreation");
        // 2 - By using getClass() method
        Guru99ClassObjectCreation guru99Obj = new Guru99ClassObjectCreation();
        Class c2 = guru99Obj.getClass();
        // 3 - By using .class
        Class c3 = Guru99ClassObjectCreation.class;
    }
}

Exemplo 1: Como obter os metadados de uma classe

O exemplo a seguir mostra como obter metadados como o nome da classe, o nome da superclasse, as interfaces implementadas e os modificadores de acesso de uma classe.

Obteremos os metadados da classe abaixo, com o nome especificado. Guru99Base.class:

import java.io.Serializable;
public abstract class Guru99Base implements Serializable, Cloneable {
}

1. O nome da classe é: Guru99Base
2. Seus modificadores de acesso são: público e absoluto.tract
3. Possui interfaces implementadas: Serializable e Cloneable
4. Como não estende explicitamente nenhuma classe, sua superclasse é: java.lang.Object

A classe abaixo obterá os metadados de Guru99Base.class e imprima-o:

import java.lang.reflect.Modifier;
public class Guru99GetclassMetaData {
    public static void main(String[] args) throws ClassNotFoundException {
        // Create Class object for Guru99Base.class
        Class<Guru99Base> guru99ClassObj = Guru99Base.class;

        // Print name of the class
        System.out.println("Name of the class is : " + guru99ClassObj.getName());

        // Print super class name
        System.out.println("Name of the super class is : " + guru99ClassObj.getSuperclass().getName());

        // Get the list of implemented interfaces using getInterfaces() method
        Class[] guru99InterfaceList = guru99ClassObj.getInterfaces();

        // Print the implemented interfaces using a for-each loop
        System.out.print("Implemented interfaces are : ");
        for (Class guru99class1 : guru99InterfaceList) {
            System.out.print(guru99class1.getName() + " ");
        }
        System.out.println();

        // Get access modifiers using getModifiers() and Modifier.toString()
        int guru99AccessModifier = guru99ClassObj.getModifiers();
        System.out.println("Access modifiers of the class are : " + Modifier.toString(guru99AccessModifier));
    }
}

1. Imprima o nome da classe usando o método getName().
2. Imprima o nome da superclasse usando o método getSuperclass().getName().
3. Imprima os nomes das interfaces implementadas.
4. Imprima os modificadores de acesso usados ​​pela classe.

Exemplo 2: Como obter os metadados de uma variável

O exemplo a seguir mostra como obter os metadados de uma variável.

Aqui, estamos criando uma classe chamada Guru99VariableMetaData.class com algumas variáveis:

package guru;
public class Guru99VariableMetaData {
    public static int guru99IntVar1 = 1111;
    static int guru99IntVar2 = 2222;
    static String guru99StringVar1 = "guru99.com";
    static String guru99StringVar2 = "Learning Reflection API";
}

Etapas para obter os metadados sobre as variáveis ​​da classe acima:

1. Crie o objeto da classe acima, ou seja, Guru99VariableMetaData.class, como abaixo:

   Guru99VariableMetaData guru99ClassVar = new Guru99VariableMetaData();
   Class guru99ClassObjVar = guru99ClassVar.getClass();

2. Obtenha os metadados na forma de uma matriz de campos usando o getFields() or getDeclaredFields () métodos como abaixo:

   Field[] guru99Field1 = guru99ClassObjVar.getFields();
   Field[] guru99Field2 = guru99ClassObjVar.getDeclaredFields();

O getFields() O método retorna os metadados das variáveis ​​públicas da classe especificada, bem como de sua superclasse.

O getDeclaredFields () O método retorna os metadados de todas as variáveis ​​apenas da classe especificada.

3. Obtenha o nome das variáveis ​​usando o método “public String getName()”.
4. Obtenha o tipo de dados das variáveis ​​usando o método “public Class getType()”.
5. Obtenha o valor da variável usando o método “public xxx get(Field)”. Aqui, xxx pode ser um byte, um short ou qualquer tipo de valor que você queira obter.
6. Obtenha os modificadores de acesso das variáveis ​​usando os métodos getModifiers() e Modifier.toString(int i).

Aqui, estamos escrevendo uma classe para obter os metadados das variáveis ​​presentes na classe. Guru99VariableMetaData.class:

package guru;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;

public class Guru99VariableMetaDataTest {
    public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException {
        // Create Class object for Guru99VariableMetaData.class
        Guru99VariableMetaData guru99ClassVar = new Guru99VariableMetaData();
        Class guru99ClassObjVar = guru99ClassVar.getClass();

        // Get the metadata of all the fields of the class
        Field[] guru99Field1 = guru99ClassObjVar.getDeclaredFields();

        // Print name, data types, access modifiers and values of the variables
        for (Field field : guru99Field1) {
            System.out.println("Variable name : " + field.getName());
            System.out.println("Datatype of the variable : " + field.getType());

            int guru99AccessModifiers = field.getModifiers();
            System.out.println("Access Modifiers of the variable : " + Modifier.toString(guru99AccessModifiers));
            System.out.println("Value of the variable : " + field.get(guru99ClassVar));
            System.out.println();
        }
    }
}

1. Criou-se um objeto de classe para Guru99VariableMetaData.class.
2. Obtive todos os metadados das variáveis ​​em uma matriz de campos.
3. Imprimiu todos os nomes de variáveis ​​da classe. Guru99VariableMetaData.class.
4. Imprimiu todos os tipos de dados das variáveis ​​da classe.
5. Imprimiu todos os modificadores de acesso das variáveis ​​da classe.
6. Imprimiu os valores de todas as variáveis ​​da classe.

Exemplo 3: Como obter os metadados de um método

O exemplo a seguir mostra como obter os metadados de um método.

Aqui, estamos criando uma classe chamada Guru99MethodMetaData.class com alguns métodos:

package guru;
import java.sql.SQLException;
public class Guru99MethodMetaData {

    public void guru99Add(int firstElement, int secondElement, String result)
    throws ClassNotFoundException, ClassCastException {
        System.out.println("Demo method for Reflection API");
    }
    public String guru99Search(String searchString)
    throws ArithmeticException, InterruptedException {
        System.out.println("Demo method for Reflection API");
        return null;
    }
    public void guru99Delete(String deleteString)
    throws SQLException {
        System.out.println("Demo method for Reflection API");
    }
}

Passos para obter os metadados sobre os métodos na classe acima:

1. Crie o objeto da classe acima, ou seja, Guru99MethodMetaData.class, conforme abaixo:

   Guru99MethodMetaData guru99ClassVar = new Guru99MethodMetaData();
   Class guru99ClassObjVar = guru99ClassVar.getClass();

2. Obtenha informações sobre os métodos em um array de métodos usando os métodos getMethods() e getDeclaredMethods(), conforme abaixo:

   Method[] guru99Method1 = guru99ClassObjVar.getMethods();
   Method[] guru99Method2 = guru99ClassObjVar.getDeclaredMethods();

   O getMethods() O método retorna os metadados dos métodos públicos da classe especificada, bem como de sua superclasse. getDeclaredMethods() O método retorna os metadados de todos os métodos da classe especificada.

3. Obtenha o nome do método usando o getName () método.
4. Obtenha o tipo de retorno do método usando o getReturnType() método.
5. Obtenha os modificadores de acesso dos métodos usando o getModifiers() e Modificador.toString(int i) métodos.
6. Obtenha os tipos de parâmetros do método usando o getParameterTypes() método, que retorna um array de classes.
7. Obtenha exceções lançadas usando o getExceptionTypes() método, que retorna um array de classes.

Aqui, estamos escrevendo uma classe para obter os metadados dos métodos presentes na classe. Guru99MethodMetaData.class:

package guru;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;

public class Guru99MethodMetaDataTest {

    public static void main(String[] args) {
        // Create Class object for Guru99MethodMetaData.class
        Class guru99ClassObj = Guru99MethodMetaData.class;

        // Get the metadata of all the methods using getDeclaredMethods()
        Method[] guru99Methods = guru99ClassObj.getDeclaredMethods();

        for (Method method : guru99Methods) {
            System.out.println("Name of the method : " + method.getName());
            System.out.println("Return type of the method : " + method.getReturnType());

            int guru99ModifierList = method.getModifiers();
            System.out.println("Method access modifiers : " + Modifier.toString(guru99ModifierList));

            Class[] guru99ParamList = method.getParameterTypes();
            System.out.print("Method parameter types : ");
            for (Class class1 : guru99ParamList) {
                System.out.print(class1.getName() + " ");
            }
            System.out.println();

            Class[] guru99ExceptionList = method.getExceptionTypes();
            System.out.print("Exception thrown by method : ");
            for (Class class1 : guru99ExceptionList) {
                System.out.print(class1.getName() + " ");
            }
            System.out.println();
        }
    }
}

1. Criou-se um objeto de classe para Guru99MethodMetaData.class.
2. Obtive todos os metadados de todos os métodos em uma matriz de métodos.
3. Imprimiu todos os nomes de métodos presentes na classe.
4. Imprimiu os tipos de retorno dos métodos da classe.
5. Imprimiu todos os modificadores de acesso dos métodos da classe.
6. Imprimiu os tipos de parâmetros dos métodos.
7. Imprimiu as exceções lançadas pelos métodos.

Exemplo 4: Como obter metadados de construtores

O exemplo a seguir mostra como obter os metadados dos construtores.

Aqui, estamos criando uma classe chamada Guru99Constructor.class com diferentes construtores:

package guru;

import java.rmi.RemoteException;
import java.sql.SQLException;

public class Guru99Constructor {

    public Guru99Constructor(int no) throws ClassCastException, ArithmeticException { }
    public Guru99Constructor(int no, String name) throws RemoteException, SQLException { }
    public Guru99Constructor(int no, String name, String address) throws InterruptedException { }
}

Aqui, estamos escrevendo uma classe para obter os metadados dos construtores presentes na classe. Guru99Constructor.class:

package guru;
import java.lang.reflect.Constructor;
import java.lang.reflect.Modifier;
public class Guru99ConstructorMetaDataTest {

    public static void main(String[] args) {
        // Create Class object for Guru99Constructor.class
        Class guru99Class = Guru99Constructor.class;

        // Get all the constructor information in the Constructor array
        Constructor[] guru99ConstructorList = guru99Class.getConstructors();

        for (Constructor constructor : guru99ConstructorList) {
            System.out.println("Constructor name : " + constructor.getName());

            int guru99Modifiers = constructor.getModifiers();
            System.out.println("Constructor modifier : " + Modifier.toString(guru99Modifiers));

            Class[] guru99ParamList = constructor.getParameterTypes();
            System.out.print("Constructor parameter types : ");
            for (Class class1 : guru99ParamList) {
                System.out.print(class1.getName() + " ");
            }
            System.out.println();

            Class[] guru99ExceptionList = constructor.getExceptionTypes();
            System.out.print("Exception thrown by constructors : ");
            for (Class class1 : guru99ExceptionList) {
                System.out.print(class1.getName() + " ");
            }
            System.out.println();
        }
    }
}

1. Criou-se um objeto de classe para Guru99Construtor.classe.
2. Obtive todos os metadados de todos os construtores em um array de construtores.
3. Imprimiu todos os nomes dos construtores presentes na classe.
4. Imprimiu todos os modificadores de acesso dos construtores da classe.
5. Imprimiu os tipos de parâmetros dos construtores.
6. Imprimiu as exceções lançadas pelos construtores.

Perguntas Frequentes