Juicer 中国語ドキュメント - ファイバー上の JavaScript

ジューサー中国語ドキュメント

現在の最新バージョン: 0.6.14

Juicer は効率的で軽量なフロントエンド (Javascript) テンプレートエンジンです。Juicer を使用すると、データとビューモデル (MVC) の分離を実現するコードになります。また、Node.js環境でも実行できます。

MIT Licenceを遵守することを前提に、自由に使用・配布していただいてかまいません。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);

> カスタム関数 (オブジェクト) を登録/登録解除します。以下の ${variables} に例があります。

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]
}

デフォルト設定は、Juicer が推奨する使用方法です。使用中にこれらのパラメータを本当に変更する必要がある場合は、次のようにします。

パラメータを 1 つずつ変更します。

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

バッチパラメータの変更:

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

デフォルトでは、Juicer はコンパイル済みテンプレートをキャッシュして、同じテンプレートが複数回レンダリングされたときにコンパイルを繰り返すことで消費される時間を回避します.特別な必要がない場合は、デフォルトのパラメータでキャッシュをオフにしないことを強くお勧めします。 Juicer キャッシュを無効にするため、パフォーマンスが低下します。

* 文法

a. ${変数}

データソースへの参照${}である出力変数値の使用_(たとえば${_}、データソース配列の場合に一般的に使用される)。カスタム関数のサポート (カスタム関数は、${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 + '" />';
};

Jucer.register('links_build', Links); // カスタム関数を登録 Jucer(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>'

b. ループトラバーサル {@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}

d. コメント {#コメント内容}

後続のコードの保守性と読みやすさのために、テンプレートにコメントを追加できます。

1
{# 这里是注释内容}

e. 補助ループ {@each i in range(m, n)}

補助ループは、Juicer によって慎重に設定された構文糖衣であり、特定の状況で必要になる場合があります。

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

f. サブテンプレートのネスト {@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);

開発ガイド

基本モジュール

組み込みオブジェクト

コミュニティモジュール

ジューサー中国語ドキュメント

名前の由来

ジューサーの紹介

* 指示

デフォルトのパラメータ構成

パラメータを 1 つずつ変更します。

バッチパラメータの変更:

* 文法

a. ${変数}

b. ループトラバーサル {@each} ... {@/each}

c. 判断 {@if} ... {@else if} ... {@else} ... {@/if}

d. コメント {#コメント内容}

e. 補助ループ {@each i in range(m, n)}

f. サブテンプレートのネスト {@include tpl, data}

* Node.js環境で実行

Express.js フレームワークで使用

* 完全な例

開発ガイド

基本モジュール

組み込みオブジェクト

コミュニティモジュール

ジューサー中国語ドキュメント

名前の由来

ジューサーの紹介

* 指示

デフォルトのパラメータ構成

パラメータを 1 つずつ変更します。

バッチ パラメータの変更:

* 文法

a. ${変数}

b. ループ トラバーサル {@each} ... {@/each}

c. 判断 {@if} ... {@else if} ... {@else} ... {@/if}

d. コメント {#コメント内容}

e. 補助ループ {@each i in range(m, n)}

f. サブテンプレートのネスト {@include tpl, data}

* Node.js環境で実行

Express.js フレームワークで使用

* 完全な例

バッチパラメータの変更:

b. ループトラバーサル {@each} ... {@/each}