javascript模板引擎：art-template文档笔记

来源：互联网发布：淘宝视频剪辑收费编辑：程序博客网时间：2024/05/20 09:46
基本按照手册，过了一遍，当自己熟悉下：
1.github地址：https://github.com/aui/art-template2.引入文件：lib/template-web.js兼容IE8，还需要引入example/web-ie-compatible/*.js3.语法：支持2种：标准语法 和 原始语法标准语法：支持基本模板语法以及基本javascript表达式原始语法：支持任意javascript语法，这和EJS一样1>输出：标准语法{{value}}{{data.key}}{{data['key']}}{{a || b}}{{a + b}}原始语法<%= value %><%= data.key %><%= data['key'] %><%= a || b %><%= a + b %>模板一级特殊变量可以使用 '$data' + '下标' 进行访问：{{$data['user list']}}2>原文输出 - 不会对HTML内容进行转义标准语法{{@value}}原始语法<%- value %>3>条件标准语法{{if value}}...{{/if}}{{if v1}}...{{else if v2}}...{{/if}}原始语法<% if (value) { %>...<% } %><% if (v1) { %>...<% } else if (v2) { %>...<% } %>4>循环标准语法{{each target}}{{$index}} {{$value}}{{/each}}原始语法<% for(var i = 0; i < target.length; i++){ %><%= i %> <%= target[i] %><% } %>注意：1.target 支持 'array' 和 'object'，默认值为 '$data'2.$value 和 $index 可以自定义：{{each target val key}}5>变量标准语法{{set temp = data.sub.content}}原始语法<% var temp = data.sub.content; %>6>模板继承标准语法{{extend './layout.art'}}{{block 'head'}}....{{/block}}原始语法<% extend('./layout.art') %><% block('head', function(){ %><% }) %>模板继承允许构建一个包含 'layout' 布局模板<!--layout.art--><!doctype html><html><head>    <meta charset="utf-8">    <title>{{block 'title'}}My Site{{/block}}</title>    {{block 'head'}}    <link rel="stylesheet" href="main.css">    {{/block}}</head><body>    {{block 'content'}}{{/block}}</body></html>继承 'layout'<!--index.art-->{{extend './layout.art'}}{{block 'title'}}{{title}}{{/block}}{{block 'head'}}    <link rel="stylesheet" href="custom.css">{{/block}}{{block 'content'}}<p>This is just an awesome page.</p>{{/block}}7>子模板标准语法{{include './header.art'}}{{include './header.art' data}}原始语法<% include('./header.art') %><% include('./header.art', data) %>注意：1.data 默认值为 $data；标准语法不支持声明 'array' 和 'object'，只支持引用变量，而原始语法不受限制2.art-template 内建 HTML 压缩器，避免书写 HTML 非正常闭合的子模板，否则开启压缩后可能出现混乱！8>过滤器注册过滤器 - 函数第一个参数接受目标值template.defaults.imports.dateFormat = function(data, format){};template.defaults.imports.timeFormat = function(value){return value * 1000};标准语法{{date | timestamp | dateFormat 'Y-m-d H:i:s'}}原始语法<%= $imports.dateFormat($import.timestamp(date), 'Y-m-d H:i:s')  %>4.重要选项：1>调试template.defaults.debugart-template 内建调试器，能够捕获到语法与运行错误，并且支持自定义的语法。在 NodeJS 中调试模式会根据环境变量自动开启：process.env.NODE_ENV !== 'production'设置 template.defaults.debug = true，等同于：{cache: false,minimize: false,compileDebug: true}2>模板变量template.defaults.imports模板通过 $imports 可以访问到模板外部的全局变量与导入的变量导入变量template.defaults.imports.log = console.log;<% $imports.log('hello world') %>内置变量$data - 传入模板的数据$imports - 外部导入的变量以及全局变量print - 字符串输出函数include - 子模板载入函数extend - 模板继承函数block - 模板 '块声明' 函数3>解析规则template.defaults.rules修改2种模板语法定界符：原始语法 - 默认规则(源码)template.defaults.rules[0].test = /<%(#?)((?:==|=#|[=-])?)[ \t]*([\w\W]*?)[ \t]*(-?)%>/;标准语法 - 默认规则(源码)template.defaults.rules[1].test = /{{([@#]?)[ \t]*(\/?)([\w\W]*?)[ \t]*}}/;就是一个正则表达式，我们只需要修改 '定界符' 正则：var rule = template.defaults.rules[0];rule.test = new RegExp(rule.test.source.replace('<%', '<\\\?').replace('%>', '\\\?>'));添加语法：让模板引擎支持 ES6 ${name} 模板字符串的解析：template.defaults.rules.push({    test: /\${([\w\W]*?)}/,    use: function(match, code) {        return {            code: code,            output: 'escape'        }    }});其中 'test' 是匹配字符串正则，'use' 是匹配后的调用函数use函数：4>压缩页面template.defaults.minimizeart-template 内建的压缩器可以压缩 HTML、JS、CSS，它在编译阶段运行，因此完全不影响渲染速度，并且能够加快网络传输开启：template.defaults.minimize = true;// 启用配置：参考：template.defaults.minimize = true;默认配置：template.defaults.htmlMinifierOptions = {    collapseWhitespace: true,    minifyCSS: true,    minifyJS: true,    // 运行时自动合并：rules.map(rule => rule.test)    ignoreCustomFragments: []};5.全部选项// 模板名filename: null,// 模板语法规则列表rules: [nativeRule, artRule],// 是否开启对模板输出语句自动编码功能。false - 关闭编码输出功能// escape 可以防范 XSS 攻击excape: true,// 启动模板引擎调试模式。如果为 true: {cache:false, minimize:false, compileDebug:true}debug: detectNode ? process.env.NODE_ENV !== 'production' : false,// bail 如果为true，编译错误与运行时错误都会抛出异常bail: true,// 是否开启缓存cache: true,// 是否开启压缩。它会运行 htmlMinifier，将页面 HTML、CSS、CSS 进行压缩输出// 如果模板包含没有闭合的 HTML 标签，请不要打开 minimize，否则可能被 htmlMinifier 修复或过滤minimize: true,// 是否编译调试版compileDebug: false,// 模板路径转换器resolveFilename: resolveFilename,// 子模板编译支配器include: include,// HTML 压缩器。仅在 NodeJS 环境下有小htmlMinifier: htmlMinifier,// HTML压缩器配置。参见 https://github.com/kangax/html-minifierhtmlMinifierOptions: {    collapseWhitespace: true,    minifyCSS: true,    minifyJS: true,    // 运行时自动合并：rules.map(rule => rule.test)    ignoreCustomFragments: []},// 错误事件。仅在 bail 为 false 时生效onerror: onerror,// 模板文件加载器loader: loader,// 缓存中心适配器(依赖 filename 字段)caches: caches,// 模板根目录。如果 filename 字段不是本地路径，则在 root 查找模板root: '/',// 默认后缀名。如果没有后缀名，则会自动添加 extnameextname: '.art',// 忽略的变量。被模板编译器忽略的模板变量列表ignore: [],// 导入的模板变量imports: runtime,6.API：template(filename, content).compile() - 编译模板源代码，并返回一个渲染函数(类似，定义了一个 '模板'，使用时，传入数据，直接渲染即可！).render() - 编译模板字符串，并渲染.defaults() - 修改默认配置.extension() - 扩展，仅 NodeJS 使用7.使用：我们一般使用，就是引入js，然后要么渲染模板，要么渲染模板字符串，所用到的核心方法：// 基于模板名渲染模板template(filename, data)// 将模板源代码编译成函数并立刻执行template.render(source, data, options);// 将模板源代码编译成函数template.compile(source, options);
阅读全文
0 0