17.6Objekte erzeugen und manipulieren 

Nachdem wir nun genügend über das Ausfragen von Klassen-, Variablen-, Methoden- und Konstruktor-Objekten wissen, wollen wir aktiv eigene Objekte erzeugen, Werte von Variablen abfragen und verändern sowie Methoden dynamisch per Reflection aufrufen.

 

17.6.1Objekte erzeugen 

Der new-Operator erzeugt in Java zur Laufzeit ein Exemplar einer Klasse. Der Compiler muss dazu den Namen der Klasse kennen, sodass er einen passenden Konstruktor-Aufruf erzeugen kann. Kennen wir aber erst später zur Laufzeit den Namen der gewünschten Klasse für unser Objekt, so fällt die new-Operation flach, weil der new-Operator nicht für diesen Spezialfall gedacht ist.

Um Exemplare bestimmter Klassen dynamisch zu erzeugen, brauchen wir wieder ein passendes Class-Objekt. Ab hier gibt es zwei Wege.

newInstance() von Class

Der einfachste Weg führt über die newInstance()-Methode vom Class-Objekt.

• T newInstance()throws InstantiationException,IllegalAccessException
  Erzeugt ein neues Exemplar über den Standard-Konstruktor.

Mit dieser Variante lassen sich jedoch keine parametrisierten Konstruktoren aufrufen.

newInstance() von Constructor

Holen wir uns vom Class-Objekt mit getConstructor() ein Konstruktor-Objekt, das den gewünschten Konstruktor beschreibt. Jedes Konstruktor-Objekt kennt eine newInstance(Object... initargs)-Methode, die ein neues Exemplar erschafft, indem sie den zugrunde liegenden Konstruktor aufruft. Der Parameter von newInstance(…) ist ein Vararg von Werten, die an den echten Konstruktor gehen. Bei einem parameterlosen Konstruktor können wir also einfach newInstance() aufrufen.

• Constructor<T> getConstructor(Class... parameterTypes)
    throws NoSuchMethodException
  Liefert den sichtbaren Konstruktor mit dem gewünschten Typ.

• T newInstance(Object... initargs)
    throws InstantiationException, IllegalAccessException,
    IllegalArgumentException, InvocationTargetException
  Erzeugt ein neues Exemplar, indem es den durch das Constructor-Objekt repräsentierten Konstruktor mit den im Array angegebenen Parametern aufruft. Auf einige Exceptions ist zu achten:

  • IllegalAccessException: Auf den Konstruktor kann nicht zugegriffen werden (zum Beispiel, weil er privat ist).

  • IllegalArgumentException: Die Anzahl der Parameter ist falsch bzw. eine Konvertierung der Parameterwerte in die benötigten Typen ist nicht möglich.

  • InstantiationException: Das Constructor-Objekt bezieht sich auf einen Konstruktor einer abstrakten Klasse.

InvocationTargetException

Die Ausnahme InvocationTargetException ist keine RuntimeException und kommt bei zwei Methoden aus der Reflection-API vor:

• newInstance(…) zum Erzeugen von Objekten bei Constructor

• invoke(…) zum Aufruf von Methoden bei Method

Die InvocationTargetException ist ein Mantel um genau die Ausnahme, die der aufgerufene Konstruktor bzw. die Methode ausgelöst hat. Lösen der Konstruktor oder die Methode eine Ausnahme aus, so generiert die JVM eine InvocationTargetException und lässt uns mit getCause() bzw. mit getTargetException() den Grund als Throwable erfragen.

 

17.6.2Die Belegung der Variablen erfragen 

Schreiben wir einen GUI-Builder oder einen Debugger, so reicht es nicht aus, nur die Namen und Datentypen der Variablen zu kennen. Wir wollen auch auf ihre Inhalte lesend und schreibend zugreifen. Das ist mithilfe der verschiedenen getXXX()-Methoden für ein Field-Objekt leicht machbar. Der erste Schritt besteht also wieder darin, ein Class-Objekt zu erfragen. Dann besorgen wir uns mittels getFields() ein Array von Attributbeschreibungen – oder mit getField(String) ein spezielles Attribut – und nehmen das Field-Objekt für unsere gewünschte Variable. Den Wert, den das Field dann speichert, erfragt die Methode get(Object). Sie ist auf allen Variablentypen möglich und konvertiert automatisch in Wrapper-Objekte, wenn der Typ primitiv war. Die Field-Klasse bietet einige spezielle getXXX(Object)-Methoden, um besonders einfach an die Werte von Variablen primitiven Typs zu gelangen. So liefert getDouble(Object) einen double-Wert und getInt(Object) ein int. Wir müssen daran denken, dass IllegalArgumentException und IllegalAccessException bei falschem Zugriff auftreten können.

Alle getXXX(Object)-Methoden zum Erfragen – und auch setXXX(Object, …)-Methoden zum Setzen – erwarten ein Argument mit dem Verweis auf das Objekt, das die Variable besitzt. Das Argument wird ignoriert (und sollte null sein), wenn es sich um eine statische Variable handelt.

Rechtecke erzeugen und erfragen

Ein Programm soll ein Rectangle-Objekt mit einer Belegung für x, y, Höhe und Breite erzeugen. Anschließend erfragt getField(String) das Field-Objekt für eine Beschreibung der Variablen mit dem gegebenen Namen. Das Field-Objekt gibt mit getXXX(…) den Inhalt der Variablen preis. Um das Prinzip zu demonstrieren, erfragt die get(Object)-Methode die Höhe height, die ein Integer-Objekt zurückgibt. Alle anderen Ganzzahlwerte liefert die spezialisierte Helfermethode getInt(Object):

Listing 17.14com/tutego/insel/meta/GetFieldElements.java

Es erzeugt nun nach dem Aufruf die Ausgabe:

• String getName()
  Liefert den Namen der Variablen. Diese Methode ist Teil der Schnittstelle Member.

• int getModifiers()
  Liefert die Modifizierer. Diese Methode ist Teil der Schnittstelle Member.

• Object get(Object obj)

• boolean getBoolean(Object obj)

• byte getByte(Object obj)

• char getChar(Object obj)

• double getDouble(Object obj)

• float getFloat(Object obj)

• int getInt(Object obj)

• long getLong(Object obj)

• short getShort(Object obj)
  Erfragt den Wert eines Attributs. Die Referenz von obj zeigt auf das Objekt, das das Attribut enthält. Es sollte null übergeben werden, wenn es sich um eine statische Variable handelt.

 

17.6.3Eine generische eigene toString()-Methode * 

Die toString()-Methode ist für viele Klassen nicht überlebenswichtig, aber außerordentlich praktisch. Es ist viel zu schade, hier Zeit für die Entwicklung zu investieren. Toll wäre es, wenn toString() ganz automatisch die Attribute und Belegungen analysierte und ausgäbe. Aber wer Allgemeines sucht, findet die Antwort in Reflection. Wir schreiben einfach eine statische Methode toString(Object) in eine Hilfsklasse und erfragen dann alle Attribute und die Werte des zu untersuchenden Objekts. Etwas Programmieraufwand müssen wir noch in die Behandlung der Oberklasse investieren, denn Reflection auf einem Objekt zeigt nur die in der Klasse deklarierten Attribute, nicht aber die geerbten Attribute an. Die Lösung ergibt sich fast von selbst:

Listing 17.15com/tutego/insel/meta/ToStringHelper.java

Die private Methode toString(Object, Class, ArrayList) dient eigentlich nur dem rekursiven Aufruf durch die Oberklassen. Falls es eine Oberklasse gibt, also clazz.getSuperclass().getSuperclass() ein Objekt liefert, müssen wir für die Oberklasse ebenfalls die Attribute ablaufen. Das machen wir rekursiv.

Testen wir anschließend ToStringHelper in einer Klasse ToStringHelperDemo, die von Ober abgeleitet ist. Damit bekommen wir zwei Attribute in der Oberklasse. Eines davon ist interessant (die Variable i), denn die Unterklasse überdeckt sie. Dennoch findet unser toString(Object) beide Belegungen. Wäre das nicht erwünscht, müssten wir einfach die Liste durchschauen und suchen, ob schon ein Attribut mit dem gleichen Namen vorhanden ist. Da der Algorithmus rekursiv erst die Unterklasse und dann die Oberklasse(n) durchsucht, bekommen wir auch die Attribute in dem sichtbaren Bereich, wie sie auch der Benutzer sieht:

Listing 17.16com/tutego/insel/meta/ToStringHelperDemo.java

 

17.6.4Variablen setzen 

Bei Debuggern oder grafischen Editoren ist es nur eine Seite der Medaille, die Werte von Variablen anzuzeigen. Hinzu kommt noch das Setzen der Werte von Variablen. Dies ist aber genauso einfach wie das Abfragen. An Stelle der getXXX(…)-Methoden kommen nun verschiedene setXXX(…)-Methoden zum Einsatz. So trägt setBoolean(…) einen Wahrheitswert oder setDouble(…) eine Fließkommazahl in eine Variable ein. Eine allgemeine set(Object obj, Object value)-Methode dient Objektreferenzen wie im Fall von get(…). Die Methode set(…) nimmt ebenso Wrapper-Objekte für Variablen von primitiven Datentypen. Die folgenden set<Typ>(Object obj, …)-Methoden setzen daher alle »ihren« Datentyp. Wir müssen aber dafür sorgen, dass die Variable existiert und wir Zugriff darauf haben. In allen Fällen muss auf IllegalArgumentException und IllegalAccessException geachtet werden.

Das folgende Programm erzeugt klassisch ein Point-Objekt mit dem Konstruktor, der x und y setzt. Anschließend verändert die eigene Methode modify(…) ein gewünschtes Attribut:

Listing 17.17com/tutego/insel/meta/SetFieldElements.java

Die Veränderung der Variablen erfolgt mit der set(Object, Object)-Methode. Da wir primitive Datentypen übergeben, wickeln wir sie für die modify(…)-Methode in ein Integer-Objekt ein. Das Integer-Objekt haben wir nicht explizit programmiert, denn es wird über Boxing vom Compiler selbst zur Verfügung gestellt. Für bekannte Typen könnten wir neben der allgemeinen Methode set(…) auch etwa setInt(…) verwenden.

• void set(Object obj, Object value)
  Setzt das Attribut des Objekts obj, das dieses Field-Objekt repräsentiert, auf den neuen Wert value.

• void setBoolean(Object obj, boolean z)

• void setByte(Object obj, byte b)

• void setChar(Object obj, char c)

• void setDouble(Object obj, double d)

• void setFloat(Object obj, float f)

• void setInt(Object obj, int i)

• void setLong(Object obj, long l)

• void setShort(Object obj, short s)
  Belegt das Feld eines Objekts obj mit einem primitiven Element.

 

17.6.5Bean-Zustände kopieren * 

In mehrschichtigen Anwendungen gibt es oft das Muster, dass eine JavaBean etwa über eine objektrelationale Mapping-Technologie automatisch aus einer Datenbankzeile aufgebaut wird und dann intern in der Geschäftsschicht verwendet wird. Soll nun diese Information über das Netzwerk an einen anderen Rechner verteilt werden, ist es nicht immer angebracht, diese JavaBean etwa direkt über Serialisierung zu versenden. Stattdessen kann ein Transfer-Objekt aufgebaut werden, eine spezielle JavaBean zum Beispiel, sodass der Empfänger keine Abhängigkeit zu der Bean in der internen Geschäftsschicht hat. Nun werden sich aber diese Geschäftsschicht-Bean und die Transfer-Bean sehr ähnlich sein, und viele Entwickler scheuen die Mühe, lästigen Kopiercode zu erstellen. Doch manuelle Arbeit ist nicht nötig, und eine Lösung für das Kopierproblem ist über Reflection schnell geschrieben. Über die BeanInfo kommen wir an den PropertyDescriptor (siehe dazu Abschnitt 17.5.5, »Properties einer Bean erfragen«), und dann liefern getReadMethod() und getWriteMethod() die Setter/Getter. Bei einer eigenen Kopiermethode wie copyProperties(Object source, Object target) müssen wir bei der Quell-Bean jede Property auslesen und entsprechend bei der Ziel-Bean nach der Property suchen und den Setter aufrufen. Wenn das Ganze ohne Typkonvertierungen programmiert werden soll, sind es nur wenige Zeilen Programmcode. Kommen einfache Konvertierungen dazu, etwa wenn einmal ein Wrapper als Property-Typ genutzt wird und einmal der primitive Datentyp, ist es etwas mehr.

Der Aufwand mit einer eigenen Implementierung ist allerdings nicht nötig, denn zwei populäre Implementierungen können helfen:

• Apache Commons BeanUtils (http://commons.apache.org/proper/commons-beanutils/):
  Die Klasse org.apache.commons.beanutils.BeanUtils bietet praktische statische Methoden wie copyProperty(Object bean, String name, Object value), copyProperties(Object dest, Object orig), Object cloneBean(Object bean) oder populate(Object bean, Map properties).

• Dozer (http://dozer.sourceforge.net/): Dozer bringt ausgefeilte Mapping-Möglichkeiten mit, die weit über BeansUtils hinausgehen. Das geht so weit, dass es ein Eclipse-Plugin zur Konfiguration der Abbildungen gibt.

 

17.6.6Private Attribute ändern 

Wenn es der Sicherheitsmanager zulässt, kann ein Programm auch private- oder protected-Attribute ändern und Methoden/Konstruktoren eingeschränkter Sichtbarkeit aufrufen. Die Schlüsselfigur in diesem Spiel ist die Oberklasse java.lang.reflect.AccessibleObject, die den Klassen Field und Excecutable (und damit Constructor und Method) die Methode setAccessible(boolean) vererbt. Ist das Argument true und lässt der Sicherheitsmanager die Operation zu, lässt sich auf jedes Element (also Konstruktor, Attribut oder Methode) ungleich der Sichtbarkeitseinstellungen zugreifen:

Listing 17.18com/tutego/insel/meta/ReadPrivate.java

 

17.6.7Methoden aufrufen 

Nach dem Abfragen und Setzen von Variablenwerten und Konstruktor-Aufrufen zum Erzeugen eines Objekts ist das Aufrufen von Methoden per Reflection der letzte Schritt. Wenn zur Compilezeit der Name der Methode nicht feststeht, lässt sich zur Laufzeit dennoch eine im Programm deklarierte Methode aufrufen, wenn ihr Name als Zeichenkette vorliegt.

Zunächst gehen wir wieder von einem Class-Objekt aus, das die Klasse des Objekts beschreibt, für das eine Objektmethode aufgerufen werden soll. Anschließend wird ein Method-Objekt als Beschreibung der gewünschten Methode benötigt; wir bekommen dies mit der Methode getMethod(String name, Class<?>... parameterTypes) aus dem Class-Exemplar. getMethod(…) verlangt zwei Argumente: einen String mit dem Namen der Methode und ein Array von Class-Objekten. Jedes Element dieses Arrays entspricht einem Parametertyp aus der Signatur der Methode. Damit werden überladene Methoden unterschieden. Nachdem wir das beschreibende Method-Exemplar und die Parameterwerte für den Aufruf vorbereitet haben, ruft invoke(…) die Zielmethode auf – im Englischen heißt dies dynamic invocation. invoke(…) erwartet zwei Argumente: ein Array mit Argumenten, die der aufgerufenen Methode übergeben werden, und eine Referenz auf das Objekt, auf dem die Methode aufgerufen werden soll und das der Auflösung der dynamischen Bindung dient.

• Object invoke(Object obj, Object... args)
  throws IllegalAccessException, IllegalArgumentException, InvocationTargetException
  Ruft eine Methode des Objekts obj mit den gegebenen Argumenten auf. Wie schon beim Konstruktor löst die Methode eine InvocationTargetException aus, wenn die aufzurufende Methode eine Exception auslöst.

Beispiele der Varargs sind bei getMethod(String name, Class<?>... parameterTypes) die Parametertypen und bei invoke(Object obj, Object... args) die Argumente für setLocation(…). Da getMethod(…) eine beliebige Anzahl von Argumenten annehmen kann und kein Argument dazuzählt, muss die Methode nicht so parametrisiert werden:

Auffälliger ist die Möglichkeit der variablen Argumentanzahl bei invoke(…). Da ein Getter keine Parameter besitzt, heißt es kurz method.invoke(p), Folgendes ist nicht nötig:

Interessant sind Methoden mit Parameterliste, wie setLocation(int, int):

 

17.6.8Statische Methoden aufrufen 

Wir programmieren ein Beispiel in dem die Klasse InvokeMain die statische main(String[])-Methode einer anderen Klasse, HasMain, mit einem Parameter aufruft:

Listing 17.20com/tutego/insel/meta/InvokeMain.java

 

17.6.9Dynamische Methodenaufrufe bei festen Methoden beschleunigen * 

Werden über Reflection Methoden aufgerufen, deren Methodennamen erst zur Laufzeit bestimmt werden, so verlieren wir die Typsicherheit vom Compiler, und die Geschwindigkeit ist vermindert. Diese Aufrufe lassen sich prinzipbedingt auch durch einen JIT-Compiler nicht weiter beschleunigen.[ 134 ](Wohl aber lässt sich über invokedynamic wieder mehr Performance gewinnen, doch das ist eine eigene Geschichte für Compilerbauer.) Wir müssen also nach einer Lösung suchen, mit der wir diese Art von Aufruf beschleunigen können. Ein möglicher Weg hierbei ist, in Kenntnis des Namens der Methode – nennen wir die Methode meth() – den Namen in einer (abstrakten) Oberklasse dem Compiler bereits bekannt zu machen. Reflection ist nur zum Laden einer Unterklasse mit gegebenem Namen nötig; die normale, dynamische Methodenbindung erledigt den Rest – ganz ohne versteckte Schnüre, doppelte Böden oder Spiegel (Reflection).

Versuchen wir, den folgenden Code nach diesem Schema zu ändern:

Listing 17.21com/tutego/insel/meta/DynamReflection.java, main()

DynamReflection ist die Hauptklasse, die die Klasse DynamReflectionMethod über Class.forName(String) anfordert:

Listing 17.22com/tutego/insel/meta/DynamReflectionMethod.java

Über das Class-Objekt erzeugt newInstance() ein neues Exemplar. getMethod("meth") sucht die Beschreibung der Methode meth() heraus, und invoke(…) ruft die Methode meth() auf. Hier genau entsteht ein kleiner Geschwindigkeitsverlust. Wenn es uns gelänge, um das invoke(…) herumzukommen, wäre das schon ein großer Fortschritt. Dies schaffen wir, indem wir eine Schnittstelle (oder Oberklasse) für DynamReflectionMethod konstruieren, die genau diese Methode vorschreibt. Die implementierende Klasse (bzw. Unterklasse) wird dann eine Implementierung angeben:

Listing 17.23com/tutego/insel/meta/DynamAbstract.java

DynamBase ist eine Schnittstelle, die zur Übersetzungszeit bekannt ist. Die virtuelle Maschine löst den Aufruf nach den üblichen Regeln der dynamischen Bindung selbst auf. Die Klasse DynamBaseMethod wird ebenfalls erst zur Laufzeit geladen. Wir verstecken hier sehr elegant den Aufwand. Wir haben die gleiche Funktionalität und Flexibilität wie im vorangegangenen Reflection-Beispiel – wenn wir die Möglichkeit, den Klassennamen durch einen String anzugeben, außer Acht lassen –, aber mit der höheren Geschwindigkeit eines konventionellen Methodenaufrufs ohne Reflection.

 

17.6.10java.lang.reflect.Parameter 

Ein Parameter repräsentiert einen Parameter einer Methode oder eines Konstruktors. Zu den neuen Methoden zählen:

• String getName()

• int getModifiers()

• boolean isNamePresent()

• boolean isImplicit()

• boolean isSynthetic()

• boolean isVarArgs()

• Type getParameterizedType()

• Executable getDeclaringExecutable()

• Class<?> getType()

• AnnotatedType getAnnotatedType()

Die in Java 8 eingeführte finale Klasse Parameter implementiert AnnotatedElement, da seit Java 8 auch Parametervariablen annotiert sein können; die Methoden sind in der oberen Aufzählung nicht noch einmal aufgeführt.

Um an einen Parameter zu gelangen, nutzen wir getParameters() auf einem Executable, also konkret Constructor, Method.

• public Parameter[] getParameters()

Falls etwas beim Erfragen schiefgeht, gibt es eine MalformedParametersException, eine ungeprüfte Ausnahme.