Template Toolkit для веб разработчика.
Template Toolkit (TT) — это мощная система обработки шаблонов, написана на Perl. Использование шаблонов для генерации веб страниц позволяет убрать из cgi скрипта весь html код в отдельный файл (шаблон), где его сможет редактировать дизайнер. Скрипт при этом становися более читабельным. Нечитабельные скрипты тоже имеют свои преимущества: если вас уволят, другие программисты будут до старости разбираться в написаной вами матершине, а начальство десять раз пожалеет о том, что поспешило с вами расстаться.
Как это выглядит — простой пример.
Вот пример скрипта, использующего ’TT’ (script.pl):
#!/usr/bin/perl
use strict;
use CGI qw(:cgi);
use Template;
my $scalar = 'a';
my @list = ('b', 'c');
my %hash = (key => 'uuu');
sub code { scalar (localtime) }
my $object = CGI->new;
my $parser = Template->new (INCLUDE_PATH => '/home/my-project.ru/tpl');
print header ();
$parser->process('page.tpl', { scalar => $scalar,
list => \@list,
hash => \%hash,
code => \&code,
cgi => $object }) or die $parser->error;
А это шаблон (page.tpl):<body>
Our varibles: [% scalar %], [% list.0 %], [% list.1 %], [% hash.key %]
Time: [% code %]
User: [% cgi.param('user') %]
</body>
Теперь наберём //my-project.ru/cgi-bin/script.pl?user=VASIA и получим страничку:
<body>
Our varibles: a, b, c, uuu
Time: Sun Jan 5 16:52:56 2003
User: VASIA
</body>
Что TT может - какие директивы используются в шаблонах.
1. Использование переменных[% GET var %] или просто [% var %] - TT подставляет значение переменной var.
[% SET var = 'value' %] или просто [% var = 'value' %] - TT присваивает значение переменной var.
Переменная в TT - это скаляр, содержащий либо обычную строку, либо ссылку на список, хэш, объект или функцию. Инициализируются переменные также, как в Perl:
[% scalar = 'hello' %], [% scalar = 10 %]
[% list = [1, 2, 'world'] %], [% list = [1..9] %]
[% hash = {
a => 'b',
c => 'd'
}
%]
Чтобы передать переменные из скрипта в шаблон, служит 2ой аргумент метода process класса Template (см. script.pl). В директивах [%GET%] и [%SET%] можно использовать арифметические (+ - * / % mod div) и логические (and, or, not, ?: ) операторы:
[% a = b*c + 10 %]
[% (a) ? b : c %]
Подробно об использовании переменных в TT:
//www.template-toolkit.org/docs/default/Manual/Variables.html
И о дерективах для доступа к переменным:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Accessing_and_Updating_Template_Variables
2. Включение других шаблонов.
[% BLOCK blockname %] ... [% END %] - Определение блока blockname. Блок в TT - аналог функции в Perl. Тело блока -это шаблон. Блок может 'вызываться' директивами [% INCLUDE %] и [% PROCESS %]. Допустима рекурсия.
[% INCLUDE tplname %] - TT включает шаблон tplname. tplname - это либо шаблон, определённый директивой [% BLOCK %], либо имя файла. Cначала проверяется наличее блока tplname, если такого нет, ищется файл. INCLUDE_PATH - мы использовали эту переменную присоздании объекта Template, это список директорий, в которых TT ищет файлы шаблонов. Все наши переменные включаемому tplname видны. И все переменные перед включением tplname локализуются:
[% BLOCK dummy %] [% a = '1' %][% a %] [% END %] [% a = 0 %][% a %] [% INCLUDE dummy %] [% a %]результатом будет 0 1 0.
Важно заметить: при локализации в TT создаются новые копии всех переменных, но не создаются копии объектов, на которые переменные могут ссылаться. Т.е. если переменная содержит строку — всё ок, получим новую копию строки. Если переменная содержит ссылку на, скажем, список — получим новую ссылку на тот же список:
[% BLOCK dummy %] [% a.0 = '1' %][% a.0 %] [% END %] [% a.0 = '0' %][% a.0 %] [% INCLUDE dummy %] [% a.0 %]результатом будет 0 1 1.
Авторы TT называют это явление 'skin deep localization', красиво звучит, правда? :)
Передать параметры во включаемый шаблон можно следующим очевидным образом:
[% INCLUDE dummy a=1 b=2 %]
[% PROCESS tplname %] - то же, что и [% INCLUDE %], только без локализации переменных. Соответсятвенно работает немного быстрее.
[% INSERT file %] - TT включает указаный файл, не обрабатывая его как шаблон.
Подробно об этом:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Processing_Other_Template_Files_and_Blocks
3. Управление 'выполнением'.
[% IF %] [% UNLESS %] [% ELSIF %] [% ELSE %]
[% SWITCH %] [% CASE %]
[% FOREACH %]
[% WHILE %]
- всё это рабортает. Роль '}' выполняет [% END %]. В циклах можно спользовать [% NEXT %] и [% LAST %].
Подробно:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Conditional_Processing
//www.template-toolkit.org/docs/default/Manual/Directives.html#Loop_Processing
4. Фильтры.
Очень удобная и полезная осбенность TT.
[% FILTER filtername %] data to filter [% END %]
[% INCLUDE sometemplate FILTER filtername %]
[% INCLUDE sometemplate FILTER filtername FILTER otherfiltername %]
- TT обрабатывает указаный текст или результат включения sometemplate фильтром filtername. Фильтр - это некоторая функция обработки текста. TT содержит пару десятков встроеных фильтров, например:
html - заменяет < > & на < > &
upper (lower) - преобразует символы текста в заглавные (строчные)
uri - заменяет буквы, которых не должно быть в урле, на %хх последовательности
полный список встроеных фильтров:
//www.template-toolkit.org/docs/default/Manual/Filters.html
Можно создавать свои фильтры. Подробно о фильтрах здесь:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Filters_Plugins_Macros_and_Perl
5. Плагины и Perl код в шаблонах.
ТТ содержит набор модулей - плагинов - //www.template-toolkit.org/docs/default/Manual/Plugins.html.
Чтобы использовать функциональность плагина в шаблоне, нужно включить его:
[% USE PluginName(param1, param2, ...) %].
С помощью директивы [% PERL %] в шаблон можно внедрить Perl код.
Но зачем нужны эти директивы??? Мы же собирались держать Perl отдельно, а html отдельно!!
Возможность включить Perl код в шаблон есть, но пользоваться ей не обязательно :).
Подробно:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Filters_Plugins_Macros_and_Perl
6. Обработка исключений.
Имеется в TT и механизм обработки исключений, устал я уже писать, поэтому просто дам ссылку:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Exception_Handling_and_Flow_Control
Производительность — как быстро всё это рулит.
Вы, наверное, думаете, что такая мощная штука сильно тормозит. Не совсем так… Давайте посмотрим, на что тратится время при вызове нашего script.pl:1. компилируется script.pl и модули. Модуль Template.pm включает много других модулей (попробуйте напечатать %INC в script.pl, чтобы увидеть, насколько много), все они также компилируются.
2. выполняется код script.pl до вызова метода process.
3. вызван метод process. TT компилирует шаблон page.tpl. Откомпилированый шаблон предсталяет собой Perl функцию, печатающую html страничку. Объект класса Template имеет кэш откомпилированых шаблонов.
4. Откомпилированый шаблон вызывается с параметрами, которые мы передали методу process.
У нас имеется одна система на хостинге мастерхост, использующая TT. Между мышиным кликом и отображением странички проходит <= 1сек. Часто такой производительности недостаточно. Можно съэкономить время, не выполняя при каждом запросе 1 и 3 этапы. Время в таком случае будет тратиться лишь на выполнение кода скрипта и на выполнение функции, печатающей html. Как это сделать:
1. mod_perl - технология, позволяющая не компилировать скрипты и включаемые модули при каждом запросе — от 1 этапа мы тем самым избавляемся. Кроме того, глобальные переменные скрипта сохраняются от запроса к запросу. Для нас это хорошо тем, что можно хранить объект класса Template и следовательно кэш откомпилированых шаблонов. Так мы избавились от 3 этапа. Возможно у вашего хостера нет mod_perl. Тогда:
2. вы делите Ваш скрипт на 2 части: часть 1, использующая Template.pm, работает постоянно отдельным процессом. часть 2, реализующая всё остальное, рождается как обычно при каждом запросе и общается с частью 1 через UNIX socet.
О чём ещё нужно сказать
- Где взять
- //www.template-toolkit.org/download.html#stable
- //www.cpan.org/modules/by-module/Template/Template-Toolkit-2.08.tar.gz
- //www.cpan.org/modules/by-module/Template/Template-Toolkit-2.08.tar.gz
- Документация
- //www.template-toolkit.org/docs/default/index.html
- Кто использует
- //www.openinteract.org/
- //slashcode.org/
- //openframe.fotango.com/
- //pcmt.sf.net/
- //slashcode.org/