1. Programmieren gegen Schnittstellen Advanced Programming Techniques

Transkript

1 1. Programmieren gegen Schnittstellen Advanced Programming Techniques Sommersemester 2008 Prof. Dr. Bernhard Humm Hochschule Darmstadt, FB Informatik 1 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

2 Einordnung in den gesamten Kurs 1. Einführung 2. Java Schnellkurs 3. Programmieren gegen Schnittstellen 4. Komponenten und Schnittstellen 5. Klassenbibliotheken 6. Design Patterns 7. Refactoring 8. Fehlerbehandlung 9. Debugging, Logging, Tracing 10. Performance-Optimierung 2 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

3 Agenda Prinzipien Schnittstellen JavaDoc JUnit

4 Die Urmutter aller Design-Prinzipien: Separation of concerns Trennung der Zuständigkeiten (Separation of concerns): Trenne Software unterschiedlicher Belange in verschiedene Bereiche auf 4 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

5 Geheimnisprinzip (Information Hiding): eines der wichtigsten Konzepte des Software Engineering David L. Parnas Das Geheimnisprinzip (Information hiding): Die Implementierung komplexer Datenstrukturen soll in einer Klasse (Komponente) verborgen werden Nutzer erhalten nur eine abstrakte Sicht auf die Daten (abstrakte Datenstrukturen) Der Datenzugriff erfolgt nur über die Methoden (Encapsulation = Kapselung) 5 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

6 Diskussion Geheimnisprinzip Die Datenkapselung hat folgende Vorteile: Gekapselte Klassen sind einfacher nutzbar (reduzierte Komplexität) Sie können ohne Auswirkung auf andere Klassen geändert werden Es bestehen jedoch auch Nachteile: Zugriff etwas weniger effizient Eingeschränkte Flexibilität des Zugriffs, da nur über Methoden der Klasse auf die Daten zugegriffen werden kann Folge: Es werden stets zwei Rollen unterschieden: Anbieter und Nutzer Nutzer Anbieter 6 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

7 Nutzer- und Anbieterrollen: Methoden Deklaration C c; ReturnType result; Nutzer Anbieter Definition (Außensicht) Signatur public class C { public ReturnType m (ParamType1 p1) result = c.m(p1); Nutzung Implementierung (Innensicht) { return result; } 7 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

8 Nutzer- und Anbieterrollen: Klassen Nutzer Anbieter Entweder selbst definiert, Teil der Java- Bibliothek oder von Dritten Deklaration Definition (Außensicht) C c; public class C { } Nutzung Implementierung (Innensicht) c = new C(); Type1 variable1; ReturnType method1(argtype1) 8 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

9 Agenda Prinzipien Schnittstellen JavaDoc JUnit

10 Interfaces Das Programmieren gegen Schnittstellen (Interfaces) ist eines der wichtigsten Konzepte der Programmierung Interface: beschreibt die Außensicht, das heißt die Sicht des Nutzers ist einfach ist vielseitig verwendbar Klasse: enthält die Innensicht, das heißt die Sicht des Programmierers ist komplex ist speziell cd Collections «interface» List + add() : void + get() : void + contains() : void + remove() : void «realize» ArrayList «realize» LinkedList 10 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

11 Analogie Mensch Jeder Mensch hat viele Eigenschaften. Aber für bestimmte Personengruppen sind nur bestimmte Eigenschaften wichtig: Verkehrspolizist: Führerschein Arbeitgeber: Lebenslauf, Aufgaben, Einkommen Bibliothek: Leihausweis Familie: jede Menge anderer Eigenschaften Eine Klasse, zum Beispiel Customer, kann viele Eigenschaften haben. Aber für bestimmte Collaborations sind nur bestimmte Eigenschaften wichtig: Kundenverwaltung: fachliche Attribute und Funktionen SortedSet: Comparable Client-Server Kommunikation: Serializable 11 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

12 Schnittstellen oder wie man es auch sehen kann ;-) Patient Katze Haustier class Katze implements Patient, Haustier {} Meine Katze ist auch objektorientiert [Roger King] 12 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

13 Definition Schnittstelle und Operation Eine Schnittstelle (Interface) fasst Operationen zusammen. Sie wird spezifiziert durch: (1) Einen eindeutigen Namen, (2) Die Menge der zugehörigen Operationen (3) Ein Schnittstellen-Protokoll im Sinne von Reihenfolgen und Restriktionen beim Aufruf der Operationen. Operationen (Operations) beschreiben das Verhalten von Komponenten. Sie werden spezifiziert durch: (1) Signatur: Name der Operation, Parameter und Rückgabewerte und deren Typen, Ausnahmen (2) Semantik: Verhalten der Operation (3) Nichtfunktionale Eigenschaften: z.b. Performanz, Verfügbarkeit, Kosten etc. 13 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

14 Spezifikation von Schnittstellen Schnittstelle Name public interface OrderManager { Schnittstellenname Operationen Signatur Semantik } Rückgabetyp Operationsname Eingabeparameter und -typ Order placeorder (Customer customer, Article article) throws NotAvailableException; Prosa, Vorbedingungen, Nachbedingungen, etc. Ausnahme Nicht-funktionale Eigenschaften Prosa Protokoll Prosa, Sequenzdiagramme etc. 14 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

15 Vorbedingungen und Nachbedingungen Vorbedingungen (Pre-conditions) Bedingungen, die vor Ausführung der Operation erfüllt sein müssen, z.b. Eigenschaften der Parameter muss der Nutzer der Operation zusichern der Anbieter darf die Arbeit einstellen, wenn die Vorbedingung verletzt ist (zusätzliche Prüfung erhöht die Sicherheit: bei Verletzung Abbruch mit Ausnahme) Beispiel: Artikel muss verfügbar sein, wenn er bestellt wird Nachbedingungen (Post-conditions) Bedingungen, die nach Ausführung der Operation erfüllt sein müssen, z.b. Eigenschaften des Ergebnisses Muss der Anbieter der Operation zusichern Nutzer der Operation kann davon ausgehen (Zusätzliche Prüfung erhöht die Sicherheit: bei Verletzung Abbruch mit Ausnahme) Beispiel: Nach erfolgreicher Bestellung ist Rechnung erzeugt 15 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

16 Deklaration eines Interface in Java Interfaces enthalten: Instanzmethoden Konstanten Interfaces haben keine Konstruktoren. Interfaces enthalten keine Implementierung. interface Customer { public String getname(); public void setname(string name); } 16 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

17 Nutzung eines Interface in Java Man sagt: Eine Klasse implementiert ein Interface, wenn sie jede einzelne Methode des Interfaces bereitstellt. Eine Klasse kann beliebig viele Interfaces implementieren. Ein Interface kann von beliebig vielen Klassen implementiert werden. Eine Referenz auf ein Interface kann überall dort im Code eingesetzt werden, wo auch eine Referenz auf eine Klasse erlaubt ist. class CustomerImpl implements Customer { public CustomerImpl(String name) {...} public String getname() {...} public void setname(string name) {...} } 17 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

18 Interfaces Beispiel: Zugriff auf Kundendaten (mit Interface) Customer mycustomer = new CustomerImpl( Willi );... Map mycustomers = new HashMap <Customer>(); mycustomers.put( Kunde1234, mycustomer); mycustomer = mycustomer.get( Kunde1234 ); class SomeOtherClass { } public boolean processcustomer(customer cust) {... }; 18 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

19 Gegen Schnittstellen programmieren Configurator 2 AbstractList <<creates>> <<creates>> MyApplication 3 <<uses>> List ListImpl 1 19 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

20 Nutzer- und Anbieterrollen: Interfaces Nutzer C wird nur in der Konfiguration sichtbar Anbieter Deklaration und Konfiguration I i; i = new C(); Definition (Außensicht) public interface I { public void m (); } i.m(); Nutzung Implementierung (Innensicht) public class C implements I { public void m() {} } 20 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

21 Interfaces Übersicht über Collections, Maps und deren Interfaces Collection Map List Set SortedMap HashMap Hashtable ArrayList Vector HashSet SortedSet TreeMap LinkedList Stack TreeSet Interface Class 21 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

22 Jede Menge *ables Adjustable Appendable Callable Cloneable Comparable Destroyable Externalizable Flushable Formatable Identifyable Iterable Joinable Manageable Printable REadable Referncable Refrehable Runnable Scrollable Serializable Streamable Throwable Timeable Transferable Writeable 22 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

23 Nutzung von Schnittstellen: Das Prinzip der minimalen Annahme Prinzip der minimalen Annahme Nutze Schnittstellen, wo sie zur Verfügung stehen, z.b. List statt ArrayList, Map statt HashMap Nutze die allgemeinste Schnittstelle, die den erforderlichen Dienst bereitstellt, z.b. Collection statt List, Iterator statt ListIterator 23 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

24 Agenda Prinzipien Schnittstellen JavaDoc JUnit

25 JavaDoc Dokumentationskommentare Dokumentationskommentare /**... */ können vor die Deklarationen von Klassen, Methoden, Feldern gesetzt werden. Werkzeug javadoc erzeugt daraus Dokumentation in HTML /** A stack of integers. This is a FIFO data structure storing integers in a stack-like way. */ public class Stack { /** The elements in the stack. */ private int[] data;... /** Push an integer on the stack. If the stack is full an error is reported and the program stops. */ public void push (int x) {... }... } 1. Satz bis Punkt wird in Kurzdoku übernommen Rest wird in Langdoku übernommen 25 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

26 JavaDoc Kommentare für Klassen /** * Description of class or interface. * $Author$ $Id$ * javax.swing.text.document */ public class Test {... } 26 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

27 JavaDoc Tag Conventions Standardtags in der Reihenfolge ihrer (Nur bei Klassen und Schnittstellen; (Nur bei Klassen und Schnittstellen; (Nur bei Methoden und Konstructoren ; (Nur bei Methoden ; (@throws ist ein Synonym seit @serial or 27 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

28 JavaDoc Erzeugte HTML-Datei (Stack.html) 28 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

29 Agenda Prinzipien Schnittstellen JavaDoc JUnit JUnit

30 JUnit Überblick JUnit ist ein regressives Testframework Geschrieben von Erich Gamma und Kent Beck Entwicklung von Tests für beliebige Software-Einheiten OpenSource XProgramming 30 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

31 JUnit Was unterstützt JUnit? Einfache Automatisierung der Tests Ausgabe der Ergebnisse erfolgt graphisch oder textuell Soll/Ist-Vergleich mittels assert()- und fail()-methoden Dokumentation der Testergebnisse 31 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

32 JUnit Wie funktioniert JUnit? Anlegen einer Subklasse von TestCase (junit.framework.testcase) Definition eines Konstruktors mit Übergabeparameter Testname Öffentliche Methoden die mit test beginnen sind Testfälle Vor jedem Test wird - falls vorhanden - die öffentliche Methode setup() aufgerufen Nach jedem Test wird - falls vorhanden - die öffentliche Methode teardown() aufgerufen Die Testfälle einer Testklasse werden in der Methode suite() zusammengefasst Testklassen werden zu Testpaketen zusammengefasst 32 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

33 JUnit Beispiel für einen TestCase import junit.framework.testcase; public class StrUtilJUnitTest extends TestCase { String txt; public StrUtilJUnitTest(String testcasemethodname) { super(testcasemethodname); } public void setup() { txt = "otto hugo rudie"; } public void teststr2strarray() { String[] arr1 = StrUtil.str2StrArr(txt); assertequals("otto", arr1[0]); assertequals("hugo", arr1[1]); assertequals("rudi", arr1[2]); } } 33 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS

34 JUnit Auswahl bereitgestellter Assert und Fail Metoden public static void assertequals(boolean expected, boolean actual) public static void assertequals(double expected, double actual, double delta) public static void assertnull(object object) public static void assertnotnull(object object) public static void assertsame(java.lang.object expected, lang.object actual) public static void asserttrue(boolean condition) public static void fail() public static void fail(string message) Alle Methoden werden auch mit einem Message-Parameter angeboten 34 Prof. Dr. Bernhard Humm, Hochschule Darmstadt, FB Informatik: Advanced Programming Techniques, SS