Шаблонизация с javascript
http://ejohn.org/blog/javascript-micro-templating/
Есть одна утилитка, которой я уже пользуюсь некоторое время, довольно полезная при построении javascript-приложений. Это - супер-простая и очень быстрая функция для шаблонизации на клиенте. Она предложена Джоном Ресигом.
Я применяю ее для постраничной навигации и для небольших шаблонов в AJAX-приложениях с подгрузкой данных с сервера.
Вот исходный код функции шаблонизатора:
(function(){
var cache = {};
this.tmpl = function tmpl(str, data){
// Выяснить, мы получаем шаблон или нам нужно его загрузить
// обязательно закешировать результат
var fn = !/\W/.test(str) ?
cache[str] = cache[str] ||
tmpl(document.getElementById(str).innerHTML) :
// Сгенерировать (и закешировать) функцию,
// которая будет служить генератором шаблонов
new Function("obj",
"var p=[],print=function(){p.push.apply(p,arguments);};" +
// Сделать данные доступными локально при помощи with(){}
"with(obj){p.push('" +
// Превратить шаблон в чистый JavaScript
str
.replace(/[\r\t\n]/g, " ")
.split("<%").join("\t")
.replace(/((^|%>)[^\t]*)'/g, "$1\r")
.replace(/\t=(.*?)%>/g, "',$1,'")
.split("\t").join("');")
.split("%>").join("p.push('")
.split("\r").join("\\'")
+ "');}return p.join('');");
// простейший карринг(термин функ. прог. - прим. пер.)
// для пользователя
return data ? fn( data ) : fn;
};
})();
Её можно использовать с шаблонами, написанными в таком виде (не обязательно точно в таком, но этот стиль мне нравится):
<script type="text/html" id="item_tmpl">
<div id="<%=id%>" class="<%=(i % 2 == 1 ? " even" : "")%>">
<div class="grid_1 alpha right">
<img class="righted" src="<%=profile_image_url%>"/>
</div>
<div class="grid_6 omega contents">
<p><b><a href="/<%=from_user%>"><%=from_user%></a>:</b> <%=text%></p>
</div>
</div>
</script>
Вы также можете сделать скриптовую вставку:
<script type="text/html" id="user_tmpl">
<% for ( var i = 0; i < users.length; i++ ) { %>
<li><a href="<%=users[i].url%>"><%=users[i].name%></a></li>
<% } %>
</script>
<script type="text/html">
Скрипты с неизвестным типом содержания type (как в примере выше - браузер не знает что делать с text/html -скриптом) просто игнорируются браузерами и поисковиками.
Это замечательный способ незаметной вставки шаблонов в страницу. Мне нравится такая техника для случаев, когда нужно быстро вставить один-другой небольшой шаблон.
А вызов шаблонки из скрипта - примерно такой:
var results = document.getElementById("results");
results.innerHTML = tmpl("item_tmpl", dataObject);
Вы можете прекомпилировать результат для дальнейшего использования. Если Вы вызываете функцию-шаблонизатор только с ID(или кодом шаблона) - она вернет прекомпилированную функцию, которую Вы можете запускать, когда угодно:
var show_user = tmpl("item_tmpl"), html = "";
for ( var i = 0; i < users.length; i++ ) {
html += show_user( users[i] );
}
Самая большая проблема этого метода, на текущий момент - это код парсинга/конвертации. Он использует много регулярных выражений и его можно улучшить.
Однако, он использует одну технику, которая мне очень нравится - а именно: если Вы делаете поиск-и-замену фиксированных подстрок, то быстрее всех с этим справляется .split("match").join("replace") .
Это неочевидно, но так оно работает быстрее всего в большинстве современных браузеров.
Играйте с этим кодом, как захотите - мне даже любопытно, во что он может превратиться. Он очень прост - и по идее, с ним можно сделать многое.
|
Чуть не забыл - когда шаблоны пишете - обязательно везде ставить точки с запятой и не использовать комментов //
Т.к весь шаблон функция превращает в одну строку в итоге - будут синтаксические ошибки без точек с запятой.
Эту шаблонку можно по-разному модифицировать, я использую чуть упрощенный вариант:
Вызвать компиляцию шаблона и тут же получить результат для
data
можно так:А вот так не скушает
Надо без точки с запятой в таких конструкциях.
Я бы сделал даже так:
Мы ведь говорим о RIA...
А разве нельзя в шаблонах использовать комменты следующего вида?
Мне кажется, что после сборки в одну строку комментарий такого вида не должен мешать выполнению скрипта, к тому же, можно удалять его через всё тот же RegExp... (с чем у меня, правда говоря, проблемы - пока не возникало большой необходимости его изучать)
Угу, такой комментарий вполне подойдет.
Извините, конечно, но это семиколесный велосипед. Его много раз изобретали до вас. И он конечно ездит. Но недалеко.
Есть куча js-фреймворков, превращающих маниуляции с DOM в детскую игру. Есть XSLT выполняемый непосредственно броузеорм или через JS. И в конце концов есть куча бесплатных или очень дешевых хостингов с php/.NET/phyton...
Вещь хорошая ездит замечательно. Пользуюсь нравится.
Про php/.NET/python - это Вы в сторону далеко ушли. Тут именно JS-шаблонка. Для своих задач. Возможно, их у Вас пока не возникало, возникнут - вспомните, придете на эту страничку
P.S А XSLT на уровне браузера - мало того что куча несовместимостей, так оно еще и убогое, без EXSLT.
для чего вообще это нужно?
взял ваши примеры реализовал все работает гладко, мне понравилось
Эта функция шаблонизации не будет работать в ASP-страницах.
Дело в том, что дескрипторы начала (<%=) и конца (%>) шаблона уже зарезервированы ASP-движком.
Точно. На таких страницах лучше бы поправить <%= .. %> на что-нибудь другое.. Например, на <?= ... ?>
мсье шутить изволит))
Зачем в серверном языке джаваскрипт-шаблоны ? :\
А как сделать, чтоб при нажатии на кнопку появлялось окошко с текстом?(что надо в скрипте написать?)
(что надо здесь написать?)("действие")
Спасибо за информацию.
Вопрос, не могу решить куда поместить шаблон, когда он необходим при реализации плагина/библиотеки...
Не хочется каждый раз копи-пастить шаблон в новый проект, где будет использоватся библиотека...
Присоединяюсь к последнему вопросу. Если у меня многострочный шаблон, использующийся в двух-трех разных местах. Какие способы организации хранения и получения шаблонов?
Это уже вопросы к вашему движку и фреймворку. Javascript-шаблон - такой же шаблон как и остальные.
Удивился по поводу сказанного, что split.join работает быстрее replace.
Поэтому провел тесты.
Делал замену 10 различных значений {blahblah} в длинной строке.
Запускал в IE6 и FF3.5. Оба браузера показали преимущество функции replace. Если в FF (на маленьких итерациях) значения еще хоть куда не шли, - похожие, то в IE6 split.join работает в разы медленнее replace. На больших итерациях split.join проигрывает очень сильно и в FF, и в IE6.
а еще можно выкинуть лишнее - функция print нигде не используется, видимо ресиг юзал её для своих целей, потом забыл выкинуть её, а все остальные тупо содрали
print=function(){p.push.apply(p,arguments);}
Функция print далеко не лишняя! Вставка переменной в шаблон осуществляется либо с помощью конструкции <%=variable%>, либо <% print (variable) %>. Второй вариант удобен в случае, например, такого шаблона:
Неплохо было бы указать назначение функции print в статье.
Вот вот, меня эта функция запутала, когда ковырял.
Собственно хотелось бы понять её смысл.
пример с шаблонизатором сделанный на основе выше предложенного ссылка на архив
У меня почему-то не работает, просто возвращает id темплейта - и все.
UPD. id шаблона должен подходить под регулярку \w+, иначе шаблонизатор принимает строку, переданную первым параметром в tmpl за шаблон, переданный текстом. Т.о. нельзя использовать дефисы в идентификаторах и такая запись не будет воспринята шаблонизатором как надо:
для использования "-" в id-шках можно переделать
!/\W/ в !/[^\w-]/
Вот если кто-то любит жквери, а еще любит шаблоны держать отдельно от страниц, то тут показано, как можно загружать внешние шаблоны http://www.clearboth.ru/article/using-external-templates-with-jquery-tem...
поясните значение $1 при реплейсинге.
Для шаблонизации я бы использовал связку js+XSLT
Самый лёгкий шаблонизатор (jQuery):
У меня тупошаблонизатор похож на предложенный в комментариях, только синтаксис ещё проще: %varname подставляет значение.
А вот реализация - чуть сложнее; при инициализации он ищет все script[type="text/x-tpl"] и складывает в массив по id. Ну и вызов - Tpl.render(myTemplateId, dataObject).
Думал над раскатыванием шаблонов в кэш js-функций, как в основном посте; на таких тупых шаблонах особого выигрыша не даёт. А совать в шаблоны логику я не стану.
Замечательно!!! Спасибо.
Можно конечно использовать существующие библиотеки, но мне нравится этот вариант.
Можно использовать несколько шаблонов, разместив их в объекте.
Это наверное пригодилось бы при работе с содержимым балунов в гугл картах.
Я заменил открывающий и закрывающий тэги в шаблоне на $[[ и ]].