Guida a Java Reflection

1. Panoramica

In questo articolo, esploreremo la riflessione Java, che ci consente di ispezionare o / e modificare gli attributi di runtime di classi, interfacce, campi e metodi. Ciò è particolarmente utile quando non conosciamo i loro nomi in fase di compilazione.

Inoltre, possiamo creare un'istanza di nuovi oggetti, invocare metodi e ottenere o impostare valori di campo utilizzando la riflessione.

2. Configurazione del progetto

Per utilizzare la riflessione Java, non è necessario includere jars speciali, configurazioni speciali o dipendenze Maven. JDK viene fornito con un gruppo di classi che sono raggruppate nel pacchetto java.lang.reflect appositamente per questo scopo.

Quindi tutto ciò che dobbiamo fare è effettuare la seguente importazione nel nostro codice:

import java.lang.reflect.*;

e siamo a posto.

Per accedere alla classe, al metodo e alle informazioni sul campo di un'istanza, chiamiamo il metodo getClass che restituisce la rappresentazione della classe di runtime dell'oggetto. L' oggetto classe restituito fornisce metodi per accedere alle informazioni su una classe.

3. Semplice esempio

Per bagnarci i piedi, daremo un'occhiata a un esempio molto semplice che ispeziona i campi di un semplice oggetto Java in fase di runtime.

Creiamo una semplice classe Person con solo campi nome ed età e nessun metodo. Ecco la classe Person:

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

Useremo ora la riflessione Java per scoprire i nomi di tutti i campi di questa classe. Per apprezzare il potere della riflessione, costruiremo un oggetto Person e useremo Object come tipo di riferimento:

@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)); }

Questo test dimostra che noi siamo in grado di ottenere un array di F ield oggetti dalla nostra persona oggetto, anche se il riferimento all'oggetto è un tipo principale di tale oggetto.

Nell'esempio sopra, eravamo interessati solo ai nomi di quei campi, ma c'è molto di più che può essere fatto e vedremo ulteriori esempi di questo nelle sezioni successive.

Nota come utilizziamo un metodo di supporto per estrarre i nomi dei campi effettivi, è un codice molto semplice:

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

4. Casi d'uso di Java Reflection

Prima di procedere con le diverse caratteristiche della riflessione Java, discuteremo alcuni degli usi comuni che possiamo trovarne. La riflessione Java è estremamente potente e può tornare molto utile in molti modi.

Ad esempio, in molti casi, abbiamo una convenzione di denominazione per le tabelle di database. Possiamo scegliere di aggiungere coerenza prefissando i nomi delle nostre tabelle con tbl_ , in modo tale che una tabella con i dati degli studenti sia chiamata tbl_student_data .

In questi casi, possiamo denominare l'oggetto Java che contiene i dati degli studenti come Student o StudentData. Quindi, utilizzando il paradigma CRUD, abbiamo un punto di ingresso per ciascuna operazione in modo tale che le operazioni di creazione ricevano solo un parametro Object .

Quindi usiamo la riflessione per recuperare il nome dell'oggetto e i nomi dei campi. A questo punto, possiamo mappare questi dati a una tabella DB e assegnare i valori dei campi oggetto ai nomi dei campi DB appropriati.

5. Ispezione delle classi Java

In questa sezione, esploreremo il componente più fondamentale nell'API di riflessione Java. Gli oggetti di classe Java, come accennato in precedenza, ci danno accesso ai dettagli interni di qualsiasi oggetto.

Esamineremo i dettagli interni come il nome della classe di un oggetto, i modificatori, i campi, i metodi, le interfacce implementate, ecc.

5.1. Prepararsi

Per avere una presa salda sull'API di riflessione, applicata alle classi Java e avere esempi con varietà, creeremo una classe Animal astratta che implementa l' interfaccia di Eating . Questa interfaccia definisce il comportamento alimentare di qualsiasi oggetto Animale concreto che creiamo.

Quindi, in primo luogo, ecco l' interfaccia Mangiare :

public interface Eating { String eats(); }

e poi l' implementazione concreta di Animal dell'interfaccia di 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 }

Creiamo anche un'altra interfaccia chiamata Locomotion che descrive come si muove un animale:

public interface Locomotion { String getLocomotion(); }

Creeremo ora una classe concreta chiamata Capra che estende Animale e implementa Locomozione . Poiché la superclasse implementa Mangiare , Goat dovrà implementare anche i metodi di quell'interfaccia:

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 }

Da questo punto in poi, useremo la riflessione Java per ispezionare gli aspetti degli oggetti Java che appaiono nelle classi e nelle interfacce sopra.

5.2. Nomi delle classi

Cominciamo ottenendo il nome di un oggetto dalla Classe :

@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()); }

Notare che il metodo getSimpleName di Class restituisce il nome di base dell'oggetto come apparirebbe nella sua dichiarazione. Quindi gli altri due metodi restituiscono il nome completo della classe inclusa la dichiarazione del pacchetto.

Vediamo anche come possiamo creare un oggetto della classe Goat se conosciamo solo il suo nome completo della classe:

@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()); }

Si noti che il nome che passiamo al metodo forName statico dovrebbe includere le informazioni sul pacchetto. Altrimenti, otterremo un'eccezione ClassNotFoundException .

5.3. Modificatori di classe

Possiamo determinare i modificatori usati in una classe chiamando il metodo getModifiers che restituisce un numero intero. Ogni modificatore è un bit flag che può essere impostato o cancellato.

La classe java.lang.reflect.Modifier offre metodi statici che analizzano il numero intero restituito per la presenza o l'assenza di un modificatore specifico.

Confermiamo i modificatori di alcune delle classi che abbiamo definito sopra:

@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)); }

Siamo in grado di ispezionare i modificatori di qualsiasi classe situata in un jar della libreria che stiamo importando nel nostro progetto.

Nella maggior parte dei casi, potrebbe essere necessario utilizzare l' approccio forName piuttosto che la creazione di istanze in piena regola poiché sarebbe un processo costoso nel caso di classi di memoria pesante.

5.4. Informazioni sulla confezione

Usando la riflessione Java siamo anche in grado di ottenere informazioni sul pacchetto di qualsiasi classe o oggetto. Questi dati sono raggruppati all'interno della classe Package che viene restituita da una chiamata al metodo getPackage sull'oggetto della classe.

Eseguiamo un test per recuperare il nome del pacchetto:

@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 Class

Siamo anche in grado di ottenere la superclasse di qualsiasi classe Java utilizzando la riflessione 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()); }

Si noti come per prima cosa si richiama il metodo walk e si esegue il cast del tipo restituito sul tipo di dati appropriato, quindi si controlla il suo valore. Successivamente invochiamo il metodo setWalks per modificare quel valore e testare di nuovo.

9. Conclusione

In questo tutorial, abbiamo coperto l'API Java Reflection e abbiamo esaminato come usarlo per ispezionare classi, interfacce, campi e metodi in fase di runtime senza una conoscenza preliminare dei loro interni in fase di compilazione.

Il codice sorgente completo e gli esempi per questo tutorial possono essere trovati su GitHub.