Quelltext der Seite Annotation (Java)

Als '''Annotation''' wird im Zusammenhang mit der [[Programmiersprache]] [[Java (Programmiersprache)|Java]] ein Sprachelement bezeichnet, das die Einbindung von [[Metadaten#Metadaten in der Softwareentwicklung|Metadaten]] in den [[Quelltext]] erlaubt. Dieses Element wurde im [[Java Specification Request|JSR]] 175 festgelegt und mit der Version Java 5.0 eingeführt.

Annotationen beginnen mit einem @-Zeichen. Daran schließt sich ihr Name an. Optional kann eine kommagetrennte Parameterliste folgen, die in runden Klammern eingefasst wird. Beispielsweise markiert die Annotation im folgenden Quelltextausschnitt die Klasse A als überholt ([[deprecated]]):
<syntaxhighlight lang="java">
@Deprecated
public class A {}
</syntaxhighlight>

Ein ''Annotation Processor'' ist ein Compiler-Plugin, das Annotationen beim Kompilieren auswerten kann, um damit Warnungen und Fehlermeldungen zu unterdrücken oder auszulösen oder weiteren Quellcode oder andere Dateien zu generieren. Mit Annotationen versehenen Code kann er jedoch nicht ändern. Annotationen, bei denen das vorgesehen ist, können auch zur Laufzeit mittels [[Reflexion (Programmierung)|Reflection]] ausgewertet werden.

Eingesetzt werden Annotationen unter anderem im [[Jakarta EE|Jakarta-EE]]-Umfeld, um Klassen um Informationen zu erweitern, die vor Java 5 in separaten Dateien hinterlegt werden mussten. Prominente Beispiele sind Home- und Local-Interfaces sowie Deployment-Deskriptoren.

Eine Vorgängertechnik zur Einbettung von Metadaten in Java-Quelltexten ist die Verwendung spezieller [[Javadoc]]-Kommentare. Diese wurden mit Hilfe sogenannter [[Doclet]]s ausgewertet. Ein vielfach eingesetztes Werkzeug für diese Methode ist [[XDoclet]]. Diese Technik kann auch nach Einführung der Annotationen weiterhin verwendet werden.

== Vordefinierte Annotationstypen ==

In [[Java Platform Standard Edition|Java SE 5.0]] stehen sieben vordefinierte Annotationstypen zur Verfügung, die in den Paketen ([[Java-Syntax#Pakete, Namen, Klassen, Schnittstellen|Package]]) <code>java.lang</code> oder <code>java.lang.annotation</code> liegen. Sie werden alle (im Gegensatz zu den meisten Annotationen) vom Compiler ausgewertet. Weitere können von Programmierern erstellt werden.

{| class="wikitable"
! Annotation
! Beschreibung
|-
| colspan="2" align="left" | Im Paket <code>java.lang</code> befinden sich Annotationen.
|-
|@Deprecated
|Hiermit können Klassen, Attribute oder Methoden gekennzeichnet werden, die nicht mehr verwendet werden sollen. Der Compiler gibt dann eine Warnung aus, wenn ein so gekennzeichnetes Element verwendet wird.

Es empfiehlt sich zusätzlich, einen [[Javadoc]]-Kommentar anzubringen, der aufzeigt, wie das entsprechende Element ersetzt werden soll. Das folgende Beispiel zeigt dies:
<syntaxhighlight lang="java">

/**
 * @deprecated  Die Klasse A wurde mit Version 10.3 durch die Klasse ANeu ersetzt.
 */
@Deprecated
public class A {}
</syntaxhighlight>

|-
|@Override
|Mit diesem Typ kann eine Methode gekennzeichnet werden, die die Methode ihrer Oberklasse überschreibt. Der Compiler stellt dann sicher, dass die Oberklasse diese Methode enthält und gibt einen Fehler aus, wenn dies nicht der Fall ist.

Beispiel:
<syntaxhighlight lang="java">

public class A {
    public void eineMethode() {}
}
 
public class B extends A {
    @Override
    public void eineMethode() {}
}
</syntaxhighlight>

|-
|@SuppressWarnings
|Bei der Verwendung dieses Annotationstyps unterdrückt der Compiler bestimmte Warnungen. Der Annotation wird dazu ein Array mit Strings übergeben, die die zu unterdrückenden Warnungen enthalten.

Im folgenden Beispiel wird der Compiler angewiesen, die ''deprecated''-Warnung für die Klasse EineDeprecatedKlasse zu unterdrücken:
<syntaxhighlight lang="java">

public class A {
    @SuppressWarnings({"deprecation"})
    public void eineMethode() {
        EineDeprecatedKlasse b = new EineDeprecatedKlasse();
    }
}
</syntaxhighlight>

|-
|@SafeVarargs
|Mit dieser Annotation wird versichert, dass die Varargs-Parameter mit Generics nicht zur Laufzeit mit einem unpassenden Generics-Typ ersetzt werden. Beim Aufruf der Methode bzw. des Konstruktors wird dann keine Warnung angezeigt. Die Annotation wurde mit Java 7 eingeführt. Bis Java 6 konnte man beim Aufruf mit einer @SuppressWarnings-Annotation das Vertrauen in den aufgerufenen Code dokumentieren, ab Java 7 kann die Methode sich selbst als vertrauenswürdig deklarieren.

|-
| colspan="2" align="left" | Im Paket <code>java.lang.annotation</code> – diese werden nur für die Definition von Annotationen gebraucht.
|-
|@Documented
|Dieser Annotationstyp wird als Meta-Annotation verwendet: Eine Annotation dieses Typs legt für einen neu erstellten Annotationstyp fest, dass er von Javadoc bei der Erzeugung der Dokumentation berücksichtigt wird.
|-
|@Inherited
|Dieser Annotationstyp wird bei der Programmierung einer Annotation angewandt. Damit kann festgelegt werden, dass diese zusammen mit einer Klasse vererbt wird. Wird diese Annotation dann beispielsweise bei einer bestimmten Klasse angewendet, so gilt diese auch für alle Klassen, die von dieser erben.
|-
|@Retention
|Dieser Typ wird bei der Programmierung einer Annotation angewandt. Sie gibt an, wann auf sie selbst zugegriffen werden kann. Es gibt drei mögliche Werte für eine Annotation dieses Typs, die in der [[Aufzählungstyp|Enumeration]] <code>java.lang.annotation.RetentionPolicy</code> aufgeführt sind:
;CLASS:Die Annotation wird mit der Klasse kompiliert und ist damit in der .class-Datei vorhanden. Allerdings kann sie nicht während der Laufzeit einer Anwendung ausgelesen werden. Dies ist der Standardwert.
;RUNTIME:Die Annotation kann während der Laufzeit einer Anwendung mittels des [[Reflexion (Programmierung)|Reflection-Mechanismus]] ausgelesen werden.
;SOURCE:Die Annotation wird vor dem Kompilieren aus dem Quelltext entfernt. Entsprechend steht sie zur Laufzeit eines Programms nicht zur Verfügung.
|-
|@Target
|Dieser Annotationstyp wird bei der Programmierung einer Annotation angewandt. Damit wird festgelegt, auf welche Elemente eines Programms sie angewendet werden darf. Die möglichen Werte für eine Annotation dieses Typs sind in der Enumeration <code>java.lang.annotation.ElementType</code> aufgeführt.
;TYPE:Die Annotation kann nur auf Klassen, Interfaces oder Enumerations angewandt werden.
;FIELD:Die Annotation kann nur auf Felder angewandt werden.
;METHOD:Die Annotation kann nur auf Methoden angewandt werden. Konstruktoren sind dabei ausgeschlossen.
;PARAMETER:Die Annotation kann nur auf Parameter von Methoden und Konstruktoren angewandt werden.
;CONSTRUCTOR: Die Annotation kann nur auf Konstruktoren angewandt werden.
;LOCAL_VARIABLE: Die Annotation kann nur auf lokale Variablen angewandt werden.
;ANNOTATION_TYPE:Die Annotation kann nur auf Annotationen angewandt werden.
;PACKAGE: Die Annotation kann nur auf Paketen angewandt werden.
|}

== Definition eigener Annotationen ==

Annotationen sind spezielle Schnittstellen; ihre Namen werden daher konventionsgemäß mit großem Anfangsbuchstaben geschrieben. In ihrer Vereinbarung steht vor <code>'''interface'''</code> das Zeichen <code>@</code>. Sie erweitern implizit die Schnittstelle <code>java.lang.annotation.Annotation</code>. Sie dürfen keine andere Schnittstellen erweitern (d.&nbsp;h. <code>'''extends'''</code> ist verboten) und sind nicht generisch. Ihre Methoden sind parameterlos und nicht-generisch. Als Ergebnistypen (return type) sind nur folgende Typen erlaubt:

* primitive Typen
* Aufzählungstypen (<code>'''enum'''</code>)
* Annotationstypen
* <code>String</code>
* <code>Class</code>
* Felder (arrays) aus diesen Typen

Sie werfen auch keine Ausnahmen und dürfen keine Rekursion verwenden.

Viele Annotationen enthalten keine Methoden. Ein Beispiel wäre:
<syntaxhighlight lang="java">
@interface Vorlaeufig { }
</syntaxhighlight>
Andere Annotationen enthalten (wie für Schnittstellen üblich) Methoden, allerdings nur mit den oben aufgeführten Ergebnistypen. Wenn eine Annotation nur eine Methode enthält, ist ihr Name konventionsgemäß <code>value</code>:
<syntaxhighlight lang="java">
@interface Test {
	boolean value(); // true solange nicht freigegeben
}
</syntaxhighlight>
oder
<syntaxhighlight lang="java">
@interface Autoren {
	String[] value(); // Namen der Autoren
}
</syntaxhighlight>
oder
<syntaxhighlight lang="java">
@interface Kunden {
	Person[] value();
}
</syntaxhighlight>
wobei Person als Aufzählungstyp (<code>'''enum'''</code>) oder Annotation definiert werden muss, z.&nbsp;B.:
<syntaxhighlight lang="java">@interface Person {
	String name();
	int alter();
}
</syntaxhighlight>
Bei der Vereinbarung von Annotationen werden häufig die Standard-Annotationen aus dem Paket <code>java.lang.annotation</code> verwendet. Insbesondere soll mit <code>@Retention</code> angegeben werden, wie lange die Annotation aufbewahrt werden soll: nur im Quelltext (<code>SOURCE</code>), in der gespeicherten class-Datei (<code>CLASS</code>) oder auch in der geladenen Klasse (<code>RUNTIME</code>). <code>@Target</code> beschreibt, für welche Programmelemente die Annotation verwendet werden darf. Beispielsweise sind alle Annotationsvereinbarungen im Paket <code>java.lang.annotation</code> mit den Annotationen
<syntaxhighlight lang="java">
@Documented
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
</syntaxhighlight>
versehen. Hierdurch werden sie alle von javadoc ausgewertet, im [[Bytecode]] mit geladen und können so zur Laufzeit ausgewertet werden; außerdem dürfen sie nur für Annotationstypen verwendet werden.

== Verwendung eigener Annotationen ==
Eine Annotation ohne Methoden, wie <code>@Vorlaeufig</code>, kann z.&nbsp;B. einer Klasse vorangestellt werden:
<syntaxhighlight lang="java">
@Vorlaeufig
class Klasse {
	void methode();
}
</syntaxhighlight>
Einer Annotation mit nur einer Methode mit dem Namen <code>value</code> muss in Klammern ein konstanter Wert vom Ergebnistyp dieser Methode mit angegeben werden:
<syntaxhighlight lang="java">
@Test(true)
public void methode() { ... }
</syntaxhighlight>
Wenn der Ergebnistyp ein Array ist, soll ein Arrayliteral verwendet werden:
<syntaxhighlight lang="java">
@Autoren({"Solymosi", "Grude"})
String buch = "Algorithmen und Datenstrukturen mit Java"
</syntaxhighlight>
Wenn das Array keine Elemente enthält, muss <code>({})</code> mit angegeben werden. Wenn das Array jedoch nur ein Element enthält, können die geschweiften Klammern weggelassen werden:
<syntaxhighlight lang="java">
@Autoren("Solymosi")
String anderesBuch = "Programmieren in Scala"
</syntaxhighlight>
Einer Annotation mit mehreren Methoden muss jeder ihrer Methoden in Klammern ein konstanter Wert zugewiesen werden:
<syntaxhighlight lang="java">
@Person(name = "Andreas Solymosi", alter = 56)
Konto konto = new Konto();
</syntaxhighlight>
Die Möglichkeit, den Wert mit dem Namen anzugeben, besteht auch für Annotationen mit einer Methode (ist allerdings überflüssig, dient höchstens der Lesbarkeit):
<syntaxhighlight lang="java">
@Test(value = true)
</syntaxhighlight>
Eine komplexe (geschachtelte) Annotation muss geschachtelt angewendet werden:
<syntaxhighlight lang="java">
@Kunden(@Person(name = "Andreas Solymosi", alter = 56))
class Unternehmen { … }
</syntaxhighlight>
In der Vereinbarung der Annotation können für die Methoden Standardwerte definiert werden; dann kann der entsprechende Wert bei der Verwendung weggelassen werden. Da Annotationen Schnittstellen sind, können sie selber mit Annotationen markiert werden:
<syntaxhighlight lang="java">
@Autoren("Solymosi")
public @interface Test {
	boolean wert() default false; // muss nicht unbedingt wert heißen
}
</syntaxhighlight>

== Auswertung von Annotationen ==

Wenn die Annotationen mit dem Bytecode der Klasse geladen werden, können sie mit Hilfe von Reflexion ausgewertet werden. Beispielsweise kann man feststellen, ob eine Annotation angegeben wurde oder nicht:

<code>
'''boolean''' istVorlaeufig = Klasse.'''class'''.isAnnotationPresent(Vorlaeufig.'''class''');
</code>

Wenn man festgestellt hat, dass die Annotation vorhanden ist, dann kann man auch ihren Wert lesen, z.&nbsp;B. ob die Methode noch im Testzustand ist oder nicht:

<code>
Test test = Klasse.'''class'''.getMethod("methode", '''new''' Class[]{}).getAnnotation(Test.'''class''').value();
</code>

Wenn hierbei die Annotation nicht vorhanden ist, wird von <code>getAnnotation()</code> die Ausnahme <code>NullPointerException</code> ausgelöst.
Aus einer komplexen Annotation müssen ihre Elemente einzeln selektiert werden:

<code>
Person kunden = Unternehmen.'''class'''.getAnnotation(Kunden.'''class''').value()[0];
</code>

== Annotation von Paketen ==
Die ''Java Language Specification'' erlaubt auch die Annotation von Paketen, beispielsweise um Dokumentation zu einem Paket bereitzustellen. Pro Paket darf maximal eine <code>package</code>-Deklaration mit Annotationen versehen sein. Falls ein Paket Annotationen erhalten soll, empfiehlt die ''Java Language Specification'', eine gesonderte Datei namens <code>package-info.java</code> im Verzeichnis dieses Pakets anzulegen. Diese Datei beinhaltet dann die <code>package</code>-Deklaration mit den Annotationen.

== Weblinks ==
* [http://public.beuth-hochschule.de/~solymosi/veroeff/Annotationen.html Annotationen in Java]
* [http://docs.oracle.com/javase/tutorial/java/annotations/ Annotations] in Suns Java-Tutorial (englisch)
* [http://docs.oracle.com/javase/1.5.0/docs/guide/apt/index.html Annotation Processing Tool (apt)] (englisch)
* [http://docs.oracle.com/javase/1.5.0/docs/guide/language/annotations.html The J2SE 5.0 Annotations Feature] bei Sun (englisch)
* [http://jcp.org/en/jsr/detail?id=175 JSR 175: A Metadata Facility for the JavaTM Programming Language] (englisch)
* [http://docs.oracle.com/javase/specs/jls/se8/html/jls-9.html#jls-9.7 Annotations] in der [[Java Language Specification]] (englisch)
* [https://openbook.rheinwerk-verlag.de/javainsel/10_008.html#u10.8 Annotationen] in „Java ist auch eine Insel“

[[Kategorie:Java (Programmiersprache)]]