Komponenten-basierte Entwicklung. Teil 9: Annotations

Transkript

1 Komponenten-basierte Entwicklung Teil 9: Annotations

2 Literatur [9-1] Nowak, Johannes: Fortgeschrittene Programmierung mit Java 5. dpunkt, 2005 [9-2] Mössenböck, Hanspeter: Sprechen Sie Java? dpunkt, 3. Auflage, 2005 [9-3] Chandrasekhara, Vasu et al.: Java 5.0. Hanser, 2005 [9-4] [9-5] 2

3 Ziele Angabe von über die Semantik von Java hinausgehende Informationen Ziele: Dokumentation Serialisierung, Stubs (Spezifikation der Schnittstellen) Hinweise auf Optimierungen Weitere Parametrisierung bzw. Konfiguration Werkzeugunterstützung Einheitlichkeit, d.h. nicht für verschiedene Anwendungsfälle unterschiedliche Syntax Passfähigkeit in die Konzepte von Java 3

4 Möglichkeiten Analyse zur Übersetzungszeit JavaDoc (Speziell aufgebaute Kommentare) Bestimmte Schlüsselwörter: transient, volatile Marker-Schnittstellen Annotations Analyse zur Laufzeit Reflektion Annotations 4

5 Marker-Schnittstellen Marker-Interface = Leere Schnittstelle, deren Name selbst eine weitere Spezifikation ist, die vom Compiler oder anderen Werkzeugen interpretiert wird Beispiele für Marker-Interfaces: Serializable Remote Werkzeuge können zur Laufzeit über Reflektion bzw. zur Übersetzungszeit diese Information auswerten. 5

6 Ziele von Annotations Sie müssen von Benutzer frei definierbar sein. Sie müssen jederzeit also zur Compile-Zeit, aber auch zur Laufzeit - analysierbar sein. Sie sind Bestandteil der Java-Syntax und damit der Sprache. Anwendbarkeit auf alle "größeren" Konstrukte, wie Klassen, Methoden etc. Der bestehende Code muss unabhängig davon sein. 6

7 Standard-Annotationen @SuppressWarni ngs Bedeutung Hiermit werden veraltete Routinen, Klassen etc. gekennzeichnet Eine Methode, die eine andere aus einer Oberklasse überschreibt wird so gekennzeichnet; damit wird Überladen aus Versehen verhindert. Um nervige Warnungen des Compilers zu unterdrücken Dies wird meist im Zusammenhang benutzt 7

8 Anwendungsfall I Es soll ein Objekt als Value-Objekt implementiert werden. Value-Objekt = Klasse/Objekt, das einmalig gesetzt und dann nur noch gelesen wird, wie z.b. String Alle Teilwerte sollen mit Referenztypen realisiert werden, um über den Wert Null die fehlende Initialisierung kennzeichnen zu können. Anwendungsbeispiel Es sollen GPS-Koordinaten von verschiedenen Orten behandelt werden. 8

9 Die Lösung I - Datei public class GPSPoint { public String comment; // Kommentar public String longitude; // Breitengrad public String latitude; // Längengrad public GPSPoint(String com, String longval, String latval) { this.comment= com; this.longitude= longval; this.latitude= latval; 9

10 Die Lösung II - Datei ValueObject.java (1) import java.lang.annotation.*; (4) ValueObject { Alle Annotationsbegriffe beginnen Der Typ dieser Annotation ist ein Interface (Zeile ist eine Meta-Annotation (Zeile 2): Der Compiler integriert diese Annotation in die class-datei, d.h. die Annotation ist per Reflektion ist eine Meta-Annotation (Zeile 3): definiert, dass diese Annotation nur auf eine Klasse/Interface anwendbar ist. 10

11 Die Lösung III Das Hauptprogramm public static void main(string[] args) { GPSPoint p1= new GPSPoint("08/07/ :57:59 CEST", " "," "); Koordinaten in Google-Maps 11

12 Die bestimmt die Zeitpunkte, zu denen die Werte der Annotation verarbeitet werden sollen. Wert RetentionPolicy.RUNTIME Bedeutung Informationen liegen auch zur Laufzeit vor. RetentionPolicy.CLASS RetentionPolicy.SOURCE Informationen werden in die class-datei geschrieben, liegen aber nicht zur Laufzeit vor. Informationen werden vom Compiler nicht übernommen. 12

13 Die bestimmt die Orte im Source-Code, wo die betreffende Annotation verwendet werden kann. Wert Bedeutung ElementType.TYPE ElementType.FIELD ElementType.PARAMETER ElementType.METHOD ElementType.PACKAGE ElementType.CONSTRUCTOR Klasse, Interface oder Enum Attribut einer Klasse und Enum-Konstanten Parameter-Deklaration Methoden-Deklaration Paket-Deklaration Konstruktor-Deklaration ElementType.LOCAL_VARIABLE Deklaration einer lokalen Variablen 13

14 Die führt dazu, dass diese Annotation auch an alle vererbten Klassen weiter gereicht wird, d.h. wenn bei einer der Unterklassen nach der damit verbundenen Annotation gesucht wird, wird diese gefunden. Die kennzeichnet Annotationen, die mit javadoc oder ähnlichen Programmen in die Dokumentation aufgenommen werden. 14

15 Eine weitere Annotation I Um zu spezifizieren, dass bestimmte Attribute nie Null sein dürfen, wird eine weitere Annotation definiert: (1) import java.lang.annotation.*; (4) NotNull { Der Typ dieser Annotation ist ein Interface (Zeile (Zeile 3) definiert, dass diese Annotation nur auf Attribute anwendbar ist. 15

16 Eine weitere Annotation public class GPSPoint { public String comment; // public String longitude; // public String latitude; // Längengrad public GPSPoint(String com, String longval, String latval) { this.comment= com; this.longitude= longval; this.latitude= latval; Damit haben wir die Kennzeichnungen über Annotationen eines Value-Objekt kennen gelernt ein solches Objekt ist aber dadurch noch nicht implementiert. 16

17 Auslesen von Annotationen I public static void main(string[] args) { GPSPoint p1= new GPSPoint("08/07/ :57:59 CEST", " "," "); listannotations(p1.getclass()); Die Annotationen können zur Laufzeit sofern vorhanden - über die Reflektion ausgelesen werden. 17

18 Auslesen von Annotationen II private static void listannotations(class clazz){ for(field attr : clazz.getdeclaredfields()) { NotNull val= attr.getannotation(notnull.class); if(val!=null) { System.out.println(attr.getType()+" "+ attr.getname()+" "+val); ValueObject valo= (ValueObject)clazz.getAnnotation( ValueObject.class); System.out.println("Class "+clazz.getname()+" "+valo); Output class java.lang.string class java.lang.string Class 18

19 Annotationen mit einem Parameter public class GPSPoint { public String comment; // public String longitude; // public String latitude; // Längengrad public GPSPoint(String com, String longval, String latval) { this.comment= com; this.longitude= longval; this.latitude= latval; missing") kann missing") geschrieben werden. 19

20 Annotationen mit einem Parameter II ToDo { String value() default "nothing"; In der Annotationsdefinition können beliebig viele Attribute, aber nur in der Form von Methoden angegeben werden. Mit default xyz lassen sich auch Default-Werte angeben, dann kann der Parameter bei der Benutzung weggelassen werden. 20

21 Annotationen mit einem Parameter III private static void listannotations(class clazz){ ToDo annval= (ToDo)clazz.getAnnotation(ToDo.class); if(annval!=null) { System.out.println("Class "+clazz.getname()+" "+annval); System.out.println("Value '"+annval.value()+"'"); public static void main(string[] args) { GPSPoint p1= new GPSPoint("08/07/ :57:59 CEST", " "," "); listannotations(p1.getclass()); Output Class missing) Value 'Write-Protection missing' 21

22 Hinweise Annotation werden sehr ähnlich zu Interfaces behandelt. Ein Attribute Namens value wird als Standardname aufgefasst, in dem Sinne, dass der Name nicht in der Keyword=Value Syntax benutzt werden muss. Wird ein anderer Attributname benutzt, so muss immer die Form Keyword=Value verwendet werden. Sind mehr als ein Attribut definiert, so muss immer die Form Keyword=Value verwendet werden. Als Datentypen lassen sich nur die folgenden verwenden: String Primitive Typen (int, boolean, float, double, byte) Aufzählungsklassen Andere Annotationen I(siehe Beispiel unten) Eindimensionale Felder bestehend aus den obigen Gruppen 22

23 Felder von Authors { public class GPSPoint { public String comment; // public String longitude; // public String latitude; // Längengrad 23

24 Felder von Attributen II private static void listannotations(class clazz){ Authors authorlist= (Authors)clazz.getAnnotation(Authors.class); String[] authors= authorlist.value(); String allauthors= ""; for(string person : authors) { allauthors+= " "+person; System.out.println("Authors"+allAuthors); Output Authors Harry Ulrike 24

25 Mehrfache @Target(ElementType.TYPE) ToDo { String value() ToDoContainer { ToDo[] javadocs") public class GPSPoint { public String comment; // Kommentar 25

26 Mehrfache Verwendung II private static void listannotations(class clazz){ ToDoContainer todolist= (ToDoContainer)clazz. getannotation(todocontainer.class); ToDo[] todos= todolist.value(); for(todo task : todos) { System.out.println("To Do '"+task.value()+"'"); Output To Do 'Write-Protection missing' To Do 'Write javadocs' 26

27 Mehrfache Verwendung III - Hinweise Wenn mehrere gleiche Annotationen benutzt werden sollen, dann wird dies über eine weitere Annotation realisiert, die die mehrfachen Annotationen als Werte (Annotationen) aufnimmt. Daher das Feld von Annotationen (ToDo[]). Diese Annotation fungiert hier als Container (und wird deshalb hier auch so genannt). Mit der wird die Container- Annotation eingeführt. Zum Auslesen wird vom Container über die Zugriffsmethode hier value() - das Feld der Annotationen ausgelesen. Jedes Element dieses Feldes ist dann eine normale Annotation, die wie gehabt behandelt wird. Bitte beachten Sie, dass der Name der Zugriffsmethode in der Annotation definiert wird (und deshalb auch anders als value() heißen kann). 27

28 Nach dieser Anstrengung etwas Entspannung... 28