swig模板引擎快速入门教程（nodejs环境）

swig的简单介绍

swig是JS模板引擎，它有如下特点：

支持大多数主流浏览器。
表达式兼容性好。
面向对象的模板继承。
将过滤器和转换应用到模板中的输出。
可根据路劲渲染页面。
支持页面复用。
支持动态页面。
可扩展、可定制。

一. swig的安装

swig作者在npm上更新不在从老版本的页面更新了，所以有二个链接安装，都要注意的，看自己环境需求安装（语法一样）

npm install swig --save 这是老版本包的安装

npm install swig-templates --save 这是新版本包的安装

二.和express框架集成

app.js页面内容

var express = require('express');
var app = express();
var swig  = require('swig-templates'); // 模板引擎-新版本
app.use(express.static('public')); // 静态页面路径

//设置swig页面不缓存
swig.setDefaults({
  cache: false
})
app.set('view cache', false);

app.set('views','./views/pages/'); // 查找模板目录,默认是在根目录 views/下
app.set('view engine','html'); // 识别到html文件的时候,就启动engine函数()模板引擎
app.engine('html', swig.renderFile); // 启用swig模板引擎,渲染页

//index page
app.get('/',function(req, res){
    // 渲染的页面index.html（路径默认是在/views/目录下查找）,后面是传入渲染数据
    res.render('index',{
    pagename: 'awesome people',
    authors: ['Paul', 'Jim', 'Jane'],
    index: '主页'
  })
})

var server = app.listen(8081, function () {
  console.log("应用实例，访问地址为 http://localhost:8081/")

})

var express = require('express');

var app = express();

var swig = require('swig-templates'); // 模板引擎-新版本

app.use(express.static('public')); // 静态页面路径

//设置swig页面不缓存

swig.setDefaults({

cache: false

})

app.set('view cache', false);

app.set('views','./views/pages/'); // 查找模板目录,默认是在根目录 views/下

app.set('view engine','html'); // 识别到html文件的时候,就启动engine函数()模板引擎

app.engine('html', swig.renderFile); // 启用swig模板引擎,渲染页

//index page

app.get('/',function(req, res){

// 渲染的页面index.html（路径默认是在/views/目录下查找）,后面是传入渲染数据

res.render('index',{

pagename: 'awesome people',

authors: ['Paul', 'Jim', 'Jane'],

index: '主页'

})

var server = app.listen(8081, function () {

console.log("应用实例，访问地址为 http://localhost:8081/")

})

index.html页面内容（相关html模板语法后面在详细介绍）

<!-- 加载其它模板文件 -->  这是index.html页面
{% extends 'layout.html' %}
<!-- 定义title区域块 -->
{% block title %}
<!-- 读取index变量内容 -->
{{ index|title }}
{% endblock %}

<!-- 定义head区域块 -->
{% block head %}
<link rel="stylesheet" href="styles/index.css">
{% endblock %}
<!-- 定义content区域块 -->
{% block content %}
<!-- 读取pagename变量的内容 -->
<h1>{{ pagename|title }}</h1>
<ul>
<!-- 循环变量authors -->
{% for author in authors %}
<p{% if loop.first %} class="first"{% endif %}>{{ author }}</p>
{% endfor %}
</ul>
{% endblock %}

这是index.html页面

{% extends 'layout.html' %}

{% block title %}

{% endblock %}

{% block head %}

{% endblock %}

{% block content %}

<h1>{{ pagename|title }}</h1>

<ul>

{% for author in authors %}

<p{% if loop.first %} class="first"{% endif %}>{{ author }}</p>

{% endfor %}

</ul>

{% endblock %}

layout.html页面内容（通用模块给各子模板使用）

//这块区域是layout.html页面
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>{% block title %} {% endblock %}</title>
<meta http-equiv="X-UA-Compatible" content="IE=7">
<!-- 被载入的模板调用父级的区域块,显示到指定位置去 -->
{% block head %}
{% endblock %}
</head>
<body>
{% block content %}{% endblock %}
</body>
</html>

//这块区域是layout.html页面

<!DOCTYPE html>

<head>

<title>{% block title %} {% endblock %}</title>

{% block head %}

{% endblock %}

</head>

<body>

{% block content %}{% endblock %}

</body>

</html>

引入的CSS文件就简单写了一下

p {
 color: red;
}
h1 {
  color: aquamarine;
}

p {

color: red;

}

h1 {

color: aquamarine;

}

然后测试运行

node app.js

1	node app.js

在浏览器输入：http://localhost:8081/, 执行效果如下

三.基本用法

1.变量

{{ foo.bar }}
{{ foo['bar'] }}

1 2	{{ foo.bar }} {{ foo['bar'] }}

这里需要注意的是前后两端都要有空格，这样{{name}}写就会报错

如果变量未定义，输出空字符。

变量可以通过过滤器来修改：

{{ name|title }} was born on {{ birthday|date('F jS, Y') }}
// Jane was born on July 6th, 1985

1 2	{{ name\|title }} was born on {{ birthday\|date('F jS, Y') }} // Jane was born on July 6th, 1985

2.空白

模板里的空白在最终输出时默认保留，如果需要去掉空白，可以在逻辑标签前后加上空白控制服-：

{% for item in seq -%}
    {{ item }}
{%- endfor %}

{% for item in seq -%}

{%- endfor %}

3.模板继承

Swig 使用 extends 和 block 来实现模板继承 layout.html

首先我们定义一个模板

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{% block title %}{% endblock  %}</title>
    {% block head %}{% endblock  %}
</head>
<body>
    {% block content %}{% endblock  %}
</body>
</html>

<!DOCTYPE html>

<head>

<title>{% block title %}{% endblock %}</title>

{% block head %}{% endblock %}

</head>

<body>

{% block content %}{% endblock %}

</body>

</html>

这个模板里面我们定义了三个block块，子模板可以对这三个block继承

然后我们写一个index.html页面，在继承layout.html这个模板

{% extends './layout.html' %}
{% block title %} index {% endblock %}
{% block content %}
    <div>
            <h1>hello swig</h1>
     <div>
{% endblock %}

{% extends './layout.html' %}

{% block title %} index {% endblock %}

{% block content %}

<div>

<h1>hello swig</h1>

<div>

{% endblock %}

注意我这里并没有复写{% block head %}{% endblock %}这个块

也就是说我们可以在layout.html模板页面里面定义很多block，而子页面可以有选择性的实现。

4.include模板

包含一个模板到当前位置，这个模板将使用当前上下文

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{% block title %}{% endblock  %}</title>
    {% include "./includes/head.html" %}
    {% block head %}{% endblock  %}
</head>
<body>
    {% include "./includes/header.html" %}
    {% block content %}{% endblock  %}
</body>
</html>

<!DOCTYPE html>

<head>

<title>{% block title %}{% endblock %}</title>

{% include "./includes/head.html" %}

{% block head %}{% endblock %}

</head>

<body>

{% include "./includes/header.html" %}

{% block content %}{% endblock %}

</body>

</html>

5.if判断

{% if name === '郭靖' %}
  hello 靖哥哥
{% endif %}

{% if name === '郭靖' %}

hello 靖哥哥

{% endif %}

6.if-else判断

{% if name === '郭靖' %}
  hello 靖哥哥
{% elseif name === '黄蓉' %}
  hello 蓉妹妹
{% else %}
  hello 欧阳峰
{% endif %}

{% if name === '郭靖' %}

hello 靖哥哥

{% elseif name === '黄蓉' %}

hello 蓉妹妹

{% else %}

hello 欧阳峰

{% endif %}

7.for循环

先上栗子：

// arr = [1, 2, 3]
{% for key, val in arr %}
  <p>{ { key } } -- { { val } }</p>
{% endfor %}

// arr = [1, 2, 3]

{% for key, val in arr %}

{% endfor %}

for循环内置变量：

loop.index：当前循环的索引（1开始）

loop.index0：当前循环的索引（0开始）

loop.revindex：当前循环从结尾开始的索引（1开始）

loop.revindex0：当前循环从结尾开始的索引（0开始）

loop.key：如果迭代是对象，是当前循环的键，否则同 loop.index

loop.first：如果是第一个值返回 true

loop.last：如果是最后一个值返回 true

loop.cycle：一个帮助函数，以指定的参数作为周期

使用方法：

// arr = [1, 2, 3]
{% for key, val in arr %}
  <p>{{ loop.index }} -- {{ key }} -- {{ val }}</p>
{% endfor %}

// arr = [1, 2, 3]

{% for key, val in arr %}

<p>{{ loop.index }} -- {{ key }} -- {{ val }}</p>

{% endfor %}

8.变量过滤器(强大的内置过滤器)

用于修改变量。变量名称后用 | 字符分隔添加过滤器。您可以添加多个过滤器。

8.1、例子

{{ name|title }} was born on {{ birthday|date('F jS, Y') }}
and has {{ bikes|length|default("zero") }} bikes.

{{ name|title }} was born on {{ birthday|date('F jS, Y') }}

and has {{ bikes|length|default("zero") }} bikes.

也可以使用 filter 标签来为块内容添加过滤器

{% filter upper %}oh hi, paul{% endfilter %}

1 2	{% filter upper %}oh hi, paul{% endfilter %}

8.2、内置过滤器

add(value)：使变量与value相加，可以转换为数值字符串会自动转换为数值。
addslashes：用 \ 转义字符串
capitalize：大写首字母
date(format[, tzOffset])：转换日期为指定格式例如: {{ name|date('Y年m月d日 H:i:s') }}
format：格式
tzOffset：时区
default(value)：默认值（如果变量为undefined，null，false）
escape([type])：转义字符
- 默认： &, <, >, ", '
- js: &, <, >, ", ', =, -, ;
first：返回数组第一个值
join(glue)：同[].join
json_encode([indent])：类似JSON.stringify, indent为缩进空格数
last：返回数组最后一个值
length：返回变量的length，如果是object，返回key的数量
lower：同''.toLowerCase()
raw：指定输入不会被转义
replace(search, replace[, flags])：同''.replace
reverse：翻转数组
striptags：去除html/xml标签
title：大写首字母
uniq：数组去重
upper：同''.toUpperCase
url_encode：同encodeURIComponent
url_decode：同decodeURIComponemt

8.3自定义过滤器

创建一个 myfilter.js 然后引入到 Swig 的初始化函数中

swig.init({ filters: require('myfilters') });

1	swig.init({ filters: require('myfilters') });

在 myfilter.js 里，每一个 filter 方法都是一个简单的 js 方法，下例是一个翻转字符串的 filter：

exports.myfilter = function (input) {
    return input.toString().split('').reverse().join('');
};

exports.myfilter = function (input) {

return input.toString().split('').reverse().join('');

};

你的 filter 一旦被引入，你就可以向下面一样使用：

{{ name|myfilter }}
     {% filter myfilter %}
    I shall be filtered
{% endfilter %}

{% filter myfilter %}

I shall be filtered

{% endfilter %}

你也可以像下面一样给 filter 传参数：

exports.prefix = function(input, prefix) {
    return prefix.toString() + input.toString();
};
{{ name|prefix('my prefix') }}
{% filter prefix 'my prefix' %I will be prefixed with "my prefix".{% endfilter %}
{% filter prefix foo %}I will be prefixed with the value stored to `foo`.{% endfilter %}

exports.prefix = function(input, prefix) {

return prefix.toString() + input.toString();

};

{% filter prefix 'my prefix' %I will be prefixed with "my prefix".{% endfilter %}

{% filter prefix foo %}I will be prefixed with the value stored to `foo`.{% endfilter %}

9.set命令

用来设置一个变量，在当前上下文中复用

{% set foo = [0, 1, 2, 3, 4, 5] %}
 {% for num in foo %}
    <li>{{ num }}</li>
{% endfor %}

{% set foo = [0, 1, 2, 3, 4, 5] %}

{% for num in foo %}

{% endfor %}

10.API属性（可自定义设置参数,可在app.js页面设置）

swig.init({
    allowErrors: false,
    autoescape: true,
    cache: true,
    encoding: 'utf8',
    filters: {},
    root: '/',
    tags: {},
    extensions: {},
    tzOffset: 0
});

swig.init({

allowErrors: false,

autoescape: true,

cache: true,

encoding: 'utf8',

filters: {},

root: '/',

tags: {},

extensions: {},

tzOffset: 0

});

options:

allowErrors: 默认值为 false。将所有模板解析和编译错误直接输出到模板。如果为 true，则将引发错误，抛出到 Node.js 进程中，可能会使您的应用程序崩溃。
autoescape: 默认true，强烈建议保持。字符转换表请参阅转义过滤器。
- true: HTML安全转义
- false: 不转义，除非使用转义过滤器或者转义标签
- 'js': js安全转义
cache: 更改为 false 将重新编译每个请求的模板的文件。正式环境建议保持true。
encoding: 模板文件编码
root: 需要搜索模板的目录。如果模板传递给 swig.compileFile 绝对路径(以/开头)，Swig不会在模板root中搜索。如果传递一个数组，使用第一个匹配成功的数组项。
tzOffset: 设置默认时区偏移量。此设置会使转换日期过滤器会自动的修正相应时区偏移量。
filters:自定义过滤器或者重写默认过滤器，参见自定义过滤器指南。
tags: 自定义标签或者重写默认标签，参见自定义标签指南。
extensions: 添加第三方库，可以在编译模板时使用，参见参见自定义标签指南。

11.所有标签详细介绍

1、内置标签

extends：使当前模板继承父模板，必须在文件最前

参数file：父模板相对模板 root 的相对路径 block：定义一个块，使之可以被继承的模板重写，或者重写父模板的同名块
参数name：块的名字，必须以字母数字下划线开头 parent：将父模板中同名块注入当前块中 include：包含一个模板到当前位置，这个模板将使用当前上下文
参数file: 包含模板相对模板 root 的相对路径
参数ignore missing：包含模板不存在也不会报错
参数with x：设置 x 至根上下文对象以传递给模板生成。必须是一个键值对
参数only：限制模板上下文中用 with x 定义的参数

{% include template_path %}
{% include "path/to/template.js" %}

1 2	{% include template_path %} {% include "path/to/template.js" %}

你可以标记 ignore missing，这样如果模板不存在，也不会抛出错误

{% include "foobar.html" ignore missing %}

1	{% include "foobar.html" ignore missing %}

本地声明的上下文变量，默认情况不会传递给包含的模板。例如以下情况，inc.html 无法得到 foo 和 bar

{% set foo = "bar" %}
{% include "inc.html" %}
{% for bar in thing %}
    {% include "inc.html" %}
{% endfor %}

{% set foo = "bar" %}

{% include "inc.html" %}

{% for bar in thing %}

{% include "inc.html" %}

{% endfor %}

如果想把本地声明的变量引入到包含的模板种，可以使用 with 参数来把后面的对象创建到包含模板的上下文中

{% set foo = { bar: "baz" } %}
{% include "inc.html" with foo %}
{% for bar in thing %}
    {% include "inc.html" with bar %}
{% endfor %}

{% set foo = { bar: "baz" } %}

{% include "inc.html" with foo %}

{% for bar in thing %}

{% include "inc.html" with bar %}

{% endfor %}

如果当前上下文中 foo 和 bar 可用，下面的情况中，只有 foo 会被 inc.html 定义

{% include "inc.html" with foo only %}

1	{% include "inc.html" with foo only %}

only 必须作为最后一个参数，放在其他位置会被忽略

raw：停止解析标记中任何内容，所有内容都将输出

参数file: 父模板相对模板 root 的相对路径 for：遍历对象和数组
参数x：当前循环迭代名
参数in：语法标记
参数y：可迭代对象。可以使用过滤器修改

{% for x in y %}
    {% if loop.first %}<ul>{% endif %}
        <li>{{ loop.index }} - {{ loop.key }}: {{ x }}</li>
    {% if loop.last %}</ul>{% endif %}
{% endfor %}

{% for x in y %}

{% if loop.first %}<ul>{% endif %}

<li>{{ loop.index }} - {{ loop.key }}: {{ x }}</li>

{% if loop.last %}</ul>{% endif %}

{% endfor %}

特殊循环变量

loop.index：当前循环的索引（1开始）

loop.index0：当前循环的索引（0开始）

loop.revindex：当前循环从结尾开始的索引（1开始）

loop.revindex0：当前循环从结尾开始的索引（0开始）

loop.key：如果迭代是对象，是当前循环的键，否则同 loop.index

loop.first：如果是第一个值返回 true

loop.last：如果是最后一个值返回 true

loop.cycle：一个帮助函数，以指定的参数作为周期 `

{% for item in items %}
    <li class="{{ loop.cycle('odd', 'even') }}">{{ item }}</li>
{% endfor %}

{% for item in items %}

{% endfor %}

在 for 标签里使用 else

{% for person in people %}
    {{ person }}
{% else %}
    There are no people yet!
{% endfor %}

{% for person in people %}

{% else %}

There are no people yet!

{% endfor %}

if：条件语句

参数：接受任何有效的 JavaScript 条件语句，以及一些其他人类可读语法

{% if x %}{% endif %}
{% if !x %}{% endif %}
{% if not x %}{% endif %}
{% if x and y %}{% endif %}
{% if x && y %}{% endif %}
{% if x or y %}{% endif %}
{% if x || y %}{% endif %}
{% if x || (y && z) %}{% endif %}
{% if x [operator] y %}
    Operators: ==, !=, <, <=, >, >=, ===, !==
{% endif %}
{% if x == 'five' %}
    The operands can be also be string or number literals
{% endif %}
{% if x|length === 3 %}
    You can use filters on any operand in the statement.
{% endif %}
{% if x in y %}
    If x is a value that is present in y, this will return true.
{% endif %}

{% if x %}{% endif %}

{% if !x %}{% endif %}

{% if not x %}{% endif %}

{% if x and y %}{% endif %}

{% if x && y %}{% endif %}

{% if x or y %}{% endif %}

{% if x || y %}{% endif %}

{% if x || (y && z) %}{% endif %}

{% if x [operator] y %}

Operators: ==, !=, <, <=, >, >=, ===, !==

{% endif %}

{% if x == 'five' %}

The operands can be also be string or number literals

{% endif %}

{% if x|length === 3 %}

You can use filters on any operand in the statement.

{% endif %}

{% if x in y %}

If x is a value that is present in y, this will return true.

{% endif %}

else 和 else if

{% if foo %}
    Some content.
{% else if "foo" in bar %}
    Content if the array `bar` has "foo" in it.
{% else %}
    Fallback content.
{% endif %}

{% if foo %}

Some content.

{% else if "foo" in bar %}

Content if the array `bar` has "foo" in it.

{% else %}

Fallback content.

{% endif %}

autoescape：改变当前变量的自动转义行为

参数on：当前内容是否转义
参数type：转义类型，js 或者 html，默认 html

假设

some_html_output = '<p>Hello "you" & \'them\'</p>';

1	some_html_output = '<p>Hello "you" & \'them\'</p>';

然后

{% autoescape false %}
    {{ some_html_output }}
{% endautoescape %}
{% autoescape true %}
    {{ some_html_output }}
{% endautoescape %}
{% autoescape true "js" %}
    {{ some_html_output }}
{% endautoescape %}

{% autoescape false %}

{% endautoescape %}

{% autoescape true %}

{% endautoescape %}

{% autoescape true "js" %}

{% endautoescape %}

将会输出

<p>Hello "you" & 'them'</p>
 <p>Hello &quot;you&quot; &amp; 'them' </p>
 \u003Cp\u003EHello \u0022you\u0022 & \u0027them\u0027\u003C\u005Cp\u003E

<p>Hello "you" & 'them'</p>

<p>Hello "you" & 'them' </p>

\u003Cp\u003EHello \u0022you\u0022 & \u0027them\u0027\u003C\u005Cp\u003E

set：设置一个变量，在当前上下文中复用

参数name：变量名
参数=：语法标记
参数value：变量值

{% set foo = [0, 1, 2, 3, 4, 5] %} {% for num in foo %}
    <li>{{ num }}</li>
{% endfor %}

{% set foo = [0, 1, 2, 3, 4, 5] %} {% for num in foo %}

{% endfor %}

macro：创建自定义可服用的代码段

参数...: 用户定义

{% macro input type name id label value error %}
 <label for="{{ name }}">{{ label }}</label>
 <input type="{{ type }}" name="{{ name }}" id="{{ id }}" value="{{ value }}"{% if error %} class="error"{% endif %}>
{% endmacro %}

{% macro input type name id label value error %}

<label for="{{ name }}">{{ label }}</label>

{% endmacro %}

然后像下面使用

<div>
    {{ input("text", "fname", "fname", "First Name", fname.value, fname.errors) }}
</div>
<div>
    {{ input("text", "lname", "lname", "Last Name", lname.value, lname.errors) }}
</div>

<div>

{{ input("text", "fname", "fname", "First Name", fname.value, fname.errors) }}

</div>

<div>

{{ input("text", "lname", "lname", "Last Name", lname.value, lname.errors) }}

</div>

输出如下

<div>
    <label for="fname">First Name</label>
    <input type="text" name="fname" id="fname" value="Paul">
</div>
<div>
    <label for="lname">Last Name</label>
    <input type="text" name="lname" id="lname" value="" class="error">
</div>

<div>

<label for="fname">First Name</label>

</div>

<div>

</div>

import：允许引入另一个模板的宏进入当前上下文

参数file：引入模板相对模板 root 的相对路径
参数as：语法标记 var: 分配给宏的可访问上下文对象

{% import 'formmacros.html' as form %}
{# this will run the input macro #}
    {{ form.input("text", "name") }}
    {# this, however, will NOT output anything because the macro is scoped to the "form"     object: #}
{{ input("text", "name") }}

{% import 'formmacros.html' as form %}

{# this will run the input macro #}

{# this, however, will NOT output anything because the macro is scoped to the "form" object: #}

filter：对整个块应用过滤器

参数filter_name: 过滤器名字
参数... : 若干传给过滤器的参数父模板相对模板 root 的相对路径

{% filter uppercase %}
    oh hi, {{ name }}
{% endfilter %}
{% filter replace "." "!" "g" %}
    Hi. My name is Paul.
{% endfilter %}

{% filter uppercase %}

oh hi, {{ name }}

{% endfilter %}

{% filter replace "." "!" "g" %}

Hi. My name is Paul.

{% endfilter %}

输出 OH HI, PAUL Hi! My name is Paul!

spaceless：尝试移除html标签间的空格

{% spaceless %}
    {% for num in foo %}
        <li>{{ loop.index }}</li>
    {% endfor %}
{% endspaceless %}

{% spaceless %}

{% for num in foo %}

<li>{{ loop.index }}</li>

{% endfor %}

{% endspaceless %}

输出

<li>1</li><li>2</li><li>3</li>

1	<li>1</li><li>2</li><li>3</li>

swig模板引擎快速入门教程（nodejs环境）

swig的简单介绍

一. swig的安装

二.和express框架集成

三.基本用法

1.变量

2.空白

3.模板继承

4.include模板

5.if判断

6.if-else判断

7.for循环

8.变量过滤器(强大的内置过滤器)

8.1、例子

8.2、内置过滤器

8.3自定义过滤器

9.set命令

10.API属性（可自定义设置参数,可在app.js页面设置）

11.所有标签详细介绍

1、内置标签

发表评论取消回复

Add 浆糊之家 to your Homescreen!

swig的简单介绍

一. swig的安装

二.和express框架集成

三.基本用法

1.变量

2.空白

3.模板继承

4.include模板

5.if判断

6.if-else判断

7.for循环

8.变量过滤器(强大的内置过滤器)

8.1、例子

8.2、内置过滤器

8.3自定义过滤器

9.set命令

10.API属性（可自定义设置参数,可在app.js页面设置）

11.所有标签详细介绍

1、内置标签

发表评论 取消回复

Add 浆糊之家 to your Homescreen!

发表评论取消回复