Соковыжималка китайская Документация-JavaScript на оптоволокне

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

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

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

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

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

Если мы сравним данные со свежими и вкусными фруктами и представим шаблон как воду, 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);

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

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

> Пользовательский шаблонный граничный символ синтаксиса, ниже - граничный символ по умолчанию для соковыжималки. Это можно использовать для разрешения ситуаций, когда синтаксис шаблона 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]
}

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

Параметр за изменением параметра:

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

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

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

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

* Грамматика

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

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

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
{# 这里是注释内容}

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

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

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

е. Вложенность суб-шаблона {@include tpl, data}

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

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
43HTML 代码:

<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);

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

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

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

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