Intersult: Coder

Intersult Coder ist ein Werkzeug zur Analyse und zum Generieren von Code.

Wichtige Bestandteile sind:

Reflector: Stellt ein erweitertes Reflection für Java-Klassen zur Verfügung mit der Unterstüzung von Argumentnamen (bei Methoden), Generics, Annotations und Kommentaren.
Generator: Generiert Code aus erstellten JavaClass-Dateien und schreibt diesen in Dateien.
Instance: Es können Instanzen von Klassen erzeugt werden, die nicht vom ClassLoader geladen wurden. Dabei handelt es sich natürlich nicht um "echte" Instanzen, sondern Objekte vom Typ com.intersult.code.Instance.

Reflector#

Der com.intersult.code.Reflector kann genutzt werden, um Informationen über Java-Klassen zu gewinnen.

Da der Reflector die reflektierten Klassen in internen Listen ansammelt, kann es nützlich sein den Reflector nach Gebrauch dem Garbage-Collector zu übergeben. Für diesen Fall kann ein Reflector durch new Reflector() einfach erzeugt werden. Für alle anderen Fälle kann die Default-Instanz Reflector.INSTANCE verwendet werden.

Anwendung#

Beim Generieren von neuen Klassen mit dem Generator werden häufig bestehende Klassen und Systemklassen gebraucht. Diese brauchen nicht "per Hand" gebaut werden, sondern können vom Reflector erzeugt werden.

Darüber hinaus liefert der Reflector einige nützliche Informationen über eine Klasse, die über die Java-Reflection nicht zugreifbar sind. Dazu gehören die Namen von Methoden-Parametern und Kommentare von Klassen und Methoden. Dies wird zum Beispiel vom SOAP-Service Abraxas benutzt, um die Service-Aufrufe zu erzeugen.

Beispiel#

    JavaClass stringClass = Reflector.INSTANCE.reflect(String.class);
    System.out.println(stringClass.getTypeNameSimple(true));
    System.out.println(stringClass.getClassDefinition());

Erklärung: Der Reflector erzeugt aus der String.class-Klasse eine JavaClass, die erweiterte Methoden enthält, wie zum Beispiel getTypeName und getTypeNameSimple. Die Methode getClassDefinition liefert die Definition, wie sie in der Java-Datei steht, für String:

public final class String implements Serializable, Comparable<T>, CharSequence

Basis-Typen#

Die String-Klasse aus dem oberen Beispiel hätte nicht reflektiert werden müssen, da sie zur Grundausstattung des Reflector gehört (tatsächlich wird auch in diesem Fall dieselbe JavaClass zurück geliefert, da jede JavaClass nur einmal existiert).

Folgende Klassen sind bereits enthalten:

WILDCARD, OBJECT, STRING, VOID, ATOMIC_VOID, SHORT, ATOMIC_SHORT,
INTEGER, ATOMIC_INTEGER, LONG, ATOMIC_LONG, BOOLEAN, ATOMIC_BOOLEAN,
BYTE, ATOMIC_BYTE, DOUBLE, ATOMIC_DOUBLE, FLOAT, ATOMIC_FLOAT,
BIG_DECIMAL, CLASS, DATE, URI, URL, QNAME, LIST, SERIALIZABLE,
BASE64

Dazu kommen Annotation-Klassen:

OVERRIDE, REQUIRED, DEFAULT, NAME, KEY

Generator#

Viele Fälle der Code-Generierung, z.B. aus XML-Schema (XSD) oder WSDL können mit Plugins abgedeckt werden, wie dem Abraxas Maven Plugin.

Für die Implementierung eigener Maven-Plugins oder anderer Art von Code-Generierung kann die Klasse com.intersult.code.Generator direkt verwendet werden. Die Verwendung ist dabei sehr einfach:

    JavaClass javaClass = new JavaClass("com.intersult.test", "Test");
    javaClass.generatePath();
    Generator.generateClass(Reflector.INSTANCE, javaClass);

Erklärung: Es wird eine neue Klasse com.intersult.test.Test erzeugt. Die Methode generatePath erzeugt den Package-Pfad, der nicht in jedem Fall erwünscht sein kann. Der Generator schreibt dann mit generateClass die Klasse in Dateien. Der Java-Standard ist dabei so definiert, dass Unterklassen (Sub-Classes) in getrennte Dateien geschrieben werden mit dem Namensmuster <Hauptklasse>$<Unterklasse>.

Optional kann eine Liste übergeben werden, in der die generierten Dateien eingetragen werden:

    List<File> files = new ArrayList<File>();
    Generator.generateClass(Reflector.INSTANCE, javaClass, list);

Methods#

Das Hinzufügen einer Methode inklusive Code kann zum Beispiel so aussehen:

	JavaMethod equals = javaClass.addMethod("equals");
	equals.setReturnType(Reflector.INSTANCE.ATOMIC_BOOLEAN);
	equals.addAnnotation(Reflector.INSTANCE.OVERRIDE.newInstance());
	JavaVariable object = new JavaVariable(Reflector.INSTANCE.OBJECT);
	equals.getParameters().add(object);
	equals.getCode().add("if (" + object.getVariableName() + " == null || !(" + object.getVariableName() +
		" instanceof " + javaClass.getTypeNameSimple(false) + "))");
	equals.getCode().add("\treturn false;");
	equals.getCode().add("if (this == " + object.getVariableName() + ")");
	equals.getCode().add("\treturn true;");
	JavaVariable field = javaClass.getFields().get("field");
	equals.getCode().add("return " + field.getGetter() + "().equals(((" + javaClass.getTypeName(false) + ")" +
		object.getVariableName() + ")." + field.getGetter() + "());");

Beans und Properties#

In Java werden Felder mit Gettern und Settern zugegriffen. Die Methoden dazu heißen Accessors und können mit einer Methode hinzugefügt werden:

    Accessor accessor = javaClass.addAccessor(Reflector.INSTANCE.STRING, "name");

Instance#

Hat man eine JavaClass vorliegen, bekommt man über die Methode getType() das Java-Class-Objekt zurück. Mit newInstance() bekommt man eine neue Instanz. Dieser Fall liegt immer vor, wenn die JavaClass vom Reflector bezogen wurde.

Eine JavaClass kann allerdings auch aus dem Code erzeugt werden, also über den Konstruktor new JavaClass("<package>", "<name>"). In diesem Fall kann eine Instance durch die Methode newInstance() der Klasse JavaClass erzeugt werden. Es handelt sich natürlich um keine echte Java-Instanz, sondern um ein Objekt vom Typ com.intersult.code.Instance.

Annotations#

Instance wird auch bei der Verwendung von Annotations benutzt. Die Code-Generierung arbeitet ja mit JavaClass-Objekten, da diese aus dem Code heraus gebaut werden können. Instanzen werden benötigt, da eine Annotation-Klasse instantiiert wird, sobald sie an einer Stelle im Code mit dem @-Operator angebracht wird.