Apache Velocity

Apache Velocity

Basisdaten

EntwicklerApache Software Foundation
Erscheinungsjahr21. November 2006[1]
Aktuelle Version2.4[2]
(10. Februar 2024)
Betriebssystemplattformunabhängig
Programmier­spracheJava[1]
KategorieTemplate Engine
LizenzApache-Lizenz, Version 2.0[3]
velocity.apache.org

Apache Velocity ist eine Software, die Platzhalter in Textdateien durch aktuelle Inhalte ersetzt. Damit können nach dem Prinzip des Serienbriefs beliebig viele Textdateien – beispielsweise Webseiten oder E-Mails – mit unterschiedlichen Inhalten, aber gleicher Struktur, aus einer einzigen Vorlage erzeugt werden.

Apache Velocity wurde in der Programmiersprache Java programmiert. Der Quelltext steht unter der Apache Software License und ist somit frei.

Funktionsweise

Die von Apache Velocity verarbeiteten Textdateien werden als Template bezeichnet, englisch für „Schablone“ oder „Vorlage“. Daher wird dieser Typ von Software auch Template Engine („Schablonenmaschine“) genannt.

Apache Velocity interpretiert die Platzhalter in den Templates als Referenzen auf Java-Objekte, also ausführbare Software, die in der Programmiersprache Java geschrieben wurde. Velocity erzeugt aus dem Template ausführbaren Quelltext, der einerseits die statischen Textbestandteile des Templates ausgibt und andererseits an den richtigen Stellen die referenzierten Java-Objekte aufruft. Die Java-Objekte müssen Zeichenketten zurückgeben, die in den Text eingefügt werden.

Apache Velocity kann als eigenständiges Anwendungsprogramm eingesetzt werden oder als Klassenbibliothek in andere Anwendungsprogramme (z. B. Webanwendungen) integriert werden und für diese Hilfsdienste verrichten.

Anwendungsbereiche

Apache Velocity wird in unterschiedlichen Anwendungsbereichen der Softwaretechnik eingesetzt und ist Bestandteil vieler Softwareprodukte:

  • Codegeneratoren: Velocity kann auch zum Erzeugen von Quelltext in beliebigen formalen Sprachen wie Java, SQL oder PostScript eingesetzt werden.
  • E-Mail-Erzeugung: Viele Anwendungen erzeugen automatische E-Mails, beispielsweise für die Anmeldung an Websites oder Passwort-Erinnerungen mit Hilfe von Velocity. Dabei kann der erzeugte Text direkt in einer Textdatei gespeichert werden, ohne dass Java-Code erzeugt werden muss.
  • Text-Reports: Velocity wird verwendet, um vordefinierte textuelle Reports zu befüllen. Dies ist weit einfacher als mit den auf grafische Reports spezialisierten Reporting Engines wie JasperReports.
  • Webanwendungen: Webentwickler gestalten HTML-Seiten mit Platzhaltern für dynamisch erzeugte Informationen. Dazu wird eine solche HTML-Seite beispielsweise von einer Velocity-Komponente namens VelocityViewServlet verarbeitet.[4] Dieser Ansatz ist als Alternative zu JavaServer Pages (JSP) oder PHP gedacht.
  • XML-Umwandlung: Velocity stellt auch einen Ant-Task namens Anakia bereit, der eine XML-Datei liest und sie für eine Velocity-Schablone verarbeitbar macht. Eine typische Anwendung davon ist es, im XDoc-Format vorliegende Dokumentation zu HTML umzuwandeln.

Velocity ist als Template-Engine Bestandteil vieler Anwendungsprogramme wie der integrierten Java-Entwicklungsumgebung IntelliJ IDEA oder des UML-Werkzeuges Poseidon for UML und Frameworks wie Spring, sowie von Websites wie der Open-Source-Entwicklungsgemeinschaft Tigris.org.[5]

Velocity Template Language

Apache Velocity definiert eine eigene Beschreibungssprache für Schablonen, die Velocity Template Language (VTL). Dabei leiten Doppelkreuze („#“) die zu füllenden Platzhalter ein, doppelte Doppelkreuze („##“) beginnen Kommentare und Dollarzeichen („$“) dienen als Markierung von Referenzen.

Die folgende Beispielvorlage definiert neben Kommentaren eine Referenz namens „foo“, der eine einfache Zeichenkette mit dem Inhalt „Velocity“ zugewiesen wird. Anschließend wird die Referenz „foo“ im Text durch die Zeichenkette ersetzt.

## Velocity Hello World
<html>
    <body>
       #set( $foo = "Velocity" )
       ## followed by
       Hallo $foo Welt!
    </body>
</html>

Daraus erzeugt Apache Velocity diese HTML-Struktur:

<html>
    <body>
     Hallo Velocity Welt!
    </body>
</html>

Geschichte

Die erste Beta-Version von Velocity wurde am 26. März 2001 veröffentlicht.[6] Am 26. Oktober 2006 wurde Velocity zum Apache Top Level Project ernannt.[7]

Literatur

  • Gradecki, Cole: Mastering Apache Velocity. John Wiley & Sons Inc (Juli 2003) ISBN 978-0-471-45794-7

Einzelnachweise

  1. ↑ a b projects.apache.org. (abgerufen am 8. April 2020).
  2. ↑ Release 2.4. 10. Februar 2024 (abgerufen am 18. Februar 2024).
  3. ↑ github.com.
  4. ↑ Velocity – VelocityView. In: The Apache Velocity Project. Archiviert vom Original (nicht mehr online verfügbar) am 26. Januar 2009; abgerufen am 26. Januar 2008 (englisch).
  5. ↑ Powered by Velocity. In: VelocityWiki. 4. Dezember 2008, abgerufen am 26. Januar 2008 (englisch).
  6. ↑ 20 March 2001 – Velocity 1.0 Beta 1 Release. In: The Jakarta Site – New and Status – 2001. 20. März 2001, abgerufen am 28. Januar 2009 (englisch).
  7. ↑ Velocity Approved as Top Level Project. In: Apache Velocity Site – Project news. 26. Oktober 2006, abgerufen am 28. Januar 2009 (englisch).

Auf dieser Seite verwendete Medien

Apache Velocity logo.svg
Autor/Urheber: ™/®The Apache Software Foundation, Lizenz: Apache License 2.0
Logo von: Apache Velocity – Java-Bibliothek