Guía para la reflexión de Java

1. Información general

En este artículo, exploraremos la reflexión de Java, que nos permite inspeccionar o modificar los atributos de tiempo de ejecución de clases, interfaces, campos y métodos. Esto resulta especialmente útil cuando no conocemos sus nombres en el momento de la compilación.

Además, podemos crear instancias de nuevos objetos, invocar métodos y obtener o establecer valores de campo mediante la reflexión.

2. Configuración del proyecto

Para utilizar la reflexión de Java, no es necesario que incluya jarras especiales , ninguna configuración especial o dependencias de Maven. El JDK se envía con un grupo de clases que se incluyen en el paquete java.lang.reflect específicamente para este propósito.

Entonces, todo lo que tenemos que hacer es realizar la siguiente importación en nuestro código:

import java.lang.reflect.*;

y estamos listos para ir.

Para obtener acceso a la información de clase, método y campo de una instancia, llamamos al método getClass que devuelve la representación de la clase en tiempo de ejecución del objeto. El objeto de clase devuelto proporciona métodos para acceder a información sobre una clase.

3. Ejemplo simple

Para mojarnos los pies, vamos a echar un vistazo a un ejemplo muy básico que inspecciona los campos de un objeto Java simple en tiempo de ejecución.

Creemos una clase Person simple con solo campos de nombre y edad y sin ningún método. Aquí está la clase Person:

public class Person { private String name; private int age; }

Ahora usaremos la reflexión de Java para descubrir los nombres de todos los campos de esta clase. Para apreciar el poder de la reflexión, construiremos un objeto Person y usaremos Object como tipo de referencia:

@Test public void givenObject_whenGetsFieldNamesAtRuntime_thenCorrect() { Object person = new Person(); Field[] fields = person.getClass().getDeclaredFields(); List actualFieldNames = getFieldNames(fields); assertTrue(Arrays.asList("name", "age") .containsAll(actualFieldNames)); }

Esta prueba nos muestra que somos capaces de obtener una matriz de M ield objetos de nuestra persona objeto, incluso si la referencia al objeto es un tipo principal de dicho objeto.

En el ejemplo anterior, solo nos interesaban los nombres de esos campos, pero se puede hacer mucho más y veremos más ejemplos de esto en las secciones siguientes.

Observe cómo usamos un método auxiliar para extraer los nombres de campo reales, es un código muy básico:

private static List getFieldNames(Field[] fields) { List fieldNames = new ArrayList(); for (Field field : fields) fieldNames.add(field.getName()); return fieldNames; }

4. Casos de uso de Java Reflection

Antes de continuar con las diferentes características de la reflexión de Java, discutiremos algunos de los usos comunes que podemos encontrarle. La reflexión de Java es extremadamente poderosa y puede resultar muy útil de varias maneras.

Por ejemplo, en muchos casos, tenemos una convención de nomenclatura para las tablas de bases de datos. Podemos optar por agregar consistencia fijando previamente los nombres de nuestras tablas con tbl_ , de modo que una tabla con datos de estudiantes se llame tbl_student_data .

En tales casos, podemos nombrar el objeto Java que contiene los datos del estudiante como Student o StudentData. Luego, utilizando el paradigma CRUD, tenemos un punto de entrada para cada operación, de modo que las operaciones de creación solo reciben un parámetro de objeto .

Luego usamos la reflexión para recuperar el nombre del objeto y los nombres de los campos. En este punto, podemos asignar estos datos a una tabla de base de datos y asignar los valores del campo de objeto a los nombres de campo de la base de datos apropiados.

5. Inspección de clases de Java

En esta sección, exploraremos el componente más fundamental de la API de reflexión de Java. Los objetos de clase Java, como mencionamos anteriormente, nos dan acceso a los detalles internos de cualquier objeto.

Vamos a examinar detalles internos como el nombre de clase de un objeto, modificadores, campos, métodos, interfaces implementadas, etc.

5.1. Preparándose

Para tener un control firme sobre la API de reflexión, aplicada a las clases de Java y tener ejemplos con variedad, crearemos una clase Animal abstracta que implementa la interfaz Eating . Esta interfaz define el comportamiento alimentario de cualquier objeto Animal concreto que creamos.

Entonces, en primer lugar, aquí está la interfaz Eating :

public interface Eating { String eats(); }

y luego la implementación Animal concreta de la interfaz Eating :

public abstract class Animal implements Eating { public static String CATEGORY = "domestic"; private String name; protected abstract String getSound(); // constructor, standard getters and setters omitted }

Creemos también otra interfaz llamada Locomotion que describe cómo se mueve un animal:

public interface Locomotion { String getLocomotion(); }

Ahora crearemos una clase concreta llamada Goat que extiende Animal e implementa Locomotion . Dado que la superclase implementa Eating , Goat también tendrá que implementar los métodos de esa interfaz:

public class Goat extends Animal implements Locomotion { @Override protected String getSound() { return "bleat"; } @Override public String getLocomotion() { return "walks"; } @Override public String eats() { return "grass"; } // constructor omitted }

Desde este punto en adelante, usaremos la reflexión de Java para inspeccionar aspectos de los objetos de Java que aparecen en las clases e interfaces anteriores.

5.2. Nombres de clases

Comencemos obteniendo el nombre de un objeto de la Clase :

@Test public void givenObject_whenGetsClassName_thenCorrect() { Object goat = new Goat("goat"); Class clazz = goat.getClass(); assertEquals("Goat", clazz.getSimpleName()); assertEquals("com.baeldung.reflection.Goat", clazz.getName()); assertEquals("com.baeldung.reflection.Goat", clazz.getCanonicalName()); }

Tenga en cuenta que el método getSimpleName de Class devuelve el nombre básico del objeto tal como aparecería en su declaración. Luego, los otros dos métodos devuelven el nombre de clase completo, incluida la declaración del paquete.

Veamos también cómo podemos crear un objeto de la clase Goat si solo conocemos su nombre de clase completamente calificado:

@Test public void givenClassName_whenCreatesObject_thenCorrect(){ Class clazz = Class.forName("com.baeldung.reflection.Goat"); assertEquals("Goat", clazz.getSimpleName()); assertEquals("com.baeldung.reflection.Goat", clazz.getName()); assertEquals("com.baeldung.reflection.Goat", clazz.getCanonicalName()); }

Observe que el nombre que pasamos al método estático forName debe incluir la información del paquete. De lo contrario, obtendremos una ClassNotFoundException .

5.3. Modificadores de clase

Podemos determinar los modificadores usados ​​en una clase llamando al método getModifiers que devuelve un Integer. Cada modificador es un bit de bandera que se establece o se borra.

La clase java.lang.reflect.Modifier ofrece métodos estáticos que analizan el Integer devuelto para detectar la presencia o ausencia de un modificador específico.

Confirmemos los modificadores de algunas de las clases que definimos anteriormente:

@Test public void givenClass_whenRecognisesModifiers_thenCorrect() { Class goatClass = Class.forName("com.baeldung.reflection.Goat"); Class animalClass = Class.forName("com.baeldung.reflection.Animal"); int goatMods = goatClass.getModifiers(); int animalMods = animalClass.getModifiers(); assertTrue(Modifier.isPublic(goatMods)); assertTrue(Modifier.isAbstract(animalMods)); assertTrue(Modifier.isPublic(animalMods)); }

Podemos inspeccionar modificadores de cualquier clase ubicados en un contenedor de biblioteca que estamos importando a nuestro proyecto.

En la mayoría de los casos, es posible que necesitemos usar el enfoque forName en lugar de la instanciación completa, ya que sería un proceso costoso en el caso de clases con mucha memoria.

5.4. Información del paquete

Al usar la reflexión de Java también podemos obtener información sobre el paquete de cualquier clase u objeto. Estos datos se empaquetan dentro de la clase Package que se devuelve mediante una llamada al método getPackage en el objeto de clase.

Ejecutemos una prueba para recuperar el nombre del paquete:

@Test public void givenClass_whenGetsPackageInfo_thenCorrect() { Goat goat = new Goat("goat"); Class goatClass = goat.getClass(); Package pkg = goatClass.getPackage(); assertEquals("com.baeldung.reflection", pkg.getName()); }

5.5. Super clase

También podemos obtener la superclase de cualquier clase de Java utilizando la reflexión de Java.

In many cases, especially while using library classes or Java's builtin classes, we may not know beforehand the superclass of an object we are using, this subsection will show how to obtain this information.

So let's go ahead and determine the superclass of Goat. Additionally, we also show that java.lang.String class is a subclass of java.lang.Object class:

@Test public void givenClass_whenGetsSuperClass_thenCorrect() { Goat goat = new Goat("goat"); String str = "any string"; Class goatClass = goat.getClass(); Class goatSuperClass = goatClass.getSuperclass(); assertEquals("Animal", goatSuperClass.getSimpleName()); assertEquals("Object", str.getClass().getSuperclass().getSimpleName()); }

5.6. Implemented Interfaces

Using Java reflection, we are also able to get the list of interfaces implemented by a given class.

Let's retrieve the class types of the interfaces implemented by the Goat class and the Animal abstract class:

@Test public void givenClass_whenGetsImplementedInterfaces_thenCorrect(){ Class goatClass = Class.forName("com.baeldung.reflection.Goat"); Class animalClass = Class.forName("com.baeldung.reflection.Animal"); Class[] goatInterfaces = goatClass.getInterfaces(); Class[] animalInterfaces = animalClass.getInterfaces(); assertEquals(1, goatInterfaces.length); assertEquals(1, animalInterfaces.length); assertEquals("Locomotion", goatInterfaces[0].getSimpleName()); assertEquals("Eating", animalInterfaces[0].getSimpleName()); }

Notice from the assertions that each class implements only a single interface. Inspecting the names of these interfaces, we find that Goat implements Locomotion and Animal implements Eating, just as it appears in our code.

You may have observed that Goat is a subclass of the abstract class Animal and implements the interface method eats(), then, Goat also implements the Eating interface.

It is therefore worth noting that only those interfaces that a class explicitly declares as implemented with the implements keyword appear in the returned array.

So even if a class implements interface methods because its superclass implements that interface, but the subclass does not directly declare that interface with the implements keyword, then that interface will not appear in the array of interfaces.

5.7. Constructors, Methods, and Fields

With Java reflection, we are able to inspect the constructors of any object's class as well as methods and fields.

We will, later on, be able to see deeper inspections on each of these components of a class but for now, it suffices to just get their names and compare them with what we expect.

Let's see how to get the constructor of the Goat class:

@Test public void givenClass_whenGetsConstructor_thenCorrect(){ Class goatClass = Class.forName("com.baeldung.reflection.Goat"); Constructor[] constructors = goatClass.getConstructors(); assertEquals(1, constructors.length); assertEquals("com.baeldung.reflection.Goat", constructors[0].getName()); }

We can also inspect the fields of the Animal class like so:

@Test public void givenClass_whenGetsFields_thenCorrect(){ Class animalClass = Class.forName("com.baeldung.reflection.Animal"); Field[] fields = animalClass.getDeclaredFields(); List actualFields = getFieldNames(fields); assertEquals(2, actualFields.size()); assertTrue(actualFields.containsAll(Arrays.asList("name", "CATEGORY"))); }

Just like we can inspect the methods of the Animal class:

@Test public void givenClass_whenGetsMethods_thenCorrect(){ Class animalClass = Class.forName("com.baeldung.reflection.Animal"); Method[] methods = animalClass.getDeclaredMethods(); List actualMethods = getMethodNames(methods); assertEquals(4, actualMethods.size()); assertTrue(actualMethods.containsAll(Arrays.asList("getName", "setName", "getSound"))); }

Just like getFieldNames, we have added a helper method to retrieve method names from an array of Method objects:

private static List getMethodNames(Method[] methods) { List methodNames = new ArrayList(); for (Method method : methods) methodNames.add(method.getName()); return methodNames; }

6. Inspecting Constructors

With Java reflection, we can inspect constructors of any class and even create class objects at runtime. This is made possible by the java.lang.reflect.Constructor class.

Earlier on, we only looked at how to get the array of Constructor objects, from which we were able to get the names of the constructors.

In this section, we will focus on how to retrieve specific constructors. In Java, as we know, no two constructors of a class share exactly the same method signature. So we will use this uniqueness to get one constructor from many.

To appreciate the features of this class, we will create a Bird subclass of Animal with three constructors. We will not implement Locomotion so that we can specify that behavior using a constructor argument, to add still more variety:

public class Bird extends Animal { private boolean walks; public Bird() { super("bird"); } public Bird(String name, boolean walks) { super(name); setWalks(walks); } public Bird(String name) { super(name); } public boolean walks() { return walks; } // standard setters and overridden methods }

Let's confirm by using reflection that this class has three constructors:

@Test public void givenClass_whenGetsAllConstructors_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Constructor[] constructors = birdClass.getConstructors(); assertEquals(3, constructors.length); }

Next, we will retrieve each constructor for the Bird class by passing the constructor's parameter class types in declared order:

@Test public void givenClass_whenGetsEachConstructorByParamTypes_thenCorrect(){ Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Constructor cons1 = birdClass.getConstructor(); Constructor cons2 = birdClass.getConstructor(String.class); Constructor cons3 = birdClass.getConstructor(String.class, boolean.class); }

There is no need for assertion since when a constructor with given parameter types in the given order does not exist, we will get a NoSuchMethodException and the test will automatically fail.

In the last test, we will see how to instantiate objects at runtime while supplying their parameters:

@Test public void givenClass_whenInstantiatesObjectsAtRuntime_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Constructor cons1 = birdClass.getConstructor(); Constructor cons2 = birdClass.getConstructor(String.class); Constructor cons3 = birdClass.getConstructor(String.class, boolean.class); Bird bird1 = (Bird) cons1.newInstance(); Bird bird2 = (Bird) cons2.newInstance("Weaver bird"); Bird bird3 = (Bird) cons3.newInstance("dove", true); assertEquals("bird", bird1.getName()); assertEquals("Weaver bird", bird2.getName()); assertEquals("dove", bird3.getName()); assertFalse(bird1.walks()); assertTrue(bird3.walks()); }

We instantiate class objects by calling the newInstance method of Constructor class and passing the required parameters in declared order. We then cast the result to the required type.

It's also possible to call the default constructor using the Class.newInstance() method. However, this method has been deprecated since Java 9, and we shouldn't use it in modern Java projects.

For bird1, we use the default constructor which from our Bird code, automatically sets the name to bird and we confirm that with a test.

We then instantiate bird2 with only a name and test as well, remember that when we don't set locomotion behavior as it defaults to false, as seen in the last two assertions.

7. Inspecting Fields

Previously, we only inspected the names of fields, in this section, we will show how toget and set their values at runtime.

There are two main methods used to inspect fields of a class at runtime: getFields() and getField(fieldName).

The getFields() method returns all accessible public fields of the class in question. It will return all the public fields in both the class and all superclasses.

For instance, when we call this method on the Bird class, we will only get the CATEGORY field of its superclass, Animal, since Bird itself does not declare any public fields:

@Test public void givenClass_whenGetsPublicFields_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Field[] fields = birdClass.getFields(); assertEquals(1, fields.length); assertEquals("CATEGORY", fields[0].getName()); }

This method also has a variant called getField which returns only one Field object by taking the name of the field:

@Test public void givenClass_whenGetsPublicFieldByName_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Field field = birdClass.getField("CATEGORY"); assertEquals("CATEGORY", field.getName()); }

We are not able to access private fields declared in superclasses and not declared in the child class. This is why we are not able to access the name field.

However, we can inspect private fields declared in the class we are dealing with by calling the getDeclaredFields method:

@Test public void givenClass_whenGetsDeclaredFields_thenCorrect(){ Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Field[] fields = birdClass.getDeclaredFields(); assertEquals(1, fields.length); assertEquals("walks", fields[0].getName()); }

We can also use its other variant in case we know the name of the field:

@Test public void givenClass_whenGetsFieldsByName_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Field field = birdClass.getDeclaredField("walks"); assertEquals("walks", field.getName()); }

If we get the name of the field wrong or type in an in-existent field, we will get a NoSuchFieldException.

We get the field type as follows:

@Test public void givenClassField_whenGetsType_thenCorrect() { Field field = Class.forName("com.baeldung.reflection.Bird") .getDeclaredField("walks"); Class fieldClass = field.getType(); assertEquals("boolean", fieldClass.getSimpleName()); }

Next, we will look at how to access field values and modify them. To be able to get the value of a field, let alone setting it, we must first set it's accessible by calling setAccessible method on the Field object and pass boolean true to it:

@Test public void givenClassField_whenSetsAndGetsValue_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Bird bird = (Bird) birdClass.getConstructor().newInstance(); Field field = birdClass.getDeclaredField("walks"); field.setAccessible(true); assertFalse(field.getBoolean(bird)); assertFalse(bird.walks()); field.set(bird, true); assertTrue(field.getBoolean(bird)); assertTrue(bird.walks()); }

In the above test, we ascertain that indeed the value of the walks field is false before setting it to true.

Notice how we use the Field object to set and get values by passing it the instance of the class we are dealing with and possibly the new value we want the field to have in that object.

One important thing to note about Field objects is that when it is declared as public static, then we don't need an instance of the class containing them, we can just pass null in its place and still obtain the default value of the field, like so:

@Test public void givenClassField_whenGetsAndSetsWithNull_thenCorrect(){ Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Field field = birdClass.getField("CATEGORY"); field.setAccessible(true); assertEquals("domestic", field.get(null)); }

8. Inspecting Methods

In a previous example, we used reflection only to inspect method names. However, Java reflection is more powerful than that.

With Java reflection, we can invoke methods at runtime and pass them their required parameters, just like we did for constructors. Similarly, we can also invoke overloaded methods by specifying parameter types of each.

Just like fields, there are two main methods that we use for retrieving class methods. The getMethods method returns an array of all public methods of the class and superclasses.

This means that with this method, we can get public methods of the java.lang.Object class like toString, hashCode, and notifyAll:

@Test public void givenClass_whenGetsAllPublicMethods_thenCorrect(){ Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Method[] methods = birdClass.getMethods(); List methodNames = getMethodNames(methods); assertTrue(methodNames.containsAll(Arrays .asList("equals", "notifyAll", "hashCode", "walks", "eats", "toString"))); }

To get only public methods of the class we are interested in, we have to use getDeclaredMethods method:

@Test public void givenClass_whenGetsOnlyDeclaredMethods_thenCorrect(){ Class birdClass = Class.forName("com.baeldung.reflection.Bird"); List actualMethodNames = getMethodNames(birdClass.getDeclaredMethods()); List expectedMethodNames = Arrays .asList("setWalks", "walks", "getSound", "eats"); assertEquals(expectedMethodNames.size(), actualMethodNames.size()); assertTrue(expectedMethodNames.containsAll(actualMethodNames)); assertTrue(actualMethodNames.containsAll(expectedMethodNames)); }

Each of these methods has the singular variation which returns a single Method object whose name we know:

@Test public void givenMethodName_whenGetsMethod_thenCorrect() throws Exception { Bird bird = new Bird(); Method walksMethod = bird.getClass().getDeclaredMethod("walks"); Method setWalksMethod = bird.getClass().getDeclaredMethod("setWalks", boolean.class); assertTrue(walksMethod.canAccess(bird)); assertTrue(setWalksMethod.canAccess(bird)); }

Notice how we retrieve individual methods and specify what parameter types they take. Those that don't take parameter types are retrieved with an empty variable argument, leaving us with only a single argument, the method name.

Next, we will show how to invoke a method at runtime. We know by default that the walks attribute of the Bird class is false, we want to call its setWalks method and set it to true:

@Test public void givenMethod_whenInvokes_thenCorrect() { Class birdClass = Class.forName("com.baeldung.reflection.Bird"); Bird bird = (Bird) birdClass.getConstructor().newInstance(); Method setWalksMethod = birdClass.getDeclaredMethod("setWalks", boolean.class); Method walksMethod = birdClass.getDeclaredMethod("walks"); boolean walks = (boolean) walksMethod.invoke(bird); assertFalse(walks); assertFalse(bird.walks()); setWalksMethod.invoke(bird, true); boolean walks2 = (boolean) walksMethod.invoke(bird); assertTrue(walks2); assertTrue(bird.walks()); }

Observe cómo primero invocamos el método de paseos y lanzamos el tipo de retorno al tipo de datos apropiado y luego verificamos su valor. Luego, más tarde invocamos el método setWalks para cambiar ese valor y probar nuevamente.

9. Conclusión

En este tutorial, hemos cubierto la API de reflexión de Java y hemos visto cómo usarla para inspeccionar clases, interfaces, campos y métodos en tiempo de ejecución sin conocimiento previo de sus componentes internos en tiempo de compilación.

El código fuente completo y los ejemplos de este tutorial se pueden encontrar en GitHub.