Как использовать underscore.js в качестве движка шаблонов?


262

Я пытаюсь узнать о новых применениях JavaScript как серверного языка и как функционального языка. Несколько дней назад я слышал о node.js и Express Framework. Затем я увидел файл underscore.js как набор служебных функций. Я видел этот вопрос на stackoverflow . В нем говорится, что мы можем использовать underscore.js в качестве движка шаблонов. Кто-нибудь знает хорошие учебники о том, как использовать underscore.js для шаблонов, особенно для начинающих, у которых меньше опыта работы с продвинутым javascript. Спасибо


12
В защиту «Люка» улучшенная версия руководства, по крайней мере, еще в мае, не использовалась в расширенном режиме
Shanimal,

Я только что ответил на аналогичный вопрос, который также принесет пользу вашему вопросу. stackoverflow.com/questions/28136101/retrieve-column-in-parse/…
jeffdill2

Ответы:


475

Все, что вам нужно знать о шаблоне подчеркивания, здесь . Имейте в виду только 3 вещи:

  1. <% %> - выполнить некоторый код
  2. <%= %> - напечатать некоторое значение в шаблоне
  3. <%- %> - напечатать некоторые значения HTML, экранированные

Это все об этом.

Простой пример:

var tpl = _.template("<h1>Some text: <%= foo %></h1>");

тогда tpl({foo: "blahblah"})будет представлен в строку<h1>Some text: blahblah</h1>


55
Я не понимаю , почему кто - нибудь вниз голосование это, в канонический ответ и указывает на инструкции на странице проекта, это классический «Научи человека ловить рыбу».
Jon Z

1
Я думаю, что они проголосуют, потому что документация, которую они предоставляют, дает очень мало информации о том, как смешивать <% и <% = за пределами их единственного примера и как переключение с <% = на print () меняет этот шаблон. Также при использовании «интерполяции» есть некоторые странные варианты поведения, которые, вероятно, создают сцену с небольшим объяснением. Опять же, что не предусмотрено. Хотя я согласен, но это глупо, потому что голосование за.
QueueHammer

8
3. <% -%> - для печати некоторых значений с экранированием HTML
LeeGee

13
Я не понизил голос, но ваш ответ ничего не делает (кроме предложения ссылки), чтобы объяснить, как использовать underscore.js в качестве движка шаблонов. Ваш ответ обеспечивает быстрый «шпаргалка», возможно, для тех, кто уже получил его, но сам по себе это не ответ на вопрос. Я удивлен, что у него столько же голосов, сколько и у него.
Зак Лысобей

1
-1, документация несовершенна по многим параметрам. Почти наверняка, что пользователь пришел сюда после просмотра документов. Плохой ответ.
Мэтт Паркинс

199
<!-- Install jQuery and underscore -->

<script type="text/javascript" src="http://code.jquery.com/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="http://documentcloud.github.com/underscore/underscore-min.js"></script>

<!-- Create your template -->
<script type="foo/bar" id='usageList'>
<table cellspacing='0' cellpadding='0' border='1' >
    <thead>
      <tr>
        <th>Id</th>
        <th>Name</th>
      </tr>
    </thead>
    <tbody>
      <%
        // repeat items 
        _.each(items,function(item,key,list){
          // create variables
          var f = item.name.split("").shift().toLowerCase();
      %>
        <tr>
          <!-- use variables -->
          <td><%= key %></td>
          <td class="<%= f %>">
            <!-- use %- to inject un-sanitized user input (see 'Demo of XSS hack') -->
            <h3><%- item.name %></h3>
            <p><%- item.interests %></p>
          </td>
        </tr>
      <%
        });
      %>
    </tbody>
  </table>
</script>

<!-- Create your target -->

<div id="target"></div>

<!-- Write some code to fetch the data and apply template -->

<script type="text/javascript">
  var items = [
    {name:"Alexander", interests:"creating large empires"},
    {name:"Edward", interests:"ha.ckers.org <\nBGSOUND SRC=\"javascript:alert('XSS');\">"},
    {name:"..."},
    {name:"Yolando", interests:"working out"},
    {name:"Zachary", interests:"picking flowers for Angela"}
  ];
  var template = $("#usageList").html();
  $("#target").html(_.template(template,{items:items}));
</script>
  • JsFiddle Спасибо @PHearst!
  • JsFiddle (последняя версия )
  • Список JsFiddle, сгруппированный по первой букве (сложный пример с изображениями, вызовами функций, под-шаблонами). взрыв...
  • JsFiddle Демонстрация взлома XSS, замеченного @tarun_telang ниже
  • JsFiddle Один нестандартный метод для создания под-шаблонов

17
Спасибо за то, что вы явно использовали тег сценария "text / html" в вашем примере; Я новичок в underscore.js и, к несчастью, неправильно прочитал документацию - приятно знать, что templateString не всегда нужно записывать в строке.
aschyiel

Шаблон на самом деле не text/htmlговорит type="text/html", что ложь, ложь может вызвать проблемы. Вы бы лучше с точным типом, таким как text/x-underscore.
мю слишком коротка

6
Ну, я думаю, хорошо бы отметить, что это не имеет значения. давайте посмотрим правде в глаза, все, что вы ставите там ложь. text / x-underscore - большая ложь, потому что я использую lodash, lol :). В последнем добавленном JsFiddle я добавил, type="foo/bar"потому что хочу, чтобы все знали, что это не имеет значения, пока браузер / сервер не распознает его и не попытается сделать что-то с этим. Поскольку html не является типом сценария, я чувствую себя довольно безопасно с text / html (Джон Резиг использует его), foo / bar также работает :)
Shanimal

4
Люди все время со мной не согласны, я делаю все возможное, чтобы не воспринимать это лично (даже если это личное :). Я был сожжен непреднамеренными побочными эффектами незначительного разгильдяйства снова и снова, поэтому моя привычка - ошибаться на стороне строгости. Спецификации MIME-типов на самом деле резервируют */x-*типы для «готовых» применений, я не думаю, что text/underscoreв официальных реестрах есть тип, поэтому я использую его, text/x-underscoreпотому что я параноик, и они действительно хотят меня достать.
мю слишком коротка

1
пусть будет известно, что демоверсия XSS больше не работает, потому что браузеры отказываются выполнять JS с неверным
mimetype

94

В простейшей форме вы бы использовали его так:

var html = _.template('<li><%= name %></li>', { name: 'John Smith' });
//html is now '<li>John Smith</li>'   

Если вы собираетесь использовать шаблон несколько раз, вам нужно скомпилировать его, чтобы он работал быстрее:

var template = _.template('<li><%= name %></li>');

var html = [];
for (var key in names) {
    html += template({ name: names[i] });
}

console.log(html.join('')); //Outputs a string of <li> items

Я лично предпочитаю синтаксис усов. Вы можете настроить маркеры маркеров шаблона для использования двойных фигурных скобок:

_.templateSettings.interpolate = /\{\{(.+?)\}\}/g;

var template = _.template('<li>{{ name }}</li>');

Подсказка интерполяции усов помогла мне при использовании представления express3, которое визуализировалось с использованием ejs. Спасибо!
микроб

Чтобы использовать шаблоны из представления, в разметке страницы может быть указано следующее: <script type = "text / template" id = "my-template"> <div> <% - name%> </ div> </ script > а затем выполните следующие действия в вашем JS: var html = _.template ($ ('# my-template'). html (), {name: "John Smith"});
Гаурав Гупта

2
@evilcelery - ваш interpolateсовет не сработал, но это _.templateSettings = { interpolate: /\{\{\=(.+?)\}\}/g, escape: /\{\{\-(.+?)\}\}/g, evaluate: /\{\{(.+?)\}\}/g };
сработало

28

Документация для шаблонов является частичной, я наблюдал за источником.

Функция _.template имеет 3 аргумента:

  1. Текст строки : строка шаблона
  2. Данные объекта : данные оценки
  3. Настройки объекта : локальные настройки, _.templateSettings является объектом глобальных настроек

Если данные (или ноль) не заданы, будет возвращена функция рендеринга . У него есть 1 аргумент:

  1. Данные объекта : такие же, как данные выше

В настройках есть 3 шаблона регулярных выражений и 1 статический параметр:

  1. RegExp оценивать : "<% code%>" в строке шаблона
  2. RegExp interpolate : "<% = code%>" в строке шаблона
  3. РегВыр побег : "<% - код%>"
  4. Строковая переменная : необязательно, имя параметра данных в строке шаблона

Код в разделе оценки будет просто оценен. Вы можете добавить строку из этого раздела с помощью команды __p + = "mystring" в оцененный шаблон, но это не рекомендуется (не является частью интерфейса шаблонов), используйте вместо этого раздел интерполяции. Этот тип раздела предназначен для добавления блоков, таких как if или for, в шаблон.

Результат кода в разделе интерполяции будет добавлен в оцененный шаблон. Если ноль возвращен, будет добавлена ​​пустая строка.

Раздел escape экранирует html с помощью _.escape для возвращаемого значения данного кода. Таким образом, он похож на _.escape (код) в интерполированном разделе, но экранируется с \ пробельными символами, такими как \ n, прежде чем передать код в _.escape . Я не знаю, почему это так важно, это в коде, но он хорошо работает с интерполяцией и _.escape - который не экранирует символы пробела - тоже.

По умолчанию параметр data передается с помощью оператора with (data) {...} , но этот вид оценки намного медленнее, чем оценка с именованной переменной. Так называя данные с переменным параметром что - то хорошее ...

Например:

var html = _.template(
    "<pre>The \"<% __p+=_.escape(o.text) %>\" is the same<br />" +
        "as the  \"<%= _.escape(o.text) %>\" and the same<br />" +
        "as the \"<%- o.text %>\"</pre>",
    {
        text: "<b>some text</b> and \n it's a line break"
    },
    {
        variable: "o"
    }
);

$("body").html(html);

полученные результаты

The "<b>some text</b> and 
 it's a line break" is the same
as the "<b>some text</b> and 
 it's a line break" and the same
as the "<b>some text</b> and 
 it's a line break"

Вы можете найти здесь больше примеров того, как использовать шаблон и переопределить настройки по умолчанию: http://underscorejs.org/#template

При загрузке шаблона у вас есть много вариантов, но в конце вы всегда должны преобразовать шаблон в строку. Вы можете дать его в качестве обычной строки , как в примере выше, или вы можете загрузить его из тега сценария, и использовать .html () функция JQuery, или вы можете загрузить его из отдельного файла с TPL плагин из require.js ,

Еще один вариант построения дерева dom с лаконичным вместо шаблонизации.


21

Я привожу очень простой пример

1)

var data = {site:"mysite",name:"john",age:25};
var template = "Welcome you are at <%=site %>.This has been created by <%=name %> whose age is <%=age%>";
var parsedTemplate = _.template(template,data);
console.log(parsedTemplate); 

Результат будет

Welcome you are at mysite.This has been created by john whose age is 25.

2) Это шаблон

   <script type="text/template" id="template_1">
       <% _.each(items,function(item,key,arr) { %>
          <li>
             <span><%= key %></span>
             <span><%= item.name %></span>
             <span><%= item.type %></span>
           </li>
       <% }); %>
   </script>

Это HTML

<div>
  <ul id="list_2"></ul>
</div>

Это код javascript, который содержит объект json и помещает шаблон в html

   var items = [
       {
          name:"name1",
          type:"type1"
       },
       {
          name:"name1",
          type:"type1"
       },
       {
          name:"name1",
          type:"type1"
       },
       {
          name:"name1",
          type:"type1"
       },
       {
          name:"name1",
          type:"type1"
       } 
   ];
  $(document).ready(function(){
      var template = $("#template_1").html();
      $("#list_2").html(_.template(template,{items:items}));
  });


14

с экспресс это так просто. все, что вам нужно, это использовать модуль консолидации на узле, поэтому вам нужно установить его:

npm install consolidate --save

тогда вы должны изменить движок по умолчанию на HTML-шаблон следующим образом:

app.set('view engine', 'html');

зарегистрируйте механизм шаблонов подчеркивания для расширения html:

app.engine('html', require('consolidate').underscore);

это сделано !

Теперь для загрузки, например, шаблон с именем «index.html»:

res.render('index', { title : 'my first page'});

возможно вам нужно будет установить модуль подчеркивания.

npm install underscore --save

Я надеюсь, что это помогло вам!


12

Я хотел бы поделиться еще одним важным открытием.

использование <% = variable => может привести к уязвимости межсайтового скриптинга. Поэтому безопаснее использовать <% - variable ->.

Нам пришлось заменить <% = на <% - чтобы предотвратить атаки межсайтовых скриптов. Не уверен, повлияет ли это на производительность


2
+1 Я добавил заметку о XSS к своему примеру. Это действительно хороший момент для введения неанизированной пользовательской информации в веб-страницу. либо через шаблонизатор, либо даже через $ .html ().
Shanimal

1

Лодаш тоже тот же. Сначала напишите сценарий следующим образом:

<script type="text/template" id="genTable">
<table cellspacing='0' cellpadding='0' border='1'>
        <tr>
            <% for(var prop in users[0]){%>
            <th><%= prop %> </th>
            <% }%>
        </tr>
        <%_.forEach(users, function(user) { %>
            <tr>
                 <% for(var prop in user){%>
                    <td><%= user[prop] %> </td>
                <% }%>

            </tr>
        <%})%>
</table>

Теперь напишите несколько простых JS следующим образом:

var arrOfObjects = [];
for (var s = 0; s < 10; s++) {
    var simpleObject = {};
    simpleObject.Name = "Name_" + s;
    simpleObject.Address = "Address_" + s;
    arrOfObjects[s] = simpleObject;
}
var theObject = { 'users': arrOfObjects }
var compiled = _.template($("#genTable").text());
var sigma = compiled({ 'users': myArr });

$(sigma).appendTo("#popup");

Где popoup - это div, где вы хотите создать таблицу

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.