Leitfaden zur Java-Reflexion

1. Übersicht

In diesem Artikel untersuchen wir die Java-Reflexion, mit der wir Laufzeitattribute von Klassen, Schnittstellen, Feldern und Methoden überprüfen oder / und ändern können. Dies ist besonders praktisch, wenn wir ihre Namen beim Kompilieren nicht kennen.

Darüber hinaus können wir mithilfe von Reflektion neue Objekte instanziieren, Methoden aufrufen und Feldwerte abrufen oder festlegen.

2. Projekteinrichtung

Um Java Reflection verwenden zu können, müssen keine speziellen Jars , keine spezielle Konfiguration oder Maven-Abhängigkeiten enthalten sein. Das JDK wird mit einer Gruppe von Klassen geliefert , die speziell für diesen Zweck im Paket java.lang.reflect gebündelt sind .

Wir müssen also nur den folgenden Import in unseren Code vornehmen:

import java.lang.reflect.*;

und wir sind gut zu gehen.

Um Zugriff auf die Klassen-, Methoden- und Feldinformationen einer Instanz zu erhalten, rufen wir die Methode getClass auf , die die Laufzeitklassendarstellung des Objekts zurückgibt. Das zurückgegebene Klassenobjekt bietet Methoden für den Zugriff auf Informationen zu einer Klasse.

3. Einfaches Beispiel

Um unsere Füße nass zu machen, schauen wir uns ein sehr einfaches Beispiel an, das zur Laufzeit die Felder eines einfachen Java-Objekts untersucht.

Nehmen sich eine einfache erstellen Person - Klasse mit nur Namen und Alten Feldern und keine Methoden überhaupt. Hier ist die Personenklasse:

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

Wir werden jetzt Java Reflection verwenden, um die Namen aller Felder dieser Klasse zu ermitteln. Um die Kraft der Reflexion zu schätzen, konstruieren wir ein Personenobjekt und verwenden Objekt als Referenztyp:

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

Dieser Test zeigt uns , dass wir eine Reihe von bekommen sind in der Lage F ELD Objekte aus unserer Person Objekt, auch wenn der Verweis auf das Objekt eine Art des Objekts Elternteil ist.

Im obigen Beispiel waren wir nur an den Namen dieser Felder interessiert, aber es kann noch viel mehr getan werden, und wir werden weitere Beispiele dafür in den folgenden Abschnitten sehen.

Beachten Sie, wie wir eine Hilfsmethode verwenden, um die tatsächlichen Feldnamen zu extrahieren. Dies ist ein sehr grundlegender Code:

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

4. Java Reflection-Anwendungsfälle

Bevor wir zu den verschiedenen Funktionen der Java-Reflexion übergehen, werden wir einige der häufigsten Verwendungszwecke erörtern, die wir möglicherweise dafür finden. Java Reflection ist äußerst leistungsfähig und kann auf verschiedene Weise sehr nützlich sein.

In vielen Fällen haben wir beispielsweise eine Namenskonvention für Datenbanktabellen. Wir können uns dafür entscheiden, die Konsistenz zu erhöhen , indem wir unsere Tabellennamen mit tbl_ vorab festlegen , sodass eine Tabelle mit Schülerdaten tbl_student_data heißt .

In solchen Fällen können wir das Java-Objekt, das Studentendaten enthält, als Student oder StudentData bezeichnen. Unter Verwendung des CRUD-Paradigmas haben wir dann einen Einstiegspunkt für jede Operation, sodass Create- Operationen nur einen Object- Parameter erhalten.

Wir verwenden dann Reflektion, um den Objektnamen und die Feldnamen abzurufen. Zu diesem Zeitpunkt können wir diese Daten einer DB-Tabelle zuordnen und die Objektfeldwerte den entsprechenden DB-Feldnamen zuweisen.

5. Überprüfen von Java-Klassen

In diesem Abschnitt werden wir die grundlegendste Komponente in der Java Reflection API untersuchen. Wie bereits erwähnt, ermöglichen uns Java-Klassenobjekte den Zugriff auf die internen Details eines Objekts.

Wir werden interne Details wie den Klassennamen eines Objekts, Modifikatoren, Felder, Methoden, implementierte Schnittstellen usw. untersuchen.

5.1. Fertig werden

Um die Reflection-API, die auf Java-Klassen angewendet wird und Beispiele mit Vielfalt enthält, fest im Griff zu haben, erstellen wir eine abstrakte Animal- Klasse, die die Eating- Schnittstelle implementiert . Diese Schnittstelle definiert das Essverhalten jedes von uns erstellten konkreten Tierobjekts .

Hier ist also zunächst die Essoberfläche :

public interface Eating { String eats(); }

und dann die konkrete Tierimplementierung der Essschnittstelle :

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

Lassen Sie uns auch eine andere Schnittstelle namens Fortbewegung erstellen, die beschreibt, wie sich ein Tier bewegt:

public interface Locomotion { String getLocomotion(); }

Wir werden jetzt eine konkrete Klasse namens Goat erstellen, die Animal erweitert und Fortbewegung implementiert . Da die Oberklasse Essen implementiert , muss Goat auch die Methoden dieser Schnittstelle implementieren:

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 }

Ab diesem Zeitpunkt werden wir die Java-Reflexion verwenden, um Aspekte von Java-Objekten zu untersuchen, die in den obigen Klassen und Schnittstellen angezeigt werden.

5.2. Klassennamen

Beginnen wir damit, den Namen eines Objekts aus der Klasse abzurufen :

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

Beachten Sie, dass die Methode getSimpleName der Klasse den Basisnamen des Objekts zurückgibt, wie er in seiner Deklaration erscheinen würde. Dann geben die beiden anderen Methoden den vollständig qualifizierten Klassennamen einschließlich der Paketdeklaration zurück.

Lassen Sie uns auch sehen, wie wir ein Objekt der Goat- Klasse erstellen können, wenn wir nur den vollständig qualifizierten Klassennamen kennen:

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

Beachten Sie, dass der Name, den wir an die statische forName- Methode übergeben, die Paketinformationen enthalten sollte. Andernfalls erhalten wir eine ClassNotFoundException .

5.3. Klassenmodifikatoren

Wir können die in einer Klasse verwendeten Modifikatoren bestimmen, indem wir die Methode getModifiers aufrufen , die eine Ganzzahl zurückgibt . Jeder Modifikator ist ein Flag-Bit, das entweder gesetzt oder gelöscht wird.

Die Klasse java.lang.reflect.Modifier bietet statische Methoden, mit denen die zurückgegebene Ganzzahl auf das Vorhandensein oder Fehlen eines bestimmten Modifikators analysiert wird .

Lassen Sie uns die Modifikatoren einiger der oben definierten Klassen bestätigen:

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

Wir können Modifikatoren jeder Klasse in einem Bibliotheksglas überprüfen, das wir in unser Projekt importieren.

In den meisten Fällen müssen wir möglicherweise den forName- Ansatz anstelle der vollständigen Instanziierung verwenden, da dies bei speicherintensiven Klassen ein teurer Prozess wäre.

5.4. Paketinformationen

Durch die Verwendung von Java Reflection können wir auch Informationen über das Paket einer Klasse oder eines Objekts abrufen. Diese Daten werden in der Package- Klasse gebündelt, die durch einen Aufruf der getPackage- Methode für das Klassenobjekt zurückgegeben wird.

Führen Sie einen Test durch, um den Paketnamen abzurufen:

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

Wir sind auch in der Lage, die Oberklasse jeder Java-Klasse mithilfe der Java-Reflexion zu erhalten.

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

Beachten Sie, wie wir zuerst die Walks- Methode aufrufen, den Rückgabetyp in den entsprechenden Datentyp umwandeln und dann seinen Wert überprüfen. Wir rufen dann später die setWalks- Methode auf, um diesen Wert zu ändern und erneut zu testen.

9. Fazit

In diesem Lernprogramm haben wir die Java Reflection-API behandelt und untersucht, wie Sie damit Klassen, Schnittstellen, Felder und Methoden zur Laufzeit ohne vorherige Kenntnis ihrer Interna bis zur Kompilierungszeit untersuchen können.

Den vollständigen Quellcode und Beispiele für dieses Tutorial finden Sie auf GitHub.