Template-Engine

Dieser Artikel wurde wegen inhaltlicher Mängel auf der Qualitätssicherungsseite der Redaktion Informatik eingetragen. Dies geschieht, um die Qualität der Artikel aus dem Themengebiet Informatik auf ein akzeptables Niveau zu bringen. Hilf mit, die inhaltlichen Mängel dieses Artikels zu beseitigen, und beteilige dich an der Diskussion! (+)

Eine Template-Engine (von engl. Vorlage und Maschine) ist eine Software, die eine Datei (das Template) verarbeitet, und bestimmte Platzhalter darin mit jeweils aktuellen Inhalten füllt. Die Bezeichnungen Templateklasse und Templatesystem werden oft als Synonym für eine Template-Engine verwendet.

Klassentemplates in der C++-Programmierung sind dagegen nicht mit Template-Engines vergleichbar, weil sie eine vom Datentyp unabhängige Programmierung ermöglichen und ganze Klassen enthalten.

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 Templatevariablen genannt. Wenn aus dem Dokument dann mehrere Serienbriefe erzeugt werden, steht anstatt der Templatevariablen name ein realer Name wie „Erika Mustermann“ im fertigen Serienbrief.

Das Dokument muss nur einmal geschrieben und formatiert 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, muss das Template nicht verändert 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 z. B. Model View Controller notwendig.

Vorteile

• Programm-Code (PHP, Python, Perl, etc.) wird vom Markup (HTML) getrennt
• Designer und Programmierer können gleichzeitig an einem Projekt arbeiten
• WYSIWYG-Editoren können verwendet werden

Nachteile

Template-Engines

• erzeugen immer zusätzlichen Overhead.
• müssen im Gebrauch erlernt werden. Neben der neuen Syntax sind auch oft grundlegende Kenntnisse der objektorientierten Programmierung Voraussetzung.
• sind auf eine textuelle Ausgabe beschränkt.

Sprachabhängige Template-Engines

Die Masse von Template-Engines ist enorm. Eigenentwicklungen sind an der Tagesordnung. 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 muss keine zusätzliche Bibliothek installiert 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 existieren besonders für PHP eine sehr große Zahl von Engines:

• Smarty (extern)
• Twig
• Fluid (als Teil von FLOW3 (extern)
• vLIB: vlibTemplate, vlibDate und vlibMimeMail (englisch, deutsch)
• TinyButStrong
• Contemplate
• ETS (Easy Template System)
• t24 - PHP template parser
• HTML_Template_IT: HTML Integrated Templates, PEAR-Package
• uBook Template
• KTemplate
• Projektübersicht zu Serpent Template-Engine bei Google Code
• Hyperkit PHP/XML Template-Engine
• Beilpuz
• Separate

Beispiel

Um eine Template-Engine zu verwenden, benötigt man die Template-Datei (in der die auszugebenen 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 Toolkit
• Contemplate (auch ASP)
• Embperl
• Mason
• HTML Template
• Text Template
• HTML CTPP2

Template-Engines für Python

• Cheetah
• SimpleTAL
• pyTemple
• pyratemp und Vergleich und Benchmarks einiger Python Template-Engines
• Spytee
• Nevow
• Kid
• Genshi
• Jinja
• HTMLTemplate

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. Eine umfangreichere Liste, dafür weniger erklärt findet man im englischen Wiki zu Python.

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', 'Strasse' : 'Bahnhofstr. 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}
Strasse: ${Strasse}
Ort: ${Ort}

ausgabe.txt:

Name: Hans Meier
Strasse: Bahnhofstr. 69
Ort: 12345 Foobarhausen

Template-Engines für C++ und C

• ClearSilver Die Template-Engine von Orkut und Yahoo Groups (setzen einen eigenen Branch ein).
• Grantlee Template System
• Projektübersicht zu Google CTemplate bei Google Code

Template-Engines für Java

Die nachfolgende Liste stellt eine Auswahl java-basierter Template-Engines dar, welche unter einer OpenSource Lizenz zugänglich sind.

• FreeMarker – Java-basierte Template-Engine (Freemarker website)
• Apache Velocity – Java-basierte Template-Engine

Sonstiges

• Hamlets – Java-basierte Template-Engine
• action4JAVA - Java-basiertes Framework mit Template-Kern.
• jade4j – Java-basierte, freie Implementierung der Jade Template-Engine (jade4j Bezugsquelle)
• XSLTengine - Java-basierte Template-Engine, insbesondere für Web-Entwickler (XSLTengine website)
• Xpand – Java-basierte Template-Engine für die Codegenerierung (oAW website)
• ASP: Contemplate (englisch)
• CTPP, Crossplatform Template-Engine für C++, C, PERL und PHP
• GvTags Template-Engine für Groovy
• jQote2 - jQuery Javascript Templating Engine
• FilesFromCSV - .NET basiert - erzeugt pro CSV Datensatz ein Dokument

Literatur

•  Karsten Wendland: Der Template-Zyklus. Web-Templates im Spannungsfeld von schöpferischem Gestalten und einschränkender Zumutung. Aachen 2006, ISBN 3-83225-285-1.