Соковыжималка Китайский документ-JavaScript на волокне

Соковыжималка китайский документ

Текущая последняя версия: 0.6.14

Juicer - это эффективный и легкий интерфейсный шаблонизатор (Javascript). Использование Juicer может стать вашим кодом для разделения данных и модели представления (MVC). Кроме того, он также может работать в среде Node.js.

Вы можете свободно использовать и распространять его при условии соблюдения лицензии MIT. Код Juicer полностью открыт и размещен на Github . Если вы обнаружите какие-либо ошибки или хорошие предложения в процессе его использования, вы можете отправить его на Github Issue .

происхождение имени

Если мы сравниваем данные со свежими и вкусными фруктами и рассматриваем шаблоны как воду, Juicer - это соковыжималка, которая выжимает фрукты и воду из необходимых нам фрагментов HTML-кода.

Введение соковыжималки

1
<script type="text/javascript" src="juicer-min.js></script>

* Инструкции

> Скомпилируйте шаблон и сразу визуализируйте результат на основе заданных данных.

1
juicer(tpl, data);

> Только скомпилированный шаблон не будет отображаться, он вернет скомпилированную функцию многократного использования.

1
var compiled_tpl = juicer(tpl);

> Выполните рендеринг данных по ранее скомпилированному шаблону в соответствии с заданными данными.

1
2
var compiled_tpl = juicer(tpl);
var html = compiled_tpl.render(data);

> Зарегистрируйте / отмените регистрацию пользовательских функций (объектов), примеры в $ {переменных} будут ниже.

1
2
juicer.register('function_name', function);
juicer.unregister('function_name');

> Пользовательский символ границы синтаксиса шаблона, ниже - символ границы по умолчанию для Juicer. Вы можете использовать это, чтобы разрешить конфликт между синтаксисом шаблона Juicer и синтаксисом шаблона некоторого внутреннего языка.

1
2
3
4
5
6
7
8
9
10
juicer.set({
    'tag::operationOpen': '{@',
    'tag::operationClose': '}',
    'tag::interpolateOpen': '${',
    'tag::interpolateClose': '}',
    'tag::noneencodeOpen': '$${',
    'tag::noneencodeClose': '}',
    'tag::commentOpen': '{#',
    'tag::commentClose': '}'
});

Конфигурация параметров по умолчанию

1
2
3
4
5
6
{
    cache:          true [false],
    strip:          true [false],
    errorhandling:  true [false],
    detection:      true [false]
}

Соковыжималка рекомендует использовать конфигурацию по умолчанию. Если вам действительно нужно изменить эти параметры во время использования, вы можете сделать следующее:

Измените параметры по одному:

1
2
juicer.set('strip',false);
juicer.set('cache',false);

Изменения параметров пакета:

1
2
3
4
juicer.set({
    'strip': false,
    'cache': false
};

По умолчанию Juicer кэширует скомпилированный шаблон, чтобы избежать времени, затрачиваемого на повторную компиляцию, когда один и тот же шаблон обрабатывается несколько раз. Если в этом нет особой необходимости, настоятельно рекомендуется не отключать кеш в параметрах по умолчанию. Это сделает кеш соковыжималки недействительным, что снизит производительность.

* грамматика

а. $ {переменные}

Использование значения ${}выходной переменной, которое _является ссылкой на источник данных (например ${_}, как обычно используется в случае, когда используется массив источника данных). Поддержка настраиваемых функций (с помощью настраиваемых функций можно реализовать множество интересных функций, аналогично с помощью которых ${data|links}вы можете направлять данные, собранные с помощью ранее определенных ссылок на настраиваемые функции <a href=".." alt=".." />).

1
2
3
${name}
${name|function}
${name|function, arg1, arg2}

Давайте продемонстрируем прекрасное использование пользовательских функций на примере.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var json = {
    links: [
        {href: 'http://juicer.name', alt: 'Juicer'},
        {href: 'http://benben.cc', alt: 'Benben'},
        {href: 'http://ued.taobao.com', alt: 'Taobao UED'}
    ]
};

var tpl = [
    '{@each links as item}',
        '${item|links_build} <br />',
    '{@/each}'
].join('');

var links = function(data) {
    return '<a href="' + data.href + '" alt="' + data.alt + '" />';
};

juicer.register ('links_build', links); // Регистрируем пользовательскую функцию juicer (tpl, json);

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

1
2
3
&lt;a href=&quot;http://juicer.name&quot; alt=&quot;Juicer&quot; <br />
&lt;a href=&quot;http://benben.cc&quot; alt=&quot;Benben&quot; <br />
&lt;a href=&quot;http://ued.taobao.com&quot; alt=&quot;Taobao UED&quot; <br />

Видно, что результат экранирован. Если мы воспользуемся $$ {item | links} выше, мы получим ожидаемый результат, а именно избежание экранирования, упомянутого ниже.

Побег / Как избежать побега

В целях безопасности ${变量}он будет экранировать свое содержимое перед выводом, если вы не хотите, чтобы вывод экранировался, вы можете использовать, $${变量}чтобы избежать этой ситуации. Например:

1
2
3
4
5
6
7
8
9
var json = {
    value: '&lt;strong&gt;juicer&lt;/strong&gt;'
};

var escape_tpl='${value}';
var unescape_tpl='$${value}';

juicer(escape_tpl, json); //输出 '&lt;strong&gt;juicer&lt;/strong&gt;'
juicer(unescape_tpl, json); //输出 '<strong>juicer</strong>'

б. Обход цикла {@each} ... {@ / each}

Если вам нужно перебрать массив, вы можете использовать его следующим образом each.

1
2
3
{@each list as item}
    ${item.prop}
{@/each}

Это также очень удобно, если вы хотите получить текущее значение индекса в процессе обхода.

1
2
3
4
{@each list as item, index}
    ${item.prop}
    ${index} //当前索引
{@/each}

c. Суждение {@if} ... {@else if} ... {@else} ... {@ / if}

Мы также часто сталкиваемся с этим при логических суждениях о данных.

1
2
3
4
5
6
7
8
9
{@each list as item,index}
    {@if index===3}
        the index is 3, the value is ${item.prop}
    {@else if index === 4}
        the index is 4, the value is ${item.prop}
    {@else}
        the index is not 3, the value is ${item.prop}
    {@/if}
{@/each}

г. Комментарий {# Содержание комментария}

Для удобства сопровождения и удобства чтения последующего кода мы можем добавить комментарии к шаблону.

1
{# 这里是注释内容}

д. Вспомогательный цикл {@ каждый i в диапазоне (m, n)}

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

1
2
3
{@each i in range(5, 10)}
    ${i}; //输出 5;6;7;8;9;
{@/each}

е. Вложение подшаблона {@include tpl, data}

Вложение подшаблонов позволяет более гибко организовать код шаблона.Помимо импорта подшаблонов, указанных в данных, вы также можете #idиспользовать scriptкод шаблона, записанный в тегах , указав строки .

HTML код:

1
2
3
<script type="text/juicer" id="subTpl">
    I'm sub content, ${name}
</script>

Код Javascript:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
var tpl = 'Hi, {@include "#subTpl", subData}, End.';

juicer(tpl, {
    subData: {
        name: 'juicer'
    }
});

//输出 Hi, I'm sub content, juicer, End.
//或者通过数据引入子模板，下述代码也将会有相同的渲染结果：

var tpl = 'Hi, {@include subTpl, subData}, End.';

juicer(tpl, {
    subTpl: "I'm sub content, ${name}",
    subData: {
        name: 'juicer'
    }
});

* Запуск в среде Node.js

1
2
3
4
5
6
在命令行中执行:
npm install juicer

在代码中这么引入:
var juicer = require('juicer');
var html = juicer(tpl, data);

Использование в платформе Express.js

В версии серии Express 2.x:

1
2
3
4
5
6
7
8npm install juicer
var juicer = require('juicer');
app.set('view engine', 'html');
app.register('.html', {
    compile: function(str, options) {
        return juicer.compile(str, options).render;
    }
});

В версии серии Express 3.x:

1
2
3
4
5
6
7
8
9
10
11npm install juicer
var juicer = require('juicer');
var fs = require('fs');
app.set('view engine', 'html');
app.engine('html', function(path, options, fn){
    fs.readFile(path, 'utf8', function(err, str){
        if (err) return fn(err);
        str = juicer(str, options);
        fn(null, str);
    });
});

В версии серии Express 4.x:

1
2
3
var juicerExpressAdapter = require('juicer-express-adapter');
app.set('view engine', 'html');
app.engine('html', juicerExpressAdapter);

Предварительно скомпилируйте файлы шаблона в командной строке:

1
2
3
4
5
npm install -g juicer
juicer example.juicer.tmpl -f example.js

// type `juicer` after install for more help.
// 全局模式安装 `juicer` 后，在命令行下输入 `juicer` 可以获得更多帮助信息。

Настройте внешнее хранилище кэша для механизма шаблонов:

1
2
3
4
5
var juicer = require('juicer');
var LRUCache = require('lru-native');
var cache = new LRUCache({ maxElements: 1000 });

juicer.set('cachestore', cache);

* Полный пример

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
HTML 代码:

<script id="tpl" type="text/template">
    <ul>
        {@each list as it,index}
            <li>${it.name} (index: ${index})</li>
        {@/each}
        {@each blah as it}
            <li>
                num: ${it.num} <br />
                {@if it.num==3}
                    {@each it.inner as it2}
                        ${it2.time} <br />
                    {@/each}
                {@/if}
            </li>
        {@/each}
    </ul>
</script>

Javascript 代码:

var data = {
    list: [
        {name:' guokai', show: true},
        {name:' benben', show: false},
        {name:' dierbaby', show: true}
    ],
    blah: [
        {num: 1},
        {num: 2},
        {num: 3, inner:[
            {'time': '15:00'},
            {'time': '16:00'},
            {'time': '17:00'},
            {'time': '18:00'}
        ]},
        {num: 4}
    ]
};

var tpl = document.getElementById('tpl').innerHTML;
var html = juicer(tpl, data);

Руководство по развитию

Базовый модуль

Встроенные объекты

Модуль сообщества