Template-Engine
Eine Template-Engine (von englisch für Vorlage bzw. Schablone und Maschine) ist eine Software, die eine Vorlagen-Datei (engl. Template) verarbeitet und bestimmte Platzhalter darin ähnlich wie bei einem Formular durch jeweils aktuelle Inhalte ersetzt. Die Bezeichnungen Template-Klasse (dt. ugs. „Vorlagenklasse“, aber sachlich korrekt: „Klassenvorlage“) und Template-System werden oft als Synonym für eine Template-Engine verwendet.
Klassen-Templates in der C++-Programmierung sind dagegen nicht mit Template-Engines vergleichbar, weil sie eine vom Datentyp unabhängige Programmierung ermöglichen und ganze Klassen generieren können. In den Templates einer Template-Engine sollte kein Programm-Code enthalten sein. Kontrollstrukturen (wie IF) sind allerdings oft in Templates möglich und verbreitet. Typische Dateitypen, die verarbeitet werden, sind HTML, Text (ASCII oder Unicode), XML oder TeX.
Konzept
Das Konzept ähnelt den Seriendruckfeldern bei einer Textverarbeitung: In einem Dokument werden Seriendruckfelder (Platzhalter) eingefügt, etwa Name – Straße – Ort. Bei Template-Engines werden diese Seriendruckfelder Template-Variablen genannt. Wenn aus dem Dokument dann mehrere Serienbriefe erzeugt werden, steht anstatt der Template-Variablen name ein realer Name wie „Erika Mustermann“ im fertigen Serienbrief.
Das Dokument braucht nur einmal geschrieben und formatiert zu werden. Alle Änderungen wirken sich automatisch auf zukünftig erstellte Serienbriefe aus. Das ist bei Template-Engines genauso; weitere Parallelen zu Serienbrief-Vorlagen sind:
- Die Daten kommen aus einer externen Quelle (Datenbank, Tabellenkalkulation etc.).
- Um die Daten zu ändern, braucht das Template nicht verändert zu werden, und umgekehrt.
- Das Template kann wiederverwendet werden.
Abgrenzung
Template-Engines werden häufig von Programmierern eingesetzt, um im Kontext von Webanwendungen Programm-Code (einer Programmiersprache) vom Design zu trennen. Genauso wird von den Herstellern mancher Template-Engines angeführt, Templates und Engines sollen durch die Trennung der Programmierlogik vom Design das Skript von HTML-Code befreien und damit übersichtlicher machen.
Demgegenüber steht der ursprüngliche Gedanke der Template-Engines: Sie sollen statischen Text und dynamische Inhalte möglichst effizient miteinander verknüpfen. Oft sind Template-Engines deshalb gerade in Programmiersprachen anzutreffen, deren Syntax eine solche Mischung nicht direkt unterstützt (z. B. Java: JSP; VBScript u. a.: ASP). Für eine echte Trennung der Darstellung von den Datenmodellen und den Logikkomponenten sind Template-Engines dagegen ungeeignet, und es sind zusätzliche Konzepte wie Model View Controller notwendig.
Vorteile
Nachteile
- Template-Engines erzeugen zur Laufzeit Zusatzaufwand (engl. "overhead").
- Template-Engines müssen im Gebrauch erlernt werden. Neben der neuen Syntax sind auch oft grundlegende Kenntnisse der objektorientierten Programmierung Voraussetzung.
- Template-Engines sind auf eine textuelle Ausgabe beschränkt.
Sprachabhängige Template-Engines
Template-Engines sind sehr verbreitet. XSLT ist für alle Template-Engines eine Konkurrenz. Bei PHP ist Smarty weit verbreitet, hat aber die Eigenentwicklungen und andere Template-Engines nicht vom Markt verdrängt.
Template-Engines für PHP
PHP selbst ist bereits so entworfen, dass man programmiersprachliche Konstrukte mit der textuellen Ausgabe über Platzhalter bzw. gekennzeichnete Bereiche mischen kann.
<h1><?php echo $body_text; ?></h1>
<?php foreach($test_array as $key => $value) : ?>
<p>Schlüssel: <?php echo $key; ?> - Wert: <?php echo $value; ?></p>
<?php endforeach; ?>
Der Vorteil liegt in der einfachen Verwendung. Es braucht keine zusätzliche Bibliothek installiert zu werden, auch ist diese Vorgehensweise für PHP-erfahrene Entwickler am leichtesten zu verstehen und folgt dem Prinzip der geringsten Überraschung. Die Verwendung einer gesonderten Template-Engine für PHP ist daher nicht erforderlich. Dennoch bietet die Verwendung einer Template-Engine für PHP, neben der besseren Übersicht, einige Vorzüge, beispielsweise können einfache, anpassbare Templates für Fehlermeldungen und ähnliche, wiederkehrende Strukturen erstellt werden. Einige populäre Template-Engines sind:
- Smarty[1]
- Twig[2]
- Fluid (als Teil von TYPO3 Flow)[3]
- vlibTemplate[4]
- TinyButStrong[5]
- Contemplate[6]
- ETS (Easy Template System)[7]
- t24 - PHP template parser[8]
- HTML_Template_IT: HTML Integrated Templates, PEAR-PackageuBook Template[9]
- uBook Template[10]
- KTemplate[11]
- Hyperkit PHP/XML Template-Engine[12]
- Beilpuz[13]
- Separate[14]
- Blade (als Teil von Laravel)[15]
Beispiel
Um eine Template-Engine zu verwenden, benötigt man die Template-Datei (in der die auszugebenden Daten enthalten sind) sowie das Script, welches das Template lädt und die Platzhalter mit Werten füllt.
Das Template könnte so aussehen:
<body>
<p>Hallo, {name}!</p>
</body>
Und so könnte eine Wertzuweisung vom Script aus aussehen:
$template->assign('name', 'Erika Mustermann');
Das Ergebnis:
<body>
<p>Hallo, Erika Mustermann!</p>
</body>
Template-Engines für Perl
Template-Engines für Python
Es gibt viele Template-Engines unter Python. Beispiele sind Django oder TurboGears. Eine gute Übersicht (mit URI und Code-Beispielen) findet man im deutschen PythonWiki[23]. Eine umfangreichere Liste, dafür weniger erklärt, findet man im englischen Wiki zu Python[24]. Weitere sind Cheetah, SimpleTAL, pyTemple, pyratemp[25] und einige Python Template-Engines[26], Spytee, Nevow, Kid, Genshi, Jinja und HTMLTemplate.
Anwendungsbeispiel
# -*- coding: utf-8 -*-
# Modul Template muss importiert werden
from string import Template
# Vorlage zum Lesen öffnen, Inhalt übergeben und Datei schließen
vorlage = open('vorlage.txt', 'r')
vorl_inhalt = vorlage.read()
vorlage.close()
# Den Inhalt als Template behandeln
template = Template(vorl_inhalt)
# Ersetzungen nach folgendem Schema festlegen
ersetzungen = { 'Name' : 'Hans Meier', 'Straße' : 'Bahnhofstraße 69', 'Ort' : '12345 Foobarhausen' }
# Ersetzungen vornehmen
ersetzen = template.substitute(ersetzungen)
# Vorgang in Datei schreiben
outfile = open('ausgabe.txt', 'w')
outfile.write(ersetzen)
outfile.close()
vorlage.txt:
Name: ${Name}
Straße: ${Straße}
Ort: ${Ort}
ausgabe.txt:
Name: Hans Meier
Straße: Bahnhofstr. 69
Ort: 12345 Foobarhausen
Template-Engines für C++ und C
Für C++ und C gibt es verschiedene Template-Engines, wie
Template-Engines für Java
Einige Template-Engines für Java[30] sind java-basierte, quelloffene Template-Engines.
- StringTemplate Template-Engine von Terence Parr, Basis für sein ANTLR, portiert auf C#, Objective-C und JavaScript
- FreeMarker – Java-basierte Template-Engine[31]
- Apache Velocity – Java-basierte Template-Engine
- Thymeleaf - Java-basierte Template-Engine[32]
Template-Engines für JavaScript
Im Gegensatz zu den vorherigen Lösungen können Templates vom Web-Browser verarbeitet werden. Der Server liefert nur die Daten z. B. als JSON, oder XML String. Der Rest übernimmt JavaScript im Browser.
- AngularJS Clientseitiges JavaScript-Webframework von Google
Weitere Informationen zu Template-Engines
Einige weitere Template-Engines sind Java-basiert:
- Hamlets – Java-basierte Template-Engine
- action4JAVA[33] - Java-basiertes Framework mit Template-Kern.
- jade4j – Java-basierte, freie Implementierung der Jade Template-Engine[34]
- Xpand – Java-basierte Template-Engine für die Codegenerierung[35]
- ASP[36]
- CTPP, Cross-platform Template-Engine für C++, C, PERL und PHP[37]
- GvTags Template-Engine für Groovy[38]
- jQote2 - jQuery JavaScript Templating Engine[39]
- FilesFromCSV - .NET basiert - erzeugt pro CSV Datensatz ein Dokument[40]
- Handlebars – JavaScript-basierte semantische Template-Engine[41], wird u. a. in Ghost verwendet
- AWS Templates Parser – Ada-basierte Template-Engine[42]
Literatur
- Karsten Wendland: Der Template-Zyklus. Web-Templates im Spannungsfeld von schöpferischem Gestalten und einschränkender Zumutung. Aachen 2006, ISBN 3-8322-5285-1.
Einzelnachweise
- Smarty extern
- Twig (Memento des vom 9. Juli 2017 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- (extern (Memento des vom 31. Januar 2009 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.)
- vLIB (Memento des vom 21. Januar 2005 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.: vlibTemplate (Memento des vom 19. Juni 2006 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis., vlibDate (Memento des vom 17. Juli 2006 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis. und vlibMimeMail (Memento des vom 17. Juli 2006 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis. (englisch (Memento des vom 21. Januar 2005 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis., deutsch)
- TinyButStrong
- Contemplate (Memento des vom 22. November 2005 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- ETS (Easy Template System)
- t24 - PHP template parser
- HTML_Template_IT: HTML Integrated Templates, PEAR-Package
- uBook Template
- KTemplate (Memento des vom 14. Mai 2008 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- Hyperkit PHP/XML Template-Engine (Memento des vom 24. Januar 2012 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- Beilpuz
- Separate
- Blade Templates - Laravel - The PHP Framework For Web Artisans. Abgerufen am 1. Juni 2019.
- Template Toolkit
- Contemplate (Memento des vom 22. November 2005 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- Embperl
- Mason
- HTML Template
- Text Template
- HTML CTPP2
- deutschen PythonWiki (Seite nicht mehr abrufbar, festgestellt im Mai 2019. Suche in Webarchiven) Info: Der Link wurde automatisch als defekt markiert. Bitte prüfe den Link gemäß Anleitung und entferne dann diesen Hinweis.
- englischen Wiki zu Python
- pyratemp
- Vergleich und Benchmarks: Python Template-Engines
- ClearSilver
- Grantlee Template System
- Projektübersicht zu Google CTemplate bei Google Code
- Java-Source.net - Open Source Template Engines in Java
- Freemarker website
- Thymeleaf
- action4JAVA (Memento des vom 28. Februar 2013 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- jade4j Bezugsquelle
- oAW website
- Contemplate (englisch) (Memento des vom 22. November 2005 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- CTPP
- GvTags Template-Engine für Groovy
- jQote2 (Memento des vom 9. April 2010 im Internet Archive) Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.
- FilesFromCSV
- Handlebars.js: Minimal Templating on Steroids
- AWS Templates Parser: A template engine
