FreeMarker

FreeMarker

Basisdaten

Entwickler Jonathan Revusky, Attila Szegedi, Dániel Dékány e.a.
Erscheinungsjahr 2002
Aktuelle Version 2.3.32
(14.01.2023)
Betriebssystem plattformunabhängig
Programmier­sprache Java
Kategorie Template-Engine
Lizenz Apache-Lizenz
freemarker.apache.org

FreeMarker ist eine Template-Engine für die Java-Plattform, die Platzhalter in Textdateien durch dynamische Inhalte ersetzt. Die häufigste Anwendung ist das Generieren von HTML in Webanwendungen, es wird aber u. a. auch zum Erzeugen von E-Mails, Quelltext und SQL-Queries verwendet. FreeMarker ist freie Software.

FTL FreeMarker Template Language

[Bearbeiten | Quelltext bearbeiten]

FreeMarker verwendet eine eigene, einfache Programmiersprache (DSL), die für die Verwendung in HTML-Templates optimiert ist.

Der Inhalt von Variablen wird in der Form ${Variable} ausgegeben, Anweisungen als <#Anweisung …/> notiert. Häufig benutzte Anweisungsblöcke lassen sich als Makro definieren und dann in der Form <@Makro …/> aufrufen (Anweisungen und Makros können Parameter haben, worauf die „…“ hinweisen sollen).

FTL bietet einen vergleichsweise hohen Funktionsumfang, es lassen sich z. B. Zahlen und Datumswerte internationalisiert ausgeben, Zeichenersetzungen mit Regulären Ausdrücken durchführen, Texte für die Verwendung in JavaScript mit Maskierungszeichen versehen, Listen (auch) nach Subvariablen der Elemente sortieren oder DOM-Nodes in XML-Dokumenten adressieren.

Beispiel

[Bearbeiten | Quelltext bearbeiten]

Angenommen, es stehen die Variablen name (eine Zeichenkette) und items (eine Liste von Objekten mit den Feldern quantity und description) zur Verfügung.

Das Template

erzeugt dann folgenden Output: 

<p>Einkaufskorb für Max Mustermann:</p>
<ul>
  <li>1 Stk. <b>Bleistift</b>
  <li>2 Stk. <b>Radiergummi</b>
</ul>

Anwendungen

[Bearbeiten | Quelltext bearbeiten]

FreeMarker wird in verschiedenen Bereichen der Softwaretechnik eingesetzt und wird von vielen Programmen und Frameworks verwendet resp. unterstützt.

  • in Webanwendungen kommt FreeMarker als Alternative zu JSP zum Einsatz. Die weit verbreiteten Frameworks Struts[1] und Spring[2] bieten hierfür FreeMarker an (als weitere Alternative steht Apache Velocity zur Verfügung). Da in FreeMarker die Verwendung von JSP-Taglibs möglich ist, muss beim Umstieg von JSP auf FreeMarker nicht auf die benötigten Taglibs (wie etwa die Struts-Taglib) verzichtet werden[3].
  • Struts 2 verwendet FreeMarker intern für das Rendering von JSP-, Velocity- und FreeMarker-Tags[4], nachdem das Vorgänger-Projekt WebWork einen Wechsel von Velocity zu FreeMarker vollzogen hatte.
  • Content-Management-Systeme wie Magnolia[5] verwenden FreeMarker als Template Engine.
  • in Codegeneratoren wird mit FreeMarker Quelltext (Java, SQL, RTF, PostScript) dynamisch erzeugt[6].
  • die Tools des Persistenz-Frameworks Hibernate nutzen FreeMarker beim Generieren von Datenbank-Schemas, SQL- und Java-Code. 2006 fand ein Wechsel von Velocity zu FreeMarker statt (u. a. wegen der besseren Fehlerbehandlung)[7].
  • NetBeans IDE verwendet Freemarker intern, um in „Neue Datei…“-Assistenten die Vorlage-Dokumente mit dynamischen Inhalten zu befüllen[8].

In IDEs wie Eclipse, NetBeans IDE oder IntelliJ IDEA[9] wird die Bearbeitung von FreeMarker Templates durch Syntax-Check, Code-Vervollständigung, Popup-Hilfe u. ä. unterstützt.

Geschichte

[Bearbeiten | Quelltext bearbeiten]

FreeMarker 1 wurde von Benjamin Geer und Mike Bayer entwickelt und im Januar 1999 unter der LGPL-Lizenz veröffentlicht (nach wie vor als „FreeMarker classic“ erhältlich).

2002 wurde der Kern von Jonathan Revusky e.a. neu geschrieben und als FreeMarker 2 unter der (im Vergleich zur LGPL) liberaleren BSD-Lizenz veröffentlicht.[10]

Literatur

[Bearbeiten | Quelltext bearbeiten]

Es liegt derzeit keine Monographie zu FreeMarker vor, die Konfiguration und Verwendung wird allerdings in vielen Handbüchern der Programme und Frameworks beschrieben, die FreeMarker verwenden oder unterstützen.

  • Donald Brown, Chad Michael Davis, Scott Stanlick Struts 2 in Action. Manning (2008) ISBN 978-1933988078, S. 223ff.: Velocity und FreeMarker als JSP-Alternativen, S. 336 ff.: Erzeugen eigener Themes durch Überschreiben der internen FreeMarker-Templates
  • Seth Ladd, Bram Smeets Building Spring 2 Enterprise Applications, Apress (2007) ISBN 978-1590599181, S. 271 f.: FreeMarker als View-Technologie für Spring (neben JSP, Velocity und XSLT)
  • Jeff Linwood, Dave Minter: Beginning Hibernate. Apress (2010) ISBN 978-1430228509, S 323f.: Konfiguration in den Hibernate Tools

Artikel in Fachzeitschriften:

[Bearbeiten | Quelltext bearbeiten]

Einzelnachweise

[Bearbeiten | Quelltext bearbeiten]
  1. ↑ Musachy Barroso e.a.: Using Freemarker Templates. In: Apache Struts 2 Documentation. Archiviert vom Original (nicht mehr online verfügbar) am 6. August 2010; abgerufen am 24. Juli 2010 (englisch).  Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.@1@2Vorlage:Webachiv/IABot/struts.apache.org
  2. ↑ Rod Johnson e.a.: Chapter 14. Integrating view technologies. In: The Spring Framework - Reference Documentation. Abgerufen am 24. Juli 2010 (englisch).
  3. ↑ Dániel Dékány e.a.: Using FreeMarker with servlets. In: FreeMarker Manual. Abgerufen am 24. Juli 2010 (englisch).
  4. ↑ Patrick Lightbody e.a.: Template Loading. In: Apache Struts 2 Documentation. Archiviert vom Original (nicht mehr online verfügbar) am 1. Juli 2010; abgerufen am 24. Juli 2010 (englisch).  Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.@1@2Vorlage:Webachiv/IABot/struts.apache.org
  5. ↑ Templating with FreeMarker - a primer. In: Magnolia Documentation. Ehemals im Original (nicht mehr online verfügbar); abgerufen am 24. Juli 2010 (englisch).@1@2Vorlage:Toter Link/documentation.magnolia-cms.com (Seite nicht mehr abrufbar. Suche in Webarchiven)  Info: Der Link wurde automatisch als defekt markiert. Bitte prüfe den Link gemäß Anleitung und entferne dann diesen Hinweis.
  6. ↑ Introduction. In: apt-jelly Homepage. Abgerufen am 24. Juli 2010 (englisch).
  7. ↑ Max Andersen: A story about FreeMarker and Velocity. In: In Relation To... 3. Februar 2006, abgerufen am 24. Juli 2010 (englisch, Blog eines Hibernate-Entwicklers).
  8. ↑ FaqFreeMarker. In: NetBeans Wiki. Abgerufen am 24. Juli 2010 (englisch).
  9. ↑ FreeMarker/Velocity. In: IntelliJ IDEA Homepage. Abgerufen am 24. Juli 2010 (englisch).
  10. ↑ Dániel Dékány e.a.: Who We Are. In: FreeMarker Homepage. Abgerufen am 24. Juli 2010 (englisch).