Apache Groovy #5: Annotations & AST Transformation

In diesem Beitrag möchte ich dir zeigen, wie du mit Annotations in Groovy deinen Code dynamischer gestalten kannst und dir mit nur einer Zeile Code Funktionalitäten “laden” kannst, für welche man in anderen Sprachen deutlich mehr Code benötigt.

Wie setze ich eine Annotation?

Eine Annotation beginnt mit einem @ Zeichen, gefolgt von einer Zeichenkette. In Groovy gibt es diverse Annotations für ebenso diverse Aufgaben.

Du kannst dir durch eine Annotation zbsp. die Funktion ToString in deine Klasse laden, oder deine Klasse als unveränderlich (“Immutable”) markieren.

Eine unveränderliche Klasse erstellen

Erstellen wir uns zunächst eine unveränderliche Klasse mit einer Annotation, um diese als unveränderlich zu markieren.

class Auto {
    String marke
    String farbe
    int anzahlReifen
    int anzahlTueren
}

Um diese Klasse nun als unveränderlich zu markieren, müssen wir die Annotation groovy.transform.Immutable importieren und über den Klassennamen wie folgt schreiben.

import groovy.transform.Immutable

@Immutable
class Auto {
    String marke
    String farbe
    int anzahlReifen
    int anzahlTueren
}

Ansicht im Groovy AST Browser

Im AST Browser der GroovyConsole kannst du dir die erstellten Klassen anschauen, und dort können wir eben sehen, was der Groovy Compiler mit dieser Annotation gemacht hat. (ggf. müssen wir aus der Auswahlliste den Eintrag “Output” auswählen)

Wir sehen das mit der Annotation @Immutable an der Klasse diese nun final ist und alle Felder innerhalb der Klasse ebenso final sind.

@groovy.transform.Immutable
final public class Auto implements groovy.lang.GroovyObject extends java.lang.Object { 

    final private java.lang.String marke 
    final private java.lang.String farbe 
    final private int anzahlReifen 
    final private int anzahlTueren 

public class Auto implements groovy.lang.GroovyObject extends java.lang.Object { 

    private java.lang.String marke 
    private java.lang.String farbe 
    private int anzahlReifen 
    private int anzahlTueren 

Ein kleiner Test mit einer unveränderlichen Klasse

Wollen wir einmal zwei Instanzen unserer Autoklasse erstellen und versuchen ein Feld später wieder zu verändern.

import groovy.transform.Immutable

@Immutable
class Auto {
    String marke
    String farbe
    int anzahlReifen
    int anzahlTueren
}

auto1 = new Auto(marke:'VW', farbe:'rot', anzahlReifen:'4', anzahlTueren:'5')
auto2 = new Auto(marke:'Ford', farbe:'blau', anzahlReifen:'6', anzahlTueren:'5')

println auto1
println auto2

auto1.marke = 'Mercedes'

Ausgabe in der GroovyConsole:

groovy> import groovy.transform.Immutable 
groovy> @Immutable 
groovy> class Auto { 
groovy>     String marke 
groovy>     String farbe 
groovy>     int anzahlReifen 
groovy>     int anzahlTueren 
groovy> } 
groovy> auto1 = new Auto(marke:'VW', farbe:'rot', anzahlReifen:'4', anzahlTueren:'5') 
groovy> auto2 = new Auto(marke:'Ford', farbe:'blau', anzahlReifen:'6', anzahlTueren:'5') 
groovy> println auto1 
groovy> println auto2 
groovy> auto1.marke = 'Mercedes' 
 
Auto(VW, rot, 52, 53)
Auto(Ford, blau, 54, 53)
Exception thrown

groovy.lang.ReadOnlyPropertyException: Cannot set readonly property: marke for class: Auto

	at Auto.setProperty(Im.groovy)

	at Im.run(Im.groovy:17)

Wir sehen, dass der Code durchlaufen wird, jedoch wenn wir das Feld “marke” ändern wollen, wird eine Exception geworfen. Diese Exception kommt daher, da das Feld “marke” als final markiert ist und wenn dieses einmalig über den Konstruktor befüllt worden ist, nicht mehr verändert werden kann.

Überblick der Annotationen für AST Transformation

Einen guten Überblick der vorhandenen AST Transformation Annotations gibt es in der offiziellen Dokumentation von Apache Groovy unter Package groovy.transform.