В мире веб-разработки на языке Go работа с шаблонами html является одной из основных задач при создании динамических сайтов и приложений. Однако стандартный пакет html/template часто воспринимается как неудобный и громоздкий, особенно для тех, кто начинает новый проект. Именно поэтому многие разработчики ищут решения, упрощающие работу с шаблонами и добавляющие полезные функции для более гибкого использования. Одним из таких решений является библиотека tpl от dstpierre — компактная, но мощная надстройка над html/template, которая упрощает структуру, парсинг и рендеринг шаблонов, а также предоставляет встроенную поддержку международной локализации (i18n) и ряд удобных функций для шаблонов. Tpl позиционируется как легковесный и в то же время функциональный вспомогательный инструмент, который делает работу со структурированными шаблонами Go удобной и «терпимой».
Этот инструмент ориентирован на создание аккуратной архитектуры для шаблонов, позволяя значительно сократить рутинную работу, связанную с подключением блоков, вложенными шаблонами и передачей данных. Помимо этого, tpl предоставляет возможность переводов, что крайне важно для приложений с поддержкой нескольких языков, и дополняет внутреннюю карту функций (funcmap) рядом полезных хелперов. Одной из ключевых особенностей tpl является рекомендуемая структура директории шаблонов. Она предусматривает разделение шаблонов на несколько каталогов, что повышает читаемость и упрощает поддержку. Главный каталог templates включает подкаталоги emails, partials, translations и views.
Подкаталог emails служит для шаблонов писем, которые рендерятся без использования основной лайаут-структуры, что соответствует специфике рендеринга email-контента. Папка partials предназначена для повторно используемых фрагментов шаблонов, таких как навигационные панели или элементы списков. Все лайауты (layout) располагаются непосредственно в корне templates и включают блоки, которые динамически заполняются содержимым из представлений (views). В каталоге views каждый подкаталог соответствует конкретному лайауту, а внутри него размещаются отдельные представления для рендеринга. Такая логичная и строго организованная структура позволяет легко ориентироваться в шаблонах больших проектов.
Библиотека реализует функцию парсинга шаблонов, которая принимает файловую систему с шаблонами и при необходимости пользовательскую карту функций (funcmap). Это позволяет разработчику добавлять собственные функции и хелперы в шаблоны. Результатом парсинга является объект tpl.Template, который содержит методы для последующего рендеринга страниц и писем. Рендеринг производится по имени шаблона и данным, которые передаются шаблону в виде произвольной структуры.
Ранее требовалось оборачивать данные в специальную структуру tpl.PageData, но теперь это не обязательно, что облегчает интеграцию с существующим кодом. Структура tpl.PageData служит типичным контейнером для передачи данных в шаблоны и обладает удобным набором полей, включающим язык и локаль (Lang, Locale), временную зону, токен для защиты от CSRF атак, заголовок страницы, информацию о текущем пользователе, уведомления и дополнительные поля для расширенного использования. Эта структура значительно упрощает передачу необходимой информации в шаблоны и является отличной отправной точкой для создания собственных структур данных с учетом особенностей приложения.
Для уведомлений используется отдельный тип Notification с полями для заголовка, сообщения и флагами, указывающими тип уведомления (успех, ошибка или предупреждение). Это встроенное решение помогает быстро показывать пользователю сообщения об ошибках или успехах без дополнительных сложных настроек. Tpl также демонстрирует эффективный подход к международной локализации. В каталоге translations размещаются JSON-файлы с переводами, каждый файл соответствует одному языку и представляет собой массив объектов с ключами, переводами и, при необходимости, формами множественного числа. Для работы с переводами в шаблонах предусмотрены специальные функции t и tp, которые принимают язык и ключ перевода, а tp дополнительно принимает количество для определения формы перевода.
Это обеспечивает гибкую поддержку многоязычности прямо в шаблонах и позволяет избавить разработчиков от необходимости самостоятельно реализовывать сложные механизмы перевода. Дополнительные встроенные функции значительно расширяют возможности работы с шаблонами. Среди них есть map для создания словарей в шаблонах, iterate для итерации заданного количества раз, xsrf для генерации скрытого поля с CSRF токеном, cut для обрезки строк, default для подстановки значения по умолчанию если исходное значение nil или нулевое, filesize для форматирования размеров файлов, slugify для создания слагов из строк, intcomma для форматирования чисел с разделителями тысяч и naturaltime для отображения времени в удобном формате «несколько минут назад» и подобном. Такой набор позволяет делать шаблоны более выразительными и менее зацикленными на рутинном коде. Пример реализации рендеринга в реальном проекте показывает гибкость tpl.
В нем tpl.PageData встраивается в собственную структуру BackwardCompatPageData вместе с пользовательскими полями, что позволяет безболезненно интегрировать библиотеку в уже существующий код. Используется многоаргументная функция Render, которую можно вызывать с разным количеством параметров в зависимости от нужны: просто данные, данные с уведомлением или дополнительные параметры. Кроме того, в контекст запроса извлекается текущий пользователь, языковые настройки, и даже токен XSRF, что делает рендеринг полностью безопасности-ориентированным и удобным для веб-приложений. Tpl поддерживает не только рендеринг html страниц, но и шаблонов для email.
Для писем можно использовать отдельную структуру каталогов и шаблоны, которые не зависят от основного лайаута, что упрощает создание и поддержку почтовых шаблонов. Главное — убедиться, что все шаблоны подгружены с помощью функции Parse, после чего их можно использовать для генерации текста и HTML писем, передавая произвольные данные. Использование tpl в связке с функцией встроенного в Go пакет embed позволяет удобно собирать все шаблоны вместе с исполняемым файлом, обеспечивая простоту деплоя и надежность работы без внешних зависимостей. При этом для передачи собственных функций в шаблоны реализован механизм передачи funcmap, что позволяет расширять возможности шаблонов и создавать свои уникальные решения с минимальными усилиями. Одним из существенных плюсов tpl является то, что это open source проект с активной поддержкой, минималистичным, но мощным API и возможностью настройки под любой проект.
