Spring Surf Wiederkehr Patrick Consultant

Transkript

1 Spring Surf Wiederkehr Patrick Consultant

2 Inhaltsverzeichnis 1. Spring Surf von Alfresco Was ist Spring Surf und was kann es Was ist Spring Surf nicht Einführung Alfresco Funktionalität Aus technischer Sicht Framework-Komponenten Webscripts Spring Surf Seiten-Templating Spring Tooling Framework-Struktur Webscript-Beispiel Kompatibilität Web-Editor Anmerkungen info@trivadis.com. Info-Tel Datum Seite 2 / 10

3 1. Spring Surf von Alfresco Spring Surf wurde von Alfresco Software AG an Spring Source beigetragen. Alfresco hat es aus seiner Enterprise Content Management Lösung herausgenommen, damit es als eigenständiger Teil funktionsfähig ist. Es ist nun in der Inkubationsphase und hat den ersten Release Candidate bereitgestellt. Spring Surf ist im weitesten Sinne ein Container für die sogenannten Webscripts, einem Konstrukt aus Alfresco / Spring Surf. 1.1 Was ist Spring Surf und was kann es Spring Surf ist ein Kompositionswerkzeug für Web Applikationen, das in existierende Spring MVC Applikationen eingebunden werden kann. Es besteht aus verschiedenen Komponenten und verfügt über eine gute Anbindung an CMIS Data Stores via den von Alfresco bereitgestellten Data Webscripts. Die Kernkomponenten sind: Web Framework View Resolver Seiten Templating Kompatibel mit Spring MVC, Spring Web Flow Freemarker oder JSP View Web Scripts Serverside Javascript (REST) bzw. Groovy, PHP per Plugin Sciptable Controller Remote API Entwicklung Web Editor Wysiwyg Content Editor CMIS Anbindung Abbildung 1: Spring Surf Komponenten Dank der Integration in Spring ist es sowohl in der Spring Tool Suite Entwicklungsumgebung integriert als auch in Spring Roo. Da das Webframework hauptsächlich von Alfresco eingesetzt wird, sind dort auch die meisten Erweiterungen zu finden. 1.2 Was ist Spring Surf nicht Spring Surf ist kein traditionelles Webframework, wie bspw. Java Server Faces. Es handelt sich dabei um eine Webtechnologie, die für inhaltsorientierte Web Applikationen einsetzbar ist. Spring Surf sollte es der Alfresco Community erlauben, einfach und schnell Erweiterungen am User Interface und an der Applikation zu erstellen. D.h. es ist hauptsächlich für inhaltsorientierte Webapplikationen verwendbar. info@trivadis.com. Info-Tel Datum Seite 3 / 10

4 2. Einführung Alfresco Da Spring Surf stark mit Alfresco zusammenhängt, kann eine kleine Einführung in Alfresco und seine Komponenten nicht schaden. Alfresco ist ein Enterprise Content Management System, das hauptsächlich in Java entwickelt wurde. Es ist in zwei Lizenzmodellen verfügbar: In der Community Edition, die einem Opensource-Komitee unterliegt sowie einer Enterprise Edition, die von Alfresco lizenziert werden kann. Auf der Enterprise Edition gibt es von Alfresco offiziellen Support mit Maintenance Releases, Patches und technischem Support. Die Community Edition ist zum evaluieren gedacht und Alfresco empfiehlt keine produktiven Umgebungen damit zu betreiben. 2.1 Funktionalität Abbildung 2: Alfresco Funktionalitäten (aus Alfresco Presentation) Alfresco bietet eine günstige und einfache Lösung für das Enterprise Content Management. Das beinhaltet Document Management, Web Content Management, Collaboration, Records Management und Image Management. Dank der offen gehaltenen Strukturen, Source Code und Schnittstellen ist Alfresco in hohem Masse anpassungsfähig und erweiterbar. Alfresco folgt dem Leitgedanken, dass das Content Management beim Standard-Workflow unterstützend wirken soll. Dies ist auch der Grund, warum sich Alfresco in Microsoft Office und den Windows Explorer integrieren lässt. 2.2 Aus technischer Sicht Alfresco besteht aus verschiedenen Webanwendungen, die auf eine Datenbank bzw. auf das Filesystem zugreifen, um die dort gespeicherten Dokumente zu verwalten. Alfresco bietet verschiedene Service-Schnittstellen, das sind einerseits die generische CMIS-Schnittstelle, bspw. für Dokument Queries, andererseits die Alfresco-eigenen Services, um Content zu taggen, zu kommentieren und vieles mehr. Alfresco läuft auf einem Tomcat Server, kann aber auch auf Application Servern, wie JBoss und Co. laufen. JBoss wird von Alfresco besonders im Caching und Clustering unterstützt, um optimale Performance zu erreichen. Alfresco kann mit verschiedenen Datenbanken betrieben werden. Unterstützt sind MySQL, PostgreSQL, Oracle, DB2 und MS SQL Server. Die eingesetzten Technologien sind hauptsächlich Spring, ibatis (bis 3.4 noch Hibernate) und Lucene. Info-Tel Datum Seite 4 / 10

5 3. Framework-Komponenten Spring Surf besteht aus unterschiedlichen Komponenten, die auf der Architektur von Spring mit Spring MVC beruhen. Es gibt keine J2EE-Abhängigkeiten, die den Einsatz eines Application Servers erfordern. Spring Surf wurde aus Alfresco herausgelöst, um damit einen Webscript Container ausserhalb von Alfresco zu erhalten. Somit ist Ausführen von Webscripts auch die Hauptfunktionalität von Spring Surf. Zusätzlich stellt Spring Surf unterstützende Strukturen zum Bau von Webapplikationen und Webseiten zur Verfügung. 3.1 Webscripts Ein Webscript ist ein Service, der an ein URI gebunden ist und der auf die verschiedenen HTTP- Methoden, wie GET, POST, PUT und DELETE antwortet. Während der unterliegende Code grundsätzlich derselbe bleibt, gibt es zwei verschiedene Typen von Scripts: Data Webscripts: Data Webscripts liefern grundsätzlich Daten, wie JSON oder XML zurück. Alfresco selbst hat ein ganzes Interface mit Data Webscripts zur Verfügung gestellt, womit auf den Inhalt des CMS zugegriffen werden kann. Dieses Interface orientiert sich am CMIS-Standard. Presentation Webscripts: Presentation Webscripts definieren bspw. ein Dashlet, ein Portlet oder eine UI Component einer Spring Surf Applikation, eine Web Site oder eine spezifische Applikation. Sie stellen typischerweise HTML dar und interagieren mit Data Web Scripts. Der Ablauf eines Webscript-Aufrufs sieht folgendermassen aus: Abbildung 3: Konversationsablauf mit Spring Surf Komponenten (aus Alfresco Wiki) Info-Tel Datum Seite 5 / 10

6 1. Aufruf einer URI 2. Die Runtime findet das Webscript zur URI. Wenn auf dem URI ein Webscript definiert ist, wird zuerst authentifiziert und erst dann wird der Controller ausgeführt. 3. Aus dem Controller können weitere Services aufgerufen werden. Wenn die Spring Surf Applikation in einem Alfresco Server läuft, können alle Alfresco Webscripts aufgerufen werden. Diese ermöglichen das Suchen von Dokumenten, Transformationen und vieles mehr. 4. Das Ergebnis des Controllers ist ein Model das von der View bspw. mit FreeMarker (könnte aber auch JSP sein) in ein Response-Format, wie HTML, ATOM, XML, RSS, JSON, CSV oder jede Kombination aus diesen transformiert wird. 5. Die Runtime schickt das gerenderte Resultat mit dem im Aufruf geforderten Format zurück. 6. Der Webscript Client erhält die Antwort im verlangten Format. 3.2 Spring Surf Seiten-Templating Man kann sich den Aufbau einer solchen Applikation als grossen Baukasten mit Klötzchen und Schablonen vorstellen, den man sich über URLs zusammenstellen kann. Abbildung 4: Surf Web Application Sample Die Pages stehen untereinander in Beziehungen, die den Navigationsaufbau bestimmen. Das Template gibt hier die Darstellung der gesamten Page und evtl. bereits deren Bestückungen Info-Tel Datum Seite 6 / 10

7 vor. Ein anderes Template könnte beispielsweise keinen Side-Teil haben, dafür aber eine zusätzliche Navigation auf der linken Seite. Spring Surf bietet Services und Javascript-Strukturen an, womit auf die konfigurierten Page- Metadaten zugegriffen werden kann. 3.3 Spring Tooling Spring bietet zur Entwicklung von Spring Surf Applikationen reichlich Unterstützung in Form der beliebten Spring Tool Suite mit einem Projekt-Template für Spring Surf und Integration in die Spring Roo-Console. Damit lassen sich bestehende und neue Spring Surf Applikationen erweitern oder verändern. Die Spring Roo-Console erweist sich beim Bearbeiten und Erstellen von Spring Surf- Applikationen als sehr hilfreich, da man damit nicht nur neue Seiten erstellen kann, sondern auch Informationen über bereits bestehende Strukturen erfahren kann, ohne sich durch XML Konfigurationsfiles wühlen zu müssen. Abbildung 5: Spring Roo-Console Info-Tel Datum Seite 7 / 10

8 3.4 Framework-Struktur Spring Surf definiert eine Struktur, die sich durch die ganze Applikation hindurch zieht: Pages: Sie sind das zentrale Element einer Spring Surf-Applikation. Sie beinhalten den Content und bauen auf einem sogenannten Template auf. Die Page definiert die Inhalte (Components) eines Templates. Diese Pages stehen untereinander in Beziehungen, wodurch eine Page-Struktur gebildet werden kann (z.b. Child Pages). Eine Page ist grundsätzlich eine XML-Datei. Darin wird das benötigte Template, die Komponenten sowie Authentifizierung etc. konfiguriert. Templates: Die Templates definieren, wie eine einzelne Page aussehen soll. D.h. sie bilden das Grundgerüst jeder Page. Ein Template besteht aus einer View und einem Konfigurations-XML, das bereits gewisse Components verwenden kann. Components: Eine Component bezeichnet eine Einheit, welche in anderen Frameworks als Widget, Dashlet oder Portlet bezeichnet wird. Ein Component kann unterschiedlich implementiert werden. Möglich sind Webscript, aber auch JSP. Es sind sogar Java Beans als Renderer möglich. Chrome: Chrome beschreibt einen Rahmen um eine Komponente oder eine Region. Der Rahmen kann Styling-Elemente, wie Schatten enthalten oder Drag and Drop- Support für eine Page zur Verfügung stellen. Das Chrome kann als JSP oder Webscript definiert werden. Die Projektstruktur in einem Spring Surf Projekt sieht das folgendermassen aus: Die gesamte Konfiguration ist im WEB-INF-Folder eines Web Archives untergebracht. Hier sind die verschiedenen Elemente ersichtlich, wie Chrome, Pages, Templates und die Webscripts, die als Components verwendet werden. Zusätzlich sind noch die Spring-Konfigurationen und das web.xml mit den Servletkonfigurationen zu sehen. In der surf.xml werden das Login und Surf-spezifische Konfigurationen festgehalten. Abbildung 6: Spring Surf Source Code-Struktur Info-Tel Datum Seite 8 / 10

9 3.5 Webscript-Beispiel Ein einzelnes Webscript sieht folgendermassen aus: Hier ist zu sehen, dass die einzelnen Files eine spezielle Naming Convention einhalten: Alle Files beginnen mit der Script ID: myscript. Abbildung 7: Webscript-Beispiel Danach ist die HTTP-Methode definiert. Hier wird lediglich GET verwendet. Es sind jedoch auch POST und alle anderen HTTP-Methoden denkbar. Das Script myscript.get.js repräsentiert den Controller, der das Model für die View erzeugt. Die Datei myscript.get.desc.xml enthält das URL-Mapping und beinhaltet eine Beschreibung mit Kurztitel. Die restlichen Dateien, wie mysript.get.json.ftl enthalten View Scripts. Im Beispiel sind dies alles Freemarker-Templates, die das Resultat in einem spezifischen Format liefern. Dieses Webscript kann bspw. über die URL aufgerufen werden, worauf die Antwort im JSON-Format geliefert wird. Es gibt neben dem Weg über die Extension weitere Möglichkeiten, dem Container beizubringen, welches Datenformat gewünscht ist. 3.6 Kompatibilität Da die einzelnen Bestückungen auf den Pages lediglich über URLs erfolgen, kann auch ein Teil der Seite mit einer anderen Web Technologie implementiert werden bspw. könnte so eine JSF- Applikation in eine Applikation, die mit Spring Surf geschrieben ist, eingebunden werden. Grundsätzlich sind verschiedenste Kombinationen möglich. 3.7 Web-Editor Der Spring Web Editor ist eine Komponente, die auf der Yahoo UI Javascript-Library aufsetzt. Der Web Editor ist ebenfalls aus dem Alfresco CMS herausgelöst. Er hiess früher Alfresco Web Studio und wurde nun zu einem Teil in Spring Surf integriert und zu einem anderen Teil mit einem Alfresco Plugin erweitert. Der Spring-Teil heisst nun Web Editor Framework (WEF) und Alfresco hat ein Plugin dafür geschrieben, welches als Alfresco Web Editor (AWE) bezeichnet wird. Der Alfresco Web Editor ist fähig, Dokumente auf dem Alfresco Repository direkt zu editieren. Er liefert eine JSP Tag Library und eine Freemarker-Integration, mit der man den manipulierbaren Inhalt einer JSP-Seite bzw. eines Freemarker-Templates markieren kann und womit sich der AWE initialisieren lässt. Das editierbare File muss dafür in Alfresco abgelegt sein. Es gibt eine gute Web Quick Start -Applikation und mehrere Tutorials auf dem Alfresco Wiki, die verschiedene Alfresco WCM-Möglichkeiten aufzeigen. Es führen viele Wege nach Rom! Info-Tel Datum Seite 9 / 10

10 4. Anmerkungen Es ist anzumerken, dass sich Spring Surf und Alfresco zum Zeitpunkt als dieser Artikel geschrieben wurde in einer Phase starken Aufschwungs befand und deshalb starken Veränderungen unterlag. Spring Surf befand sich in Version RC2 und Alfresco in Version 3.4. Für immer aktuelle Informationen sei auf das Alfresco Wiki verwiesen: bzw. Und hoffentlich bald besser dokumentierend, die Spring Surf Homepage: bzw. Info-Tel Datum Seite 10 / 10