23.2 Metadaten der Klassen mit dem Class-Objekt

Angenommen, wir wollen einen Klassen-Browser schreiben. Dieser soll alle zum laufenden Programm gehörenden Klassen und darüber hinaus weitere Informationen wie Variablenbelegung, definierte Methoden, Konstruktoren und Informationen über die Vererbungshierarchie anzeigen. Dafür benötigen wir die Bibliotheksklasse Class. Exemplare der Klasse Class sind Objekte, die entweder eine Java-Klasse oder Java-Schnittstelle repräsentieren. (Dass auch Schnittstellen durch Class-Objekte repräsentiert werden, wird im Folgenden nicht mehr ausführlich unterschieden.)

In diesem Punkt unterscheidet sich Java von vielen herkömmlichen Programmiersprachen, da sich Eigenschaften von Klassen vom gerade laufenden Programm mittels der Class-Objekte abfragen lassen. Bei den Exemplaren von Class handelt es sich um eine eingeschränkte Form von Metaobjekten [Echte Metaklassen wären Klassen, deren jeweils einziges Exemplar die normale Java-Klasse ist. Dann wären etwa die normalen Klassenvariablen in Wahrheit Objektvariablen in der Metaklasse. ] – die Beschreibung einer Java-Klasse, die aber nur ausgewählte Informationen preisgibt. Neben normalen Klassen werden auch Schnittstellen durch je ein Class-Objekt repräsentiert.

23.2.1 An ein Class-Objekt kommen

Zunächst müssen wir für eine bestimmte Klasse das zugehörige Class-Objekt in Erfahrung bringen. Class-Objekte selbst kann nur die JVM erzeugen. Wir können das nicht. (Die Objekte sind immutable und der Konstruktor privat. [Und der JavaDoc lautet: »Constructor. Only the Java Virtual Machine creates Class objects.« ] ) Um einen Verweis auf ein Class-Objekt zu bekommen, bieten sich an:

• Ist ein Exemplar der Klasse verfügbar, rufen wir die getClass()-Methode des Objekts auf und erhalten das Class-Exemplar der zugehörigen Klasse.

• Jede Klasse enthält eine Klassenvariable mit Namen .class vom Typ Class, die auf das zugehörige Class-Exemplar verweist.

• Auch auf primitiven Datentypen ist das Ende .class erlaubt. Das gleiche Class-Objekt liefert die statische Variable TYPE der Wrapper-Klassen. Damit ist int.class == Integer.TYPE.

• Die Klassenmethode Class.forName(String) kann eine Klasse erfragen, und wir erhalten das zugehörige Class-Exemplar als Ergebnis. Ist die Klasse noch nicht geladen, sucht und bindet forName() die Klasse ein. Weil das Suchen schiefgehen kann, ist eine ClassNotFoundException möglich.

• Haben wir bereits ein Class-Objekt, sind wir aber nicht an ihm, sondern an seinen Vorfahren interessiert, so können wir einfach mit getSuperclass() ein Class-Objekt für die Oberklasse erhalten.

Das folgende Beispiel zeigt drei Möglichkeiten auf, um an ein Class-Objekt für java.util.Date heranzukommen:

Listing 23.1 com/tutego/insel/meta/GetClassObject.java, main()

Class<Date> c1 = java.util.Date.class; 
System.out.println( c1 );        // class java.util.Date 
 
Class<?> c2 = new java.util.Date().getClass(); 
 // oder Class<? extends Date> c2 = ... 
 
System.out.println( c2 );        // class java.util.Date 
 
try { 
  Class<?> c3 = Class.forName( "java.util.Date" ); 
  System.out.println( c3 );      // class java.util.Date 
} 
catch ( ClassNotFoundException e ) { e.printStackTrace(); }

Die Variante mit forName() ist sinnvoll, wenn der Klassenname bei der Übersetzung des Programms noch nicht feststand. Sonst ist die vorhergehende Technik eingängiger, und der Compiler kann prüfen, ob es den Typ gibt.

class java.lang.Object

• final Class<? extends Object> getClass() Liefert zur Laufzeit das Class-Exemplar, das die Klasse des Objekts repräsentiert.

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• static Class<?> forName( String className ) throws ClassNotFoundException Liefert das Class-Exemplar für die Klasse oder Schnittstelle mit dem angegebenen vollqualifizierten Namen. Falls sie bisher noch nicht vom Programm benötigt wurde, sucht und lädt der Klassenlader die Klasse. Die Methode liefert niemals null zurück. Falls die Klasse nicht geladen und eingebunden werden konnte, gibt es eine ClassNotFoundException. Eine alternative Methode forName() ermöglicht auch das Laden mit einem gewünschten Klassenlader.

ClassNotFoundException und NoClassDefFoundError

Eine ClassNotFoundException lösen die Methoden forName() aus Class und loadClass() bzw. findSystemClass() aus ClassLoader immer dann aus, wenn der Klassenlader die Klasse nach ihrem Klassennamen nicht finden kann.

Neben der Exception-Klasse gibt es ein NoClassDefFoundError – ein harter LinkageError, den das System immer dann auslöst, wenn die JVM eine im Bytecode referenzierte Klasse nicht laden kann. Nehmen wir zum Beispiel eine Anweisung wie new MeineKlasse();. Führt die JVM diese Anweisung aus, versucht sie den Bytecode von MeineKlasse zu laden. Ist der Bytecode für MeineKlasse nach dem Compilieren entfernt worden, löst die JVM durch den nicht geglückten Ladeversuch den NoClassDefFoundError aus. Auch tritt der Fehler auf, wenn beim Laden der Bytecode die Klasse MeineKlasse zwar gefunden wurde, aber MeineKlasse einen statischen Initialisierungsblock besitzt, der wiederum eine Klasse referenziert, für die kein Klassendatei vorhanden ist.

Während ClassNotFoundException häufiger vorkommt aus NoClassDefFoundError, ist es im Allgemeinen in Indiz dafür, dass ein Java-Archiv im Klassenpfad fehlt.

Umbenennungen der Klassenamen durch den Obfuscator

Dass der Compiler automatisch Bytecode gemäß dieses veränderten Quellcodes erzeugt, führt nur dann zu unerwarteten Problemen, wenn wir einen Obfuscator über den Programmtext laufen lassen, der nachträglich den Bytecode modifiziert und damit die Bedeutung des Programms beziehungsweise des Bytecodes verschleiert und dabei Klassen umbenennt. Offensichtlich darf ein Obfuscator Klassen, deren Class-Exemplare abgefragt werden, nicht umbenennen; oder der Obfuscator müsste die entsprechenden Zeichenketten ebenfalls korrekt ersetzen (aber natürlich nicht alle Zeichenketten, die zufällig mit Namen von Klassen übereinstimmen).

23.2.2 Was das Class-Objekt beschreibt

Ein Class-Exemplar kann eine Schnittstelle, eine Klasse, einen primitiven Datentyp oder auch einen Array-Typ beschreiben. Dies lässt sich durch die drei Methoden isInterface(), isPrimitive() und isArray() herausfinden. Wenn keine der drei Methoden für ein Class-Exemplar true liefert, repräsentiert das Objekt eine gewöhnliche Klasse.

Dass es auch Class-Exemplare gibt, die die primitiven Datentypen von Java beschreiben, erstaunt zunächst. Damit ist es jedoch möglich, die Parameter- und Ergebnistypen beliebiger Java-Methoden einheitlich durch Class-Exemplare zu beschreiben. Dazu kodiert jede der acht Wrapper-Klassen, die zu den Datentypen boolean, byte, char, short, int, long, float und double gehören, und die spezielle Klasse für den Typ void eine Konstante TYPE. Benötigen wir ein Class-Objekt für den primitiven Typ int, so greifen wir mit Integer.TYPE (oder alternativ mit int.class) darauf zu. Alle Class-Exemplare für primitive Datentypen werden automatisch von der JVM erzeugt. Die Methode isPrimitive() gibt genau für diese neun besonderen Class-Exemplare true zurück, sodass sie von Repräsentanten für echte Klassen unterschieden werden können.

System.out.println( void.class.isPrimitive() );  // true

Das folgende Programmstück testet die Attribute von Class-Objekten systematisch durch. Wir benutzen die Methode getName(), um den Namen des Class-Objekts auszugeben. Im nächsten Abschnitt mehr dazu. Das Class-Objekt für Felder setzt sich aus dem Basistyp und Paaren von eckigen Klammern zusammen, etwa double[][].class.

Listing 23.2 com/tutego/insel/meta/CheckClassType.java

package com.tutego.insel.meta; 
 
import java.util.*; 
 
class CheckClassType 
{ 
  public static void main( String[] args ) 
  { 
    Class<?> observer = Observer.class; 
    Class<?> observable = Observable.class; 
    Class<?> array = (new int[2][3][4]).getClass(); 
    Class<?> primitive = Integer.TYPE; 
 
    checkClassType( observer ); 
    checkClassType( observable ); 
    checkClassType( array ); 
    checkClassType( primitive ); 
  } 
 
  static void checkClassType( Class<?> c ) 
  { 
    if ( c.isArray() ) 
      System.out.println( c.getName() + " is an array." ); 
    else if ( c.isPrimitive() ) 
      System.out.println( c + " is a primitive type."); 
    else if ( c.isInterface() ) 
      System.out.println( c.getName() + " is an interface." ); 
    else 
      System.out.println( c.getName()+ " is a class." ); 
   } 
}

Die Ausgabe des Programms ist nun:

java.util.Observer ist eine Schnittstelle. 
java.util.Observable ist eine Klasse. 
[[[I ist ein Array. 
int ist ein primitiver Datentyp.

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• boolean isInterface() Liefert true, wenn das Class-Objekt eine Schnittstelle beschreibt.

• boolean isArray() Liefert true, wenn das Class-Objekt einen Array-Typ beschreibt.

• boolean isPrimitive() Testet, ob das Class-Objekt einen primitiven Datentyp beschreibt.

Komponententyp bei Feldern

Die Methode getComponentType() liefert bei Feldern den Typ der Elemente als Class-Objekt. Steht das Class-Objekt für kein Feld, ist die Methodenrückgabe null.

System.out.println( double[].class.getComponentType() );    // double 
System.out.println( double[][].class.getComponentType() );  // class [D 
System.out.println( double.class.getComponentType() );      // null

23.2.3 Der Name der Klasse

Liegt zu einer Klasse das Class-Objekt vor, so können wir zur Laufzeit ihren voll qualifizierten Namen über die Methode getName() ausgeben. Da jeder Typ über einen Namen verfügt, führt diese Funktion also jedes Mal zum Ziel.

Listing 23.3 SampleName.java

String n1 = new java.util.Date().getClass().getName(); 
System.out.println( n1 );                         // java.util.Date 
String n2 = java.util.RandomAccess.class.getName(); 
System.out.println( n2 );                         // java.util.RandomAccess 
String n3 = Deprecated.class.getName(); 
System.out.println( n3 );                         // java.lang.Deprecated 
String n4 = Thread.State.class.getName(); 
System.out.println( n4 );                         // java.lang.Thread$State

Kodierung von Feldern

Schwieriger ist die Kodierung bei Array-Typen, die ja eine besondere Form von Klassen sind. getName() kodiert sie mit einer führenden »[«. Jede Klammer steht dabei für eine Dimension des Array-Typs. Nach den Klammern folgt in einer kodierten Form der Typ der Array-Elemente. So liefert

System.out.println( int[][][].class.getName() );                // [[[I 
System.out.println( (new int[2][3][4]).getClass().getName() );  // [[[I

den String »[[[I«, also einen dreidimensionalen Array-Typ mit Array-Elementen vom primitiven Typ int. Der Elementtyp ist wie folgt kodiert:

Nimmt das Array Objektreferenzen auf, wird deren Typ in der Form »LKlassenname;« kodiert. So liefert (new Object[3]).getClass().getName() den String »[Ljava.lang.Object;«. Der Klassen- beziehungsweise Schnittstellenname ist wie üblich voll qualifiziert.

Der String ist auch für Class.forName() von Bedeutung. Im Fall von Arrays liefert die Methode ein Class-Objekt für den Elementtyp. Die ersten Versuche, um ein Class-Objekt für Felder zu beziehen, scheitern an einer ClassNotFoundException:

Class.forName( "String[]" ); 
Class.forName( "java.lang.String[]" );

In der ersten Anweisung ist der Klassenname nicht voll qualifiziert, und auch in der zweiten Anweisung ist der String falsch aufgebaut;

System.out.println( Class.forName("[Ljava.lang.String;") );  
// class [Ljava.lang.String;

Steht die Frage an, ob ein Class-Objekt für ein Feld von Objekten steht oder für ein primitives Feld, lässt sich das Ergebnis von getName() auswerten:

public static boolean isObjectArray( Class clazz ) 
{ 
  if ( clazz != null && clazz.isArray() ) 
    return clazz.getName().startsWith( "[L" ); 
  return false; 
}

So liefert:

System.out.println( isObjectArray( Object[].class ) );       // true 
System.out.println( isObjectArray( int[].class ) );          // false 
System.out.println( isObjectArray( Object.class ) );         // false

toString()

Auch eine zweite Methode ist uns bekannt, um Class-Exemplare für Menschen lesbar auszugeben: die Methode toString(). Sie basiert im Kern auf getName(), fügt aber zusätzlich die Art der repräsentierten Klasse (normale Klasse, Schnittstelle oder primitiver Datentyp) ein:

public String toString() { 
  return (isInterface() ? "interface " : 
     (isPrimitive() ? "" : "class ")) + getName(); 
}

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• String getName() Liefert für ein Class-Exemplar als String den voll qualifizierten Namen der repräsentierten Klasse oder Schnittstelle beziehungsweise des repräsentierten Array-Typs oder des primitiven Datentyps.

• String toString() Liefert eine für Menschen lesbare String-Repräsentation des Class-Objekts.

23.2.4 instanceof mit Class-Objekten

Wir konnten den binären Operator instanceof nutzen, um zu testen, ob ein Objekt Exemplar einer Klasse ist und einen bestimmten Typus besitzt. Die Klasse muss jedoch zur Übersetzungszeit bekannt sein und kann nicht dynamisch festgelegt werden. Um zu testen, ob ein Objekt Exemplar eines bekannten Class-Objekts ist, lässt sich eine Methode vom Class-Objekt nutzen: isAssignableFrom(Class).

public static boolean dynInstanceof( Object o, Class c ) 
{ 
  return c.isAssignableFrom( o.getClass() ); 
}

Die Methode befragt genau genommen gar nicht die Hierarchie zwischen Objekt und Klasse, sondern die zwischen zwei Klassen. Unsere Funktion dynInstanceof() nutzt dies jedoch, um zu testen, ob ein Objekt einen bestimmten Typ annimmt.

JButton b = new JButton(); 
System.out.println( dynInstanceof( b, JButton.class)  );                        // true 
System.out.println( dynInstanceof( b, Object.class)  );                         // true 
System.out.println( dynInstanceof( b, Class.forName("java.awt.Component") ) );  // true 
System.out.println( dynInstanceof( b, String.class)  );                         // false

Solange der Klassenname zur Übersetzungszeit bekannt ist, ist instanceof die beste Lösung. Doch wenn die Klasse nur durch ein Class-Objekt gegeben ist, bleibt immer noch isAssignableFrom().

23.2.5 Oberklassen finden

Das Class-Exemplar für eine Klasse gibt Zugriff auf die Oberklasse, die Sichtbarkeitsstufe und weitere Informationen. Die Oberklasse ermittelt getSuperclass(). Die Methode gibt null zurück, falls das Class-Objekt eine Schnittstelle repräsentiert oder wir schon am oberen Ende der Hierarchie sind, also bei dem Class-Objekt für die Wurzelklasse Object. Das folgende Programm findet alle Oberklassen einer Klasse durch den wiederholten Aufruf der Methode getSuperclass().

Listing 23.4 com/tutego/insel/meta/ShowSuperclasses.java

Class<?> subclass   = javax.swing.JButton.class; 
Class<?> superclass = subclass.getSuperclass(); 
 
while ( superclass != null ) 
{ 
  String className = superclass.getName(); 
  System.out.println( className ); 
  subclass   = superclass; 
  superclass = subclass.getSuperclass(); 
}

Wahrscheinlich wäre eine rekursive Variante noch eleganter, aber darauf kommt es jetzt nicht an.

javax.swing.AbstractButton 
javax.swing.JComponent 
java.awt.Container 
java.awt.Component 
java.lang.Object

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• Class<? super T> getSuperclass() Liefert ein Class-Exemplar für die Oberklasse der Klasse, die durch das aufrufende Class-Objekt repräsentiert wird. Falls wir schon oben auf der Vererbungshierarchie bei Object sind oder nach der Oberklasse einer Schnittstelle fragen, liefert die Funktion null.

23.2.6 Implementierte Interfaces einer Klasse oder eines Interfaces

Klassen stehen zum einen in einer Vererbungsbeziehung zu einer Oberklasse und können zum anderen mehrere Schnittstellen implementieren. Schnittstellen können ihrerseits wiederum andere Schnittstellen erweitern. Bei einer Klassendeklaration folgt direkt hinter dem Schlüsselwort implements eine Auflistung der implementierten Schnittstellen. So implementiert die Klasse RandomAccessFile die Schnittstellen DataOutput, DataInput und Closeable.

public class RandomAccessFile implements DataOutput, DataInput, Closeable

Um zu einem vorhandenen Class-Objekt die Schnittstellen aufzulisten, rufen wir getInterfaces() auf, die uns ein Array von Class-Objekten liefert. Von hier aus kennen wir den Weg zum Namen: der Aufruf von getName() liefert den String für den Namen der Schnittstelle.

for ( Class<?> theInterface: java.io.RandomAccessFile.class.getInterfaces() ) 
  System.out.println( theInterface.getName() );

java.io.DataOutput 
java.io.DataInput 
java.io.Closeable

23.2.7 Modifizierer und die Klasse Modifier

Eine Klassendeklaration kann Modifizierer enthalten, also Schlüsselwörter, die zum Beispiel die Sichtbarkeit bestimmen. Unter anderem sind dies public, protected, private und final. Sie stehen etwa in der Klassendeklaration vor dem Schlüsselwort class oder auch vor Methoden. Die Modifizierer können auch kombiniert werden: So ist die Klasse Class selbst public final. Die Methode getModifiers() liefert im Rückgabewert die Modifizierer verschlüsselt als Ganzzahl.

System.out.println( Modifier.class.getModifiers() );                    // 1 
System.out.println( Modifier.toString(Modifier.class.getModifiers()) ); // public

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• int getModifiers() Liefert die Modifizierer für eine Klasse oder eine Schnittstelle.

Damit wir uns bei der Entschlüsselung nicht mit magischen Zahlenwerten der JVM herumschlagen müssen, gibt es in der Klasse java.lang.reflect.Modifier einige statische Methoden, die diese Ganzzahl testen. Zudem werden Konstanten definiert (wie Modifier.PUBLIC), mit denen dieser Integerwert verglichen werden kann. Da die Ganzzahl potenziell eine Kombination mehrerer Modifizierer kodiert, ist die gezielte Abfrage allerdings mit den isXXX()-Methoden einfacher. Obwohl eine Klasse nicht transient, synchronized, nativ sein kann, listen wir hier alle Methoden auf, da wir diese Modifizierer später auch für die Untersuchung von Methoden und Objekt- beziehungsweise Klassenvariablen per Reflection einsetzen. Jede dieser Testmethoden liefert true, wenn der gefragte Modifizierer in dem kodierten Ganzzahlwert enthalten ist. Alle Methoden sind static und liefern ein boolean-Ergebnis, außer to-String().

class java.lang.reflect.Modifier

• static boolean isAbstract( int mod )

• static boolean isFinal( int mod )

• static boolean isInterface( int mod )

• static boolean isNative( int mod )

• static boolean isPrivate( int mod )

• static boolean isProtected( int mod )

• static boolean isPublic( int mod )

• static boolean isStatic( int mod )

• static boolean isSynchronized( int mod )

• static boolean isTransient( int mod )

• static boolean isVolatile( int mod )

Betrachten wir die toString()-Methode der Klasse Modifier. Dort finden wir eine Liste aller möglichen Modifizierer mit den Konstanten.

public static String toString( int mod ) 
{ 
  StringBuffer sb = new StringBuffer(); 
  int len; 
  if ((mod & PUBLIC) != 0) sb.append("public "); 
  if ((mod & PRIVATE) != 0) sb.append("private "); 
  if ((mod & PROTECTED) != 0) sb.append("protected "); 
  /* Canonical order */ 
  if ((mod & ABSTRACT) != 0) sb.append("abstract "); 
  if ((mod & STATIC) != 0) sb.append("static "); 
  if ((mod & FINAL) != 0) sb.append("final "); 
  if ((mod & TRANSIENT) != 0) sb.append("transient "); 
  if ((mod & VOLATILE) != 0) sb.append("volatile "); 
  if ((mod & NATIVE) != 0) sb.append("native "); 
  if ((mod & SYNCHRONIZED) != 0) sb.append("synchronized "); 
  if ((mod & INTERFACE) != 0) sb.append("interface "); 
 
  if ((len = sb.length()) > 0)/* trim trailing space */ 
    return sb.toString().substring(0, len-1); 
  return ""; 
}

int modifier = Serializable.class.getModifiers(); 
out.println( modifier );                    // 1537 
out.println( Modifier.toString(modifier) ); // public abstract interface

23.2.8 Die Arbeit auf dem Feld

Die Utility-Klasse java.lang.reflect.Array stellt Methoden bereit, um auf Array-Objekten generisch zu arbeiten. Elemente lassen sich erfragen und setzen und auch Arrays mit einem gewünschten Typ anlegen.

Object array = Array.newInstance( int.class, 20 ); System.out.println(  
                                  Array.getLength(array) );  // 20 
Array.setInt( array, 0, –1 ); 
System.out.println( Array.getInt(array, 0) );     // –1

Bei newInstance() ist der Typ int.class und nicht int[].class!

Eine allgemeine Funktion set() und get() arbeitet für Objekte, wobei auch Wrapper für primitive Felder verwendet werden können.

Array.set( array, 0, Integer.valueOf(-1) ); 
System.out.println( Array.get(array, 0) );     // –1

Für mehrdimensionale Felder lässt sich bei newInstance() ein Feld von Größen angeben:

Object array = Array.newInstance( int.class, new int[]{ 2, 2 } ); 
((int[][])array)[0][0] = 1; 
((int[][])array)[1][1] = 1; 
System.out.println( Arrays.deepToString( (int[][])array ) ); // [[1, 0], [0, 1]]

Ihr Kommentar