PRAXISBUCH WICKET PROFESSIONELLE WEB-2.0- ANWENDUNGEN ENTWICKELN

Transkript

1 michael MOSMANN PRAXISBUCH WICKET PROFESSIONELLE WEB-2.0- ANWENDUNGEN ENTWICKELN

2 Inhalt Vorwort...XIII 1 Einleitung Warum Wicket? Einfach, Konsistent, Offensichtlich Wiederverwendbarkeit Sauber getrennt Sicher Effizient und skalierbar Komplett Eine gute Wahl Vorbereitung und Installation Java, Maven und Eclipse Versionskontrolle mit Subversion Grundlagen einer Webanwendung Anwendungsschichten Verzeichnis und Paketstruktur Unit-Tests Aufsetzen der Teilprojekte Nomenklatur der Teilprojekte Aufsetzen der Teilprojekte Projektbasis ParentPom Teilprojekt Base Teilprojekte Datenbankkonfiguration Teilprojekt Persistenz Teilprojekt Applikationsschicht Teilprojekt Webapp Teilprojekt ParentPom Abschluss Erstellen von Eclipse-Projektdateien...27 VII

3 Inhalt 3 Mit Leben füllen Konfiguration mit Spring Datenbankkonfiguration Teilprojekt dbconfig Teilprojekt dbconfig-test Teilprojekt dbconfig-schema-update Schemagenerierung mit Hibernate Persistenz Datenbankzugriff Allgemeine Schnittstellendefinition Datenbankzugriff Hilfsklassen Datenbankzugriff User Datenbankzugriff Konfiguration Persistenz-Tests Schema-Update Anwendungsschicht Präsentationsschicht Hilfsklasse für Maven-Projekte Wicket Web Application Servlet-Konfiguration Spring-Konfiguration Start der Anwendung Die Wicket-Architektur Wicket und das HTTP-Protokoll Struktur WebApplication Session PageMap Page PageStore Component Request-Behandlung Komponentenphasen Nebenläufigkeit Threads Komponenten, Modelle, Markup Komponenten Modelle Markup Modelle Konverter Einfache Modelle Modelle verändern Modell-Hilfsklassen Modelle und Serialisierung DetachableModel Dynamische Modelldaten...61 VIII

4 Inhalt Kaskadierung von Modellen Automatische Kaskadierung von Modellen Datenbankzugriffsmodelle Komplexe Modellklassen Zugriff auf Bean-Properties Die Klasse PropertyModel CompoundPropertyModel Ausgelagerte Informationen Einfacher Zugriff auf Ressourcen...76 ResourceModel StringResourceModel Komponenten Basisklasse Component Komponentenbaum Darstellungsphasen Page, Session und Application Komponentenpfad Modelle Feedback Grundlagen der Vererbung Eine Seite mit eigenen Komponenten Vererbung für Fortgeschrittene Style, Locale und Variation Markup-Variationen Sichtbarkeit wicket:enclosure Empfehlung zur Anwendung Ajax Ajax-Events Einfache Event-Behandlung Automatische Event-Behandlung Basiskomponenten Gruppierende Komponenten Seiten Panel Fragment Border ComponentBorder WebMarkupContainer Inhaltselemente Label und MultiLineLabel Lokaler Konverter XML Das wicket:message-tag IX

5 Inhalt Image Links Von A nach B Ajax und Links Link-Tricks Externe Links Popups ResourceLink Formularlinks Behavior Darf es etwas JavaScript sein? Attribute anpassen Attribute erweitern Ajax und Formulare Listen und Tabellen Darstellung von Listen RepeatingView RefreshingView ListView PropertyListView ColumnListView DataProvider DataView GridView DataGridView DataTable DefaultDataTable Formulare Voraussetzungen Feedback Basisklasse für alle Beispiele Formulare absenden Absenden mit Submit-Button Button-Komponente Submit per Ajax POST und GET Textfelder Typangabe Automatische Typermittlung Label CheckBox RadioButton Auswahlfelder Select X

6 Inhalt DropDownChoice ListMultipleChoice Dateien hochladen FileUpload MultiFileUpload Gültigkeitsprüfung StringValidator Minimum und Maximum URL Eigene Validatoren FormValidator Passwortprüfung Eigene Prüfung Ajax AjaxFormSubmitBehavior AjaxFormValidatingBehavior AjaxComponentUpdatingBehavior OnChangeBehavior AutoCompleteTextField AjaxEditableLabel Erweitertes Feedback Feedback zum Formular Feedback für die Komponente Feedback als Rahmen Feedback als Indikator Feedback per CSS Generierte Formulare Verschachtelte Formulare Sessions und Security Einfache Variante Eine eigene Session-Klasse Geschützte Seiten Strategie WebApplication Seiten Marker an Komponenten Elemente ausblenden Wicket in der Praxis Die Integration von Spring Navigation CSS einbinden Eigene Basiskomponenten XI

7 Inhalt 11.5 Komponententausch AjaxFallbackConfirmLink Wizard Suchmaschinenoptimierung Pfad für BookmarkablePages SessionTimeoutPage SEO-Links Servlet-Filter Tracking mit Google Analytics Ressourcen Dynamisch erzeugte Grafiken Automatisch generierte Thumbnails Download durch Formular Shared Resources RSS-Feed Links auf Seiten und Ressourcen Optimierungen Applikation Konverter Debug Ressource Fehlersuche Häufige Fehlerquellen Komponenten fehlen Komponente ist bereits vorhanden Ajax funktioniert nicht Unit-Tests Anfang oder Ende? Register XII

8 1 1 Einleitung Ich bin im Frühjahr 2008 auf Wicket aufmerksam geworden. Doch da hatte Wicket bereits eine längere Entwicklung hinter sich, denn es wird bereits seit 2005 entwickelt wurde Wicket ein offizielles Apache-Projekt, und im Januar 2007 wurde dann das erste Release als Apache-Projekt veröffentlicht. Seit April 2008 setze ich Wicket mit viel Freude in Projekten ein. Die Idee zu diesem Buch entstand, nachdem ich ein paar Monate mit Wicket gearbeitet hatte und die Begeisterung für das Framework immer stärker zunahm. Ich hatte zu dem Zeitpunkt bereits einiges über Wicket gelesen, vermisste aber oft den Praxisbezug der Beispiele und Lösungen. Viele Wege führen nach Rom, aber nicht jeder ist kurz oder schnell. Und so habe ich am Anfang auch das eine oder andere Mal eine falsche Abbiegung genommen, die sich zwar nicht als Sackgasse entpuppte, aber teilweise einen gehörigen Umweg darstellte. Dieses Buch soll als Straßenkarte dienen, damit man sich auf den gut ausgebauten Straßen, die Wicket bietet, zurechtfindet. Wer sollte das Buch lesen? Wer Webanwendungen entwickelt oder entwickeln möchte und dabei auf Java als Programmiersprache setzt, wird nach der Lektüre dieses Buches sehr schnell Webanwendungen entwickeln können. Dabei werden alle Aspekte beleuchtet, die für das Erstellen einer Webanwendung wichtig und notwendig sind. Entwickler, die bereits Wicket einsetzen, profitieren von den praxisnahen Beispielen und bewährten Lösungen. Konventionen In diesem Buch gelten folgende Konventionen: Programmcode, Verzeichnisse und Dateinamen werden innerhalb des normalen Textes als code dargestellt. Quelltexte werden ohne besondere Überschrift als Codeblock dargestellt: public void javacode() Bei der Auszeichnung mit Überschrift wird ein Dateiname angegeben: 1

9 1 Einleitung Listing 1.1 Beispiel.java public void anderercode() Für HTML-Quelltexte, Property- und Markup-Dateien wird dieselbe Formatierung wie für Java-Quelltexte benutzt. Wenn durch die begrenzte Breite des Buches Text umbrochen werden muss und das an dieser Stelle nicht möglich ist, wird das unwillkürliche Zeilenende durch ein Leerzeichen und \ angegeben. Nur wenn das \ -Zeichen an letzter Stelle steht, ist ein unwillkürlicher Zeilenumbruch gemeint. Die nächste Zeile wird dann um zwei Leerzeichen gegenüber dem Zeilenanfang eingerückt: Text=Der Text ist zu lang, als dass er auf eine Zeile passen \ würde, und beginnt auf der neuen Zeile mit zwei Leerzeichen, \ die ebenfalls ignoriert werden müssen. Ein \-Zeichen mittendrin ist in Ordnung. Da sich viele Dinge immer wiederholen, wird im Laufe des Buches das eine oder andere gekürzt. Damit man erkennen kann, ob gekürzt wurde, erscheinen an der entsprechenden Stelle drei Punkte:... Wenn solche Kürzungen vorgenommen wurden, ist es ebenso wahrscheinlich, dass nur leichte Anpassungen an bereits bestehenden Quelltexten vorgenommen wurden. Diese werden der besseren Übersichtlichkeit halber entsprechend hervorgehoben:... das stand hier schon doch das ist neu... Kommandos, die in der Konsole eingeben werden müssen, sind von Natur aus nie mehrzeilig. Es gelten daher dieselben Regeln zum Umbruch wie bei Quelltexten. Allerdings beginnen Kommandos immer mit einem Dollarzeichen, es sei denn, sie kommen innerhalb des Textes vor. Dann ergibt sich die Bedeutung aus dem Text: $ kommando Java Alle Felder einer Klasse starten mit einem Unterstrich. Wenn eine Klasse als Bean benutzt wird, dann erfolgt der Zugriff auf das Feld durch eine passende set- und get-methode. Listing 1.2 BeispielBean.java public class BeispielBean { String _titel; } } public String gettitel() { return _titel; } public void settitel(string titel) { _titel=titel; 2

10 1.1 Warum Wicket? Im Folgenden wird diese ausführliche Schreibweise gekürzt. Dabei werden alle Felder mit den entsprechenden Typangaben aufgeführt und exemplarisch die Methodennamen für die ersten Felder angegeben. Listing 1.3 BeispielBean.java (gekürzt) public class BeispielBean { String _titel; } gettitel(),settitel(),... Importanweisungen werden nur aufgeführt, wenn die zu importierende Klasse nicht aus dem Beispielprojekt oder aus dem Wicket-Framework stammt und sich auch nicht in den Java-Standardbibliotheken befindet (z.b. import java.io.serializable;). Die Kürzung wird durch... gekennzeichnet. Markup Für die Darstellung von Komponenten nutzt Wicket einen Template-Mechanismus. Dabei kann einer Komponente eine HTML-Datei zugeordnet werden, in der alle nötigen Strukturen für die Darstellung enthalten sind. Diese Datei wird im folgenden Markup genannt. Version Das Buch bezieht sich auf die Wicket-Version 1.4, die mit dem Erscheinen dieses Buches in einer finalen Version verfügbar sein wird. Die Beispiele können begrenzt auch auf Wicket 1.3 übertragen werden. Wenn man nicht durch andere Abhängigkeiten gezwungen ist, Wicket noch in einer alten Version einzusetzen, sollte man spätestens jetzt den Schritt wagen und auf Wicket in der Version 1.4 migrieren. Online Da die Entwicklung von Wicket immer weiter geht, veröffentliche ich auf der Seite fortlaufend Erfahrungen und Tipps aus der praktischen Arbeit. Wenn Sie mit mir in Kontakt treten wollen, genügt eine an: michael@mosmann.de. 1.1 Warum Wicket? Für das Entwickeln von Webanwendungen stehen eine ganze Reihe von Frameworks und Technologien bereit. Die Auswahl fällt schwer, da man die meisten Anforderungen mit einer ganzen Reihe von Technologien umsetzen könnte. Wenn man dann die zu verwendende Programmiersprache auf Java eingrenzt, bleiben trotzdem noch einige Frameworks übrig, die um die Gunst der Programmierer wetteifern. 3

11 1 Einleitung Aus der umfangreichen Liste der Möglichkeiten habe ich Wicket ausgewählt. Dabei hat Wicket zunächst mit recht einfachen Mitteln mein Interesse geweckt: Es gibt eine sehr einfache und schnelle Möglichkeit, ein Testprojekt aufzusetzen. Dieses kann sofort gestartet werden und zeigt ein minimales Grundgerüst einer Wicket- Anwendung. Die bestehende Anwendung kann einfach verändert werden, was zu einem sehr schnellen Erfolgserlebnis führt. Die Lernkurve für die ersten Gehversuche ist sehr gering. Nachdem ich auf diese Weise sehr schnell einen ersten Eindruck gewinnen konnte, habe ich mich eingehender mit Wicket beschäftigt. Nach einer kurzen Einarbeitungsphase und einigen kleinen Beispielanwendungen war ich mir sicher, dass ich Wicket für meine zukünftigen Webprojekte einsetzen werde. Die Kriterien, die für Wicket sprechen, habe ich an eine Übersicht auf der Webseite des Wicket-Projektes 1 angelehnt, beschränke mich aber hier auf die für mich besonders wichtigen Aspekte Einfach, Konsistent, Offensichtlich Ich empfehle als Einstieg eine kleine Beispielanwendung, die man sich über die Quickstart -Funktion 2 generieren lassen kann. Anhand dieser Anwendung kann man einige der folgenden Punkte recht schnell nachvollziehen: Alles kann in Java realisiert werden. Das Grundprinzip erinnert an Swing und ist leicht zu verstehen. Es müssen keine Konfigurationsdateien erstellt werden. Wicket-Anwendungen können einfach für Suchmaschinen optimiert werden. Hervorragende Unterstützung bei der Fehlersuche durch ausführliche Informationen im Entwicklungsmodus. Wicket benötigt keine speziellen Vorbereitungen oder Vorarbeiten. Wicket ist einfach nur Java. Wicket-Anwendungen können über Unit-Tests getestet werden. Es ist für mich einer der größten Vorteile, dass alles in Java ausgedrückt werden muss. Es gibt nur eine Stelle, an der ein Fehler auftreten kann: im Code. Mit den sehr ausführlichen Fehlermeldungen kann der Fehler sehr schnell eingegrenzt und behoben werden Wiederverwendbarkeit Wicket ist zwar nicht das einzige Framework, bei dem man auch bei Komponenten auf Vererbung zurückgreifen kann, doch das einzige, bei dem das sehr einfach umzusetzen ist

12 1.1 Warum Wicket? Das ermöglicht sehr leistungsfähige und gleichzeitig effektive Komponenten. Da Komponenten ihre Funktionalität vollständig in sich kapseln, kann man sie innerhalb derselben Anwendung beliebig oft nutzen, sodass komplexe Anwendungen sehr schnell realisiert werden können. Wicket-Komponenten können auch anwendungsunabhängig entwickelt werden. Alle notwendigen Daten und Informationen können in eine Java-Bibliothek ausgelagert und dann in verschiedensten Projekten eingesetzt werden. Dazu muss die Bibliothek nur in das Projekt eingebunden werden. Auf diese Weise profitiert man sogar in allen nachfolgenden Wicket-Projekten von der eigenen Entwicklungsarbeit, da man oft fast alle allgemeinen Komponenten wiederverwenden kann. So entsteht auch hier eine Bibliothek von Lösungen, wie man sie aus anderen Bereichen der Anwendungsentwicklung kennt Sauber getrennt Wer Wicket zum ersten Mal testet und vorher schon Erfahrungen mit JSP, JSF oder ähnlichen Ansätzen gemacht hat, wundert sich, dass im Markup (HTML-Schnipsel, die zur Komponente gehören und für die Darstellung wichtig sind) keine Code-Bestandteile zu finden sind. Dieser Punkt irritiert so stark, dass er immer wieder z.b. in Mailinglisten thematisiert wird. Während der Arbeit mit Wicket offenbart dieses Konzept seine Vorteile: Im Markup befinden sich nur Referenzen auf Komponenten, aber kein Code oder spezielle Logik. Die Komplexität und der Funktionsreichtum der Anwendung werden nur durch Java als Programmiersprache und nicht durch eine in ihrer Ausdruckstärke eingeschränkten Auszeichnungssprache begrenzt. Programmcode entsteht auf diese Weise nur an einer Stelle und in einer Sprache. Die Markup-Dateien für die Komponenten können mit einfachen Textprogrammen oder mit HTML-Editoren bearbeitet werden. Da Wicket keine besondere Notation erfordert, gehen bei der Bearbeitung keine Informationen verloren, sodass die Gestaltung der Vorlagen z.b. durch einen Webdesigner angepasst werden kann. So wird die Arbeitsteilung zwischen Entwickler und Gestalter gut unterstützt. Im Zweifelsfall muss nur die versehentlich gelöschte Bezeichnung der Komponente wiederhergestellt werden. Auf alle positiven Skalierungseffekte im Entwicklungsprozess durch die Nutzung von Java als Programmiersprache und den darauf aufsetzenden unterstützenden Werkzeugen kann bei der Entwicklung von Anwendungen mit Wicket zurückgegriffen werden. Die Komponentenarchitektur unterstützt diesen Aspekt zusätzlich Sicher Je nach verwendetem Framework sind Webanwendungen mehr oder weniger anfällig für Code-Injection 3 -, XSS 4 - und andere Attacken

13 Register A Ajax 102 AjaxRequestTarget 102, 140 Event 103 setoutputmarkupid() 103 setoutputmarkupplaceholdertag() 106 Anwendungslogik 8, 10 Anwendungsschicht 8, 41 Application 84 siehe auch WebApplication Applikationsschicht 24 B Behavior 144 Attribute anpassen 145 oncomponenttag() 144 Border 120 C Component 51, 81 siehe auch Komponente ComponentBorder 125 D Datenbank Konfiguration 20, 30, 37 Produktivdatenbank 20, 30 Testdatenbank 22 Datenhaltung 8 siehe auch Persistenz Dependency Injection 8 siehe auch Spring Framework E Eclipse Installation 7 Projektdateien 27 F Feedback 85, 170, 214 ComponentFeedbackMessageFilter 215 ContainerFeedbackMessageFilter 214 CustomFeedbackPanel 251 FeedbackMessage 85 FeedbackPanel 170 FormComponentCssFeedbackBorder 218 FormComponentFeedbackBorder 216 FormComponentFeedbackIndicator 217 MessageFilter 214 Formular 169 Ajax 205 AjaxButton 175 AjaxComponentUpdatingBehavior 207 AjaxFallbackButton 174 AjaxFormSubmitBehavior 205 AjaxFormValidatingBehavior 207 AjaxSubmitLink 175 AutoCompleteTextField 210 Button 173 CheckBox 182 CheckBoxMultipleChoice 183 CheckGroup 183 CheckGroupSelector

14 Register ChoiceRenderer 190 DropDownChoice 188 FileUpload 192 FormComponentLabel 182 GET 175 Label 181 ListChoice 189 ListMultipleChoice 190, 191 MultiFileUpload 194 OnChangeBehavior 209 onsubmit() 172 Palette 191 POST 175 RadioButton 185 RadioChoice 185 RadioGroup 185 Select 186 SubmitLink 173 TextField 176 UploadProgressBar 193 UploadWebRequest 193 Validatoren 195 siehe auch Validator Fragment 119 G Google Analytics 271 H Hibernate 9 HQL 10 Schemagenerierung 32 I InjectorHolder siehe auch Spring Framework SpringBean 237 Installation 7 J Java, Installation 7 JavaBean 2, 181 Jetty 24 Maven-Plugin 26 starten 46 K Komponente 51, 53 AjaxEditableLabel 212 AjaxFallbackConfirmLink 254 ButtonLink 250 callonbeforerenderifnotvisible() 83, 101, 124 detach() 83 getpage() 84 getparent() 81 getpath() 84 ID 81 isvisible() 99 IVisitor 82 Komponentenbaum 81 Modell 84 onbeforerender() 52, 83, 101, 124 ondetach() 52, 83 Sichtbarkeit 99 Vererbung 85 siehe auch Vererbung Wizard 256 Konventionen 1 Konverter 55, 129, 284 IConverter-Interface 56 IConverterLocator 56 L Label 127 MultiLineLabel 127 Link 137 AbstractLink 137 Ajax 138 AjaxFallbackLink 139 AjaxLink 140 AjaxSubmitLink 144 BookmarkablePageLink 137, 260 ExternalLink 141 IndicatingAjaxFallbackLink 139 IndicatingAjaxLink 140 onclick() 138 Popup 141 ResourceLink 143 SubmitLink 144 Tricks

15 Register Liste 149 ColumnListView 154 DataGridView 159 DataProvider 156, 164 DataTable 161 DataView 156 DefaultDataTable 162 GridView 158 ListView 152, 184 PropertyListView 153 RefreshingView 150 RepeatingView 149 Locale 94 M Markup 3, 5, 53 getvariation() 94 Variationen 94 Maven Abhängigkeiten 15 artifactid 15 groupid 15 Installation 7 POM 11, 17 Projektverwaltung 11 version 15, 16 Modell 53, 55 CompoundPropertyModel 74 DaoModel 67 detach() 55, 61 IModel-Interface 55 Kaskadierung 62, 65 LoadableDetachableModel 62 Model.of() 60 modelchanged() 58 modelchanging() 58 PropertyModel 72 ResourceModel 76 Serialisierung 61 StringResourceModel 78 verändern 58 Model-View-Controller 10 Modus Deployment 47 Development 47 MVC 55 siehe auch Model-View-Controller P Page 50, 84 als XML 130 BookmarkablePage 258 CSS 116 JavaScript 116 PageParameter 110 RedirectPage 112 URL 115 WebPage 109 PageMap 50 PageStore 51, 61 Panel 117 ParentPom 16, 26 Persistenz 9, 22, 35 AbstractDao 34, 36 AbstractDaoList 163 DaoInterface 33 DoInterface 33 Persistenz-Tests 13, 38 Präsentation 10 Präsentationsschicht 8, 41 Property Datei 98 XML-Format 99 Zeichenkodierung 99 Q Quickstart 4, 12 R Request Behandlung 51 RequestCycle 51 Resource 98, 274, 285 BufferedDynamicImageResource 275 Download 277 RenderedDynamicImageResource 275 ResourceLink

16 Register Shared Resources 278 URL 282 Verzeichnis 95 WebResource 276 ResourceReference 116, 134 RSS-Feed 280 S Schema-Update 21, 31, 40 Security 225 siehe auch Sicherheit SEO 264 siehe auch Suchmaschinenoptimierung Session 50, 84 DisableJSessionIDinUrlFilter 268 eigene Session-Klasse 225 get() 84 RobotJSessionIDUrlFilter 269 setreuseitems() siehe auch Liste ListView 184 Sicherheit 5 Anmeldeseite 229 geschützte Komponente 231 geschützte Seite 229 IAuthorizationStrategy 231 ProtectedPage 229 SimplePageAuthorizationStrategy 226 Spring Framework Konfiguration 46 SpringBean 235 Spring 26, 29 siehe auch Spring Framework Spring-Framework 10 Konfiguration 29 Style 94 Subversion 7 Installation 8 Suchmaschinenoptimierung 258 BeanBookmarkablePageLink 266 T Tomcat 24 U Unit-Tests 12, 288 UserDao siehe auch Persistenz AbstractDao 36 V Validator AbstractValidator 200 AddressValidator 197 EqualPasswordInputValidator 202 FormValidator 201 getdependentformcomponents() 204 MaximumValidator 197 MinimumValidator 197 Palindrom-Validator 199 RangeValidator 197 StringValidator 196 UrlValidator 199 Validatable 200 validate() 204 Variation 94 VCS 8 siehe auch Versionskontrolle Vererbung einfach 85 für Fortgeschrittene 91 Markup 87 mit eigenem Markup 87 ohne eigenes Markup 86 Versionskontrolle 7 W war 24 siehe auch Webarchiv WebApp 24, 42 WebApplication 50 Webarchiv 26 WebMarkupContainer 126 wicket:border 124 wicket:child 86, 88 wicket:container 89 wicket:enclosure 100 wicket:extend 88 wicket:head 86 wicket:message 131 wicket:panel