Есть ли лучшая практика для генерации HTML с помощью JavaScript - PullRequest
Новая
       45

Есть ли лучшая практика для генерации HTML с помощью JavaScript

95 голосов
/ 21 октября 2008

Я вызываю веб-сервис, который возвращает массив объектов в формате JSON. Я хочу взять эти объекты и заполнить div с HTML. Допустим, каждый объект содержит URL-адрес и имя.

Если я хочу сгенерировать следующий HTML для каждого объекта: 

<div><img src="the url" />the name</div>

Есть ли лучшая практика для этого? Я вижу несколько способов сделать это:

  1. Объединенные строки
  2. Создание элементов
  3. Использовать шаблонный плагин
  4. Создайте html на сервере, затем подайте его через JSON.

Ответы [ 8 ]

64 голосов
/ 21 октября 2008

Опции # 1 и # 2 станут вашими самыми непосредственными прямыми опциями, однако для обоих вариантов вы почувствуете влияние на производительность и обслуживание, создавая строки или создавая объекты DOM.

Шаблонирование не так уж и незрело, и вы видите его всплывающим в большинстве основных структур Javascript.

Вот пример в шаблонном плагине JQuery , который спасет вас от снижения производительности и действительно очень прост: 

var t = $.template('<div><img src="${url}" />${name}</div>');

$(selector).append( t , {
     url: jsonObj.url,
     name: jsonObj.name
});

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

13 голосов
/ 20 ноября 2008

Если вам абсолютно необходимо объединить строки вместо обычных: 

var s="";
for (var i=0; i < 200; ++i) {s += "testing"; }

использовать временный массив: 

var s=[];
for (var i=0; i < 200; ++i) { s.push("testing"); }
s = s.join("");

Использование массивов намного быстрее, особенно в IE. Некоторое время назад я проводил тестирование со строками в IE7, Opera и FF. Opera выполнила тест всего за 0,4 секунды, но IE7 не закончил через 20 МИНУТ !!!! (Нет, я не шучу.) С массивом IE было очень быстро.

8 голосов
/ 21 октября 2008

Любой из первых двух вариантов является общим и приемлемым.

Я приведу примеры каждого из них в Прототип . 

// assuming JSON looks like this:
// { 'src': 'foo/bar.jpg', 'name': 'Lorem ipsum' }

Подход № 1: 

var html = "<div><img src='#{src}' /> #{name}</div>".interpolate(json);
$('container').insert(html); // inserts at bottom

Подход № 2: 

var div = new Element('div');
div.insert( new Element('img', { src: json.src }) );
div.insert(" " + json.name);
$('container').insert(div); // inserts at bottom
6 голосов
/ 15 мая 2014

Возможно, более современный подход заключается в использовании языка шаблонов, такого как Усы , который имеет реализации на многих языках, включая javascript. Например: 

var view = {
  url: "/hello",
  name: function () {
    return 'Jo' + 'hn';
  }
};

var output = Mustache.render('<div><img src="{{url}}" />{{name}}</div>', view);

Вы даже получаете дополнительное преимущество - вы можете повторно использовать те же шаблоны в других местах, например на стороне сервера.

Если вам нужны более сложные шаблоны (если операторы, циклы и т. Д.), Вы можете использовать Handlebars , который имеет больше функций и совместим с усами.

6 голосов
/ 21 октября 2008

Вот пример использования моего Простых шаблонов плагина для jQuery: 

var tmpl = '<div class="#{classname}">#{content}</div>';
var vals = {
    classname : 'my-class',
    content   : 'This is my content.'
};
var html = $.tmpl(tmpl, vals);
4 голосов
/ 22 октября 2008

Вы можете добавить шаблон HTML на свою страницу в скрытом div, а затем использовать cloneNode и средства запросов вашей любимой библиотеки, чтобы заполнить его 

/* CSS */
.template {display:none;}

<!--HTML-->
<div class="template">
  <div class="container">
    <h1></h1>
    <img src="" alt="" />
  </div>
</div>

/*Javascript (using Prototype)*/
var copy = $$(".template .container")[0].cloneNode(true);
myElement.appendChild(copy);
$(copy).select("h1").each(function(e) {/*do stuff to h1*/})
$(copy).select("img").each(function(e) {/*do stuff to img*/})
3 голосов
/ 03 апреля 2015

Раскрытие информации: я ведущий BOB.

Существует библиотека javascript, которая значительно упрощает этот процесс и называется BOB .

Для вашего конкретного примера: 

<div><img src="the url" />the name</div>

Это может быть сгенерировано с помощью BOB с помощью следующего кода. 

new BOB("div").insert("img",{"src":"the url"}).up().content("the name").toString()
//=> "<div><img src="the url" />the name</div>"

Или с более коротким синтаксисом 

new BOB("div").i("img",{"src":"the url"}).up().co("the name").s()
//=> "<div><img src="the url" />the name</div>"

Эта библиотека довольно мощная и может использоваться для создания очень сложных структур с вставкой данных (аналогично d3), например ::

data = [1,2,3,4,5,6,7]
new BOB("div").i("ul#count").do(data).i("li.number").co(BOB.d).up().up().a("a",{"href": "www.google.com"}).s()
//=> "<div><ul id="count"><li class="number">1</li><li class="number">2</li><li class="number">3</li><li class="number">4</li><li class="number">5</li><li class="number">6</li><li class="number">7</li></ul></div><a href="www.google.com"></a>"

В настоящее время BOB не поддерживает внедрение данных в DOM. Это на Todolist. Сейчас вы можете просто использовать вывод вместе с обычным JS или jQuery и поместить его куда хотите. 

document.getElementById("parent").innerHTML = new BOB("div").insert("img",{"src":"the url"}).up().content("the name").s();
//Or jquery:
$("#parent").append(new BOB("div").insert("img",{"src":"the url"}).up().content("the name").s());

Я создал эту библиотеку, потому что меня не порадовали никакие альтернативы, такие как jquery и d3. Код очень сложный и трудный для чтения. Работа с BOB, на мой взгляд, явно предвзята, намного приятнее.

BOB доступен на Bower , так что вы можете получить его, набрав bower install BOB.

1 голос
/ 15 мая 2014

Есть ли лучшая практика для этого? Я вижу несколько способов сделать это:

  1. Объединенные строки
  2. Создание элементов
  3. Используйте плагин для шаблонов
  4. Создайте html на сервере, затем подайте его через JSON.

1) Это опция. Создайте HTML-код с помощью JavaScript на стороне клиента, а затем вставьте его в DOM в целом.

Обратите внимание, что за этим подходом стоит парадигма: сервер выводит только данные и (в случае взаимодействия) получает данные от клиента асинхронно с запросами AJAX. Код на стороне клиента работает как автономное веб-приложение JavaScript.

Веб-приложение может работать, отображать интерфейс, даже если сервер не работает (конечно, оно не будет отображать какие-либо данные или предлагать какое-либо взаимодействие).

Эта парадигма в последнее время часто используется, и вокруг этого подхода строятся целые фреймворки (например, смотрите backbone.js).

2) По соображениям производительности, когда это возможно, лучше встроить html в строку, а затем внедрить ее целиком в страницу.

3) Это еще один вариант, а также принятие платформы веб-приложений. Другие пользователи опубликовали различные доступные движки шаблонов. У меня сложилось впечатление, что у вас есть навыки, чтобы оценить их и решить, следует ли идти по этому пути или нет.

4) Другой вариант. Но подайте это как простой текст / html; почему JSON? Мне не нравится этот подход, потому что смешивает PHP (ваш серверный язык) с Html. Но я часто принимаю это как разумный компромисс между вариантами 1 и 4 .

Мой ответ: вы уже смотрите в правильном направлении.

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

Только мое мнение, основанное на моем опыте ...

...