Данная статья – обзор шаблонизаторов для фронтенд разработки . Если Вы работаете с JS, отличным и подходящим выбором являются шаблонизаторы, так как они дают возможность писать более чистый базовый код и упрощают работу с приложениями. Рассмотрим наиболее популярные шаблонизаторы JS, которые нам предлагает Википедия. Для того, чтобы качественно работать с данными шаблонизаторами, нужно иметь хорошое понимание языка и достаточное количество навыков в этой сфере.
ICanHaz.js – довольно простая и легкая библиотека, чтобы работать с шаблонами Mustache. С ним можно определять фрагменты шаблонов в тегах скриптов с type=”text/html” и вызывать их через id, с валидацией.
Mustache.js – очень популярный шаблонизатор в данной области применения. Он предоставляет решения для серверной и клиентской стороны, поэтому вам не нужно будет беспокоиться о использовании нескольких шаблонизаторов. Имеет хорошую и понятную документацию, а также большое сообщество. В шаблонах использует данных JSON формата. Отлично запускается на популярных языках программирования. Последнюю версию библиотеки можно скачать с офицальной страницы .
– расширение для Mustache и полностью с ним совместимо. Имеет большую скорость исполнения, так как не перегружен лишней логикой. HTML по тому же принципу генерируется из данных в формате JSON. Существенный недостаток – большой вес библиотеки.
Underscore.js – удобный и практичный инструмент для работы с jQuery. Имеет больше 60 функциональных утилит. Данный шаблонизатор усиляет функциональность jQuery при работе с массивами, функциями, объектами, коллекциями и т.д. 5 альтернатив jQuery UI .
Hogan.js – шаблонизатор, который разработала компания Twitter. Его используют в качестве компоновщика промежуточных шаблонов для их быстрой динамической обработки веб-браузером. В основу разработки данного шаблонизатора был положен Mustache, но Hogan.js работает намного быстрее. Для доступа к функциям парсера предлагается API. Сканирование шаблонов и парсинг исполняются отдельными методами, в результате чего шаблоны могут заранее обрабатываться на сервере, а на клиентской стороне использоваться в Javascript-виде.
– используют для работы с серверными шаблонами , но в общем применим и для других целей. Имеет высокую читабельность кода и хорошую безопасность. Функционирует из части клиента, есть возможность с помощью утилиты компилировать html-шаблоны из командной строки. Шаблонизатор переименован в Pug.js, но по старому названию можно найти большое количество документации и полезной информации для разработчика.
Шаблонизатор ECT разработан для повышения скорости. В его основе шаблонизатор Coffeescript. Имеет хорошую совместимость с Node.js и довольно простой синтаксис. Можно также ознакомиться с предварительными тестами, которые показывают производительность данной библиотеки.
Компания Hyper Host™ желает Вам приятной работы в мире JS и готова разместить Ваши замечательные проекты на нашем !
4366 раз(а) 3 Сегодня просмотрено раз(а)
Сейчас я вижу всего два варианта шаблонов в js приложениях шаблонизаторы которые встроены в фреймворк и jquery лапшу (последнее самое распространённое) Я полагаю что это из-за того что многие не понимают как работают шаблонизаторы вообще (я о их внутренностях, а не о функции).
В этой статья я покажу как сделать простой но мощный шаблонизатор на основе регулярных выражений.
Но для тех кто не в теме немного о том что же это такое и что оно нам даст.
И так мы хотим рендить шаблоны в 1 проход и иметь представление отдельно от логики. Обычно шаблонизаторы имеют подобный интерфейс.
template.Run("template url", {
VarName:"VarValue"
});
Ниже код с подробными комментариями (что и почему)
window.template = {
//заружает представление
TemplateGet: function (TemplateUrl) {
// 1. Создаём новый объект XMLHttpRequest
var xhr = new XMLHttpRequest();
// 2. Конфигурируем его: GET-запрос на URL "TemplateUrl"
xhr.open("GET", TemplateUrl, false);
// 3. Отсылаем запрос
xhr.send();
if (xhr.status >= 200 && xhr.status < 400) {
// вернуть результат
return xhr.responseText;
} else {
// обработать ошибку
alert(xhr.status + ": " + xhr.statusText); // пример вывода: 404: Not Found
return "";
}
},
//класс функций для рендинга
Render:{
//а в этом классе мы напишем все функции рендера
func:{
//рендит переменные
vars: function(html, vars){
//ищем все переменные в шаблоне
var $ = html.match(/{{var.(.*?)}}/g);
//проверяем нашли ли что то
if (Array.isArray($)) {
//мы нашли переменные в шаблоне. Необходимо их все распарсить.
$.forEach(function (item) {
//item содержит найденую строку {{var.VarName}}
//по этому мы должны распарсить ету строку дабы получить только VarName
item = item.replace("{{var.", "");
item = item.replace("}}", "");
//у нас есть имя переменной. Пора проверить передали ли мы такую
//и обработать ошибки
if (vars === undefined){
//перенную не передали.
//пишем об ошибке в консоль и заменяем её значение в шаблоне на null
console.warn("Переменная "+item+" не найдена");
html = html.replace("{{var." + item + "}}", "null");
} else {
//переменную мы нашли. Вставим ка её в шаблон
html = html.replace("{{var." + item + "}}", vars);
}
});
}
//удалим обьект с переменными
delete vars;
//вернём html
return html;
}
},
//точка входа в рендер.
Run:function(html, vars){
html = this.func.vars(html, vars);
return html;
}
},
//точка входа
Run: function (TemplateUrl, vars) {
//загружаем шаблон
var html = this.TemplateGet(TemplateUrl);
//отправляем шаблон рендеру
html = this.Render.Run(html, vars);
//удаляем обьект с переменными. Он нам больше не нужен, а может занимать много места
delete vars;
//результат шаблонизатор вставит в
document.getElementById("page").innerHTML = html;
}
};
//вызовем представление
template.Run("test.tpl", {
VarName: "test"
});
А в test.tpl просто напишем
{{var.VarName}}
Я надеюсь теперь меньше станет jquery лапши)
Фреймворки шаблонизаторы отделяют макет (разметку страницы) динамических веб-сайтов и приложений от интегрированной в них логики. Все фреймворки поддерживают различные формы циклов, условной логики и специального форматирования. Но мне хотелось получить такой движок, который бы располагал продвинутыми инструментами построения страницы для нескольких целей:
- для совместного использования разметки на страницах;
- для включения отдельных блоков с функциональностью (при необходимости);
- в общем и целом для упрощения процесса построения в меру сложных макетов страниц c минимумом прилагаемых усилий.
Существует ряд популярных шаблонизаторов для JavaScript, и мы рассмотрим некоторые из них:
EJSEJS (Встроенный JavaScript) очень напоминает PHP или JSP, очень простые функции – слишком простые для того, чтобы быть хоть в чем-то полезными. Сразу исключаем.
JadeНаиболее характерной особенностью Jade является то, что он обозначает пробел без кавычек (как Coffeescript),что или является чудом (если вы верите в подобные вещи), или катастрофической неисправностью, если вы реалист (как я). По своим характеристикам этот шаблонизатор стоит на одном уровне с большинством других систем, но его стилевое оформление заставляет нас почти сразу его отбросить.
Mustache / HandlebarsИспользует знакомую { { систему токенов } } для встраивания логики в существующие шаблоны (и не только HTML). Обеспечивает хороший набор циклов, логику и управление переменными. Не очень хорошо работает с частичными шаблонами и блоками, а также другими элементами, необходимыми для более легкого создания умеренно сложных структур страниц, что является ключевым требованием даже для самой простой системы CMS, которую я бы хотел видеть. Идем дальше…
DustВ настоящее время популярен из-за его применения в LinkedIn. На первый взгляд, очень похож на Mustache / Handlebars, но дополнен рядом полезных функций, таких как именованные блоки. Однако процесс загрузки шаблона и рендеринг выглядят довольно неуклюже, и он до сих пор не поддерживает довольно широкий спектр функций для построения страницы. Хорош, но недостаточно…
NunjucksЕще одна { { система на основе токенов } } , обеспечивающая (как и другие движки) логику, выполнение циклов и возможность управления переменными. Но кроме этого, шаблонизатор предоставляет продвинутые элементы построения страницы, например, наследование блоков, включая наследование макетов, пользовательские теги и макросы. Это все наилучшим образом подходит для системы CMS, где страницы представляют собой серию «строительных блоков».
Итак, у нас есть победитель!
Для справки Основные примеры рендерингаДавайте рассмотрим некоторые примеры шаблонизатора Nunjucks в действии…
Динамический рендеринг на платформе Node при использовании nunjucks.renderВо-первых, мы рассмотрим пример, в котором будем использовать Nunjucks для рендеринга страницы в ответ на запрос веб-службы, который обрабатывается сервером Node. Этот сценарий очень похож на тот, который происходит при запросе PHP или СoldАusion или страницы ASP .NET на обычном веб-сайте или в веб-приложении.
Предположим, что Node уже установлен.
Устанавливаем Express и Nunjucks:
Npm install express --save npm install nunjucks --save
Создаем нашу базовую структуру app.js:
Var express = require("express") ; var nunjucks = require("nunjucks") ; var app = express();
Настраиваем Nunjucks :
Var PATH_TO_TEMPLATES = "." ; nunjucks.configure(PATH_TO_TEMPLATES, { autoescape: true, express: app } );
Простой путь:
App.get("/home.html", function(req, res) { return res.render("index.html") ; } ); app.listen(3000);
Создаем шаблон index.html:
Привет всем
Запуск с:
Node app.js
и переходим на http://localhost:3000 . Готово!
Добавление динамических данныхДавайте быстро расширим этот пример, чтобы показать, как можно передать данные вашему шаблону в Nunjucks.
Для начала давайте передадим некоторые данные функции render:
App.get("/home.html", function(req, res) { var data = { имя: "Энди", фамилия: "Нил" } ; return res.render("index.html", data) ; } );
Во-вторых, мы будем ссылаться на эти данные в нашем шаблоне index.html:
Привет { { data.имя } }
Угадали, что произойдет, когда мы перейдем на http://localhost:3000 ?
Предварительная компиляция при помощи GulpЕсли у вас есть шаблоны, которые не опираются на динамические данные, тогда альтернативой их рендерингу по запросу будет использование инструмента Gulp (или Grunt, если он вам больше по душе) для предварительной компиляции данных во время компоновки.
Предположим, у вас есть простой сайт, состоящий из двух страниц со схожей разметкой:
- src/index.html
- src/contact-us.html
- src/_layout.html
Ваши странички могут выглядеть так:
{ % set title = "Главная" %} { % extends "_layout.html" %} { % block content %} Добро пожаловать { % endblock %} { % set title = "Контакты" %} { % extends "_layout.html" %} { % block content %} КонтактыЗвоните нам на 0800 000 0000 или отправьте письмо на эл. адрес [email protected].
{ % endblock %}{ { title } } { % block content %} { % endblock %}
Устанавливаем плагин gulp-nunjucks:
Npm install gulp-nunjucks --save
Создаем простой gulpfile.js в корневой папке проекта:
Var gulp = require("gulp") ; var nunjucks = require("nunjucks") ; var COMPILE = { SRC: "/src/**.html", DEST: "/dist’ } ; gulp.task("render", function() { return gulp.src(COMPILE.SRC) .pipe(nunjucks()) .pipe(gulp.dest(COMPILE.DEST)) ; } );
Запускаем процесс рендеринга:
Gulp render
Полученные в результате страницы HTML будут выглядеть так:
Главная Добро пожаловать
Разве это не самый лучший сайт в мире?
Контакты Контакты
Позвоните нам на 0800 000 0000 или отправьте письмо на эл. адрес [email protected].
Особенности NunjucksПолную документацию можно посмотреть здесь:
В этом разделе мы затронем некоторые из основ для иллюстрации некоторых ключевых функций Nunjucks.
Наследование шаблонаНаследование шаблона - это самый простой путь к многократному использованию шаблонов. При написании шаблона можно определить «блоки», которые дочерние шаблоны могут переопределить. (Это то, что мы делали выше в разделе { % содержание блока %} ).
Таким образом, дочерний шаблон может наследовать у родительского шаблона и заполнять множественные, дискретные блоки в этом шаблоне. На самом деле, «цепочка наследования» может быть настолько длинной, насколько вам этого хочется. Так, например, отдельный раздел новостей на веб-странице может наследовать шаблон «новостной сюжет» (и другие страницы также могут иметь свои шаблоны, например, «блоги», «фото галерея»), который, в свою очередь, наследует родительский (базовый) шаблон, содержащий общие разделы для всех страниц сайта.
ВключенияОбратная сторона расширений – это то, что они включают шаблон внутрь текущего шаблона. Это полезно для «вытягивания» блоков контента, которые используются в нескольких местах на сайте или в приложении.
Импортирование и макросыИмпортирование позволяет загружать шаблон и открывать любые переменные и макросы (функции), определенные в нем. Это может быть полезно для таких вещей, как создание функций для последовательного отображения полей формы... немного похоже на написание пользовательских тегов с помощью ColdFusion, например. Для наглядности давайте рассмотрим шаблон под названием forms.html , который выглядит так:
{ % macro field(name, value = "", type = "text") %} { % endmacro %} { % macro label(text) %} { { text } } { % endmacro %}Мы можем импортировать этот шаблон и использовать его для быстрого рендеринга серии полей формы:
{ % import "forms.html" as forms %} { { forms.label("Username") } } { { forms.field("user") } } { { forms.label("Password") } } { { forms.field("pass", type = "password") } }Это особенно полезно при использовании таких фреймфорков, как Foundation или Bootstrap , которые требуют разумного количества HTML и CSS сред - если у вас это получилось путем рендеринга в макросе, то код вашего шаблона будет гораздо проще. (Плюс, если ваш шаблон делает весь рендеринг через макросы, то он напрямую не привязан к фреймворку, что облегчает переключение фреймфорков, а также позволяет делать изменения, общие для всех полей формы определенного типа).
Логика – If / For / Whileif проверяет состояние и используется для выборочного отображения контента или выполнения других операций:
{ % if variable %} Переменная есть, ура { % endif %} { % if user.authorised %} { % extends "logged-in.html" %} { % else %} { % extends "logged-out.html" %} { % endif %}for зацикливает массивы:
Var messages = ["Необходимо ввести адрес эл. почты", "Пароль должен быть не короче 8 знаков"];
{
% for message in messages %}
{
{
message }
}
{
% endfor %}
Советую изучить официальную документацию Nunjucks для более ясного представления о свойствах и возможностях шаблонизатора.
В будущих обзорах я покажу, как можно скомбинировать возможности шаблонизатора Nunjucks с генератором статичных сайтов Wintersmith для построения своей собственной простой и многоязычной системы CMS.
Но так как я частенько увлекаюсь JavaScript"ом, то решено было найти подобный шаблонизатор для этого языка, но серверного (node.js, ага). Первые ссылки в поисковике выдают такие шаблонизаторы, как: ECT , JUST , . Все они, естественно, не подходили для меня, т.к. слишком далеко были от синтаксиса Smarty.
Чтож, раз хочется, а решений нет - то сделай. Выискивая время на работе и иногда получая по «шапке», родился проект NodeSmarty , который, в будущем, будет частично копировать синтаксис Smarty .
Итак, свои корни проект пустил примерно 4 месяца назад, в сентябре 2012 года и постепенно обретал рабочий вид. По началу весь алгоритм компиляции шаблонов брался из Smarty (файл Smarty_Compiler.class.php), некоторые функции не были перенесены. В процессе написания кода я делал всевозможные сокращения кода в плане простоты, так как это «мой стиль». Поэтому были заменены все огромные регулярные выражения (да и в них, кстати, всё равно было полно ненужного мусора), часть логики в функциях.
Так как проект необкатанный, то совершенно понятно, что в процессе будет найдено достаточное количество багов. Также уверен, что будут жалобы в сторону обработок ошибок в шаблонах (на данном этапе эта «функция» реализована плохо). Я буду только рад получать сообщения об улучшении кода, и по мере своих возможностей вносить как исправления, так и новые функции.
Примеры работы шаблонизатора:
compiler.js:
var NodeSmarty = require("./NodeSmarty/");
var Template = new NodeSmarty();
Template
.setTemplateDir("./templates/")
.setCompileDir("./compile/")
.setCacheDir("./cache/");
var Array = ["val1", "two"];
Template.assign({
"Value":"first",
"number":10,
"array":Array
});
var Final = Template.fetch("template.tpl", function(data) {
console.log(data);
});
template.tpl:
{include file="header.tpl.html"}
{$Value}
{$number*10/20}
{if !$Value}
//...
{elseif $number = $Value}
//...
{else}
//...
{/if}
{* comment *}
{literal}
for(var di=0; di < 10; di++) {
console.log(di);
}
{/literal}
{foreach from=$array item=Foo key=Key}
Item: {$Foo} key: {$Key}
{/foreach}
Скорость выполнения кода выше, чем у EJS и JUST. Происходит это из-за того, что при повторном запросе файла, вызывается не шаблон, а уже скомпилированный код. Но есть и еще один плюс (хотя его и нет, но будет в будущем) - повышение скорости выполнения также зависит от файловой системы (дада, сначала нужно проверить, не изменились ли шаблоны, перекомпилировать их). Если же компилировать файлы при первом запросе, а при последующих просто выгружать из памяти, то скорость соответственно увеличится, и время выполнения кода станет еще меньше!
Сравнение скорости выполнения кода при 1000 итераций:
Немножко о принципе работы.
Если шаблон изменен раньше, чем скомпилирован файл, то библиотека просто подгружает скомпилированный файл и подставляет в него значения. Если же шаблон изменен позже, то выполяются следующие инструкции:
Первым делом парсится документ на наличие открывающего тега: {
и закрывающего тега: }
(хотя можно и изменить по желанию, см документацию).
Потом каждый тег парсится на главный параметр и атрибуты. Главный параметр также проходит обработку и разбивается на 2 типа: команда или переменная. Переменная отличается от команды впередистоящим знаком доллара ($
). И переменная и команда проходят обработку для преобразования себя в рабочий JavaScript код. Скомпилированный код записывается в файл и происходит eval
текста (хотя там не eval, а new Function()
).
