下一代的模板引擎:lit-html

开发 前端
今天来看看基于这个原生技术,Google 二次封存的框架 lit-html。今天会重点介绍 lit-html 的用法以及优势。

[[390834]]

前面的文章介绍了 Web Components 的基本用法,今天来看看基于这个原生技术,Google 二次封存的框架 lit-html。

其实早在 Google 提出 Web Components 的时候,就在此基础上发布了 Polymer 框架。只是这个框架一直雷声大雨点小,内部似乎也对这个项目不太满意,然后他们团队又开发了两个更加现代化的框架(或者说是库?):lit-html、lit-element,今天的文章会重点介绍 lit-html 的用法以及优势。

发展历程

在讲到 lit-html 之前,我们先看看前端通过 JavaScript 操作页面,经历过的几个阶段:

发展阶段

原生 DOM API

最早通过 DOM API 操作页面元素,操作步骤较为繁琐,而且 JS 引擎与浏览器 DOM 对象的通信相对耗时,频繁的 DOM 操作对浏览器性能影响较大。

  1. var $box = document.getElementById('box'
  2. var $head = document.createElement('h1'
  3. var $content = document.createElement('div'
  4. $head.innerText = '关注我的公众号' 
  5. $content.innerText = '打开微信搜索:『自然醒的笔记本』' 
  6. $box.append($head) 
  7. $box.append($content) 

 

jQuery 操作 DOM

jQuery 的出现,让 DOM 操作更加便捷,内部还做了很多跨浏览器的兼容性处理,极大的提升了开发体验,并且还拥有丰富的插件体系和详细的文档。 

  1. var $box = $('#box'
  2.  
  3. var $head = $('<h1/>', { text: '关注我的公众号' }) 
  4. var $content = $('<div/>', { text: '打开微信搜索:『自然醒的笔记本』' }) 
  5.  
  6. $box.append($head, $content) 

 

虽然提供了便捷的操作,由于其内部有很多兼容性代码,在性能上就大打折扣了。而且它的链式调用,让开发者写出的面条式代码也经常让人诟病(PS. 个人认为这也不能算缺点,只是有些人看不惯罢了)。

模板操作

『模板引擎』最早是后端 MVC 框架的 View 层,用来拼接生成 HTML 代码用的。比如,mustache 是一个可以用于多个语言的一套模板引擎。

mustache

后来前端框架也开始捣鼓 MVC 模式,渐渐的前端也开始引入了模板的概念,让操作页面元素变得更加顺手。下面的案例,是 angluar.js 中通过指令来使用模板:

  1. var app = angular.module("box", []); 
  2.  
  3. app.directive("myMessage"function (){ 
  4.   return { 
  5.     template : '' + 
  6.     '<h1>关注我的公众号</h1>' + 
  7.     '<div>打开微信搜索:『自然醒的笔记本』</div>' 
  8.   } 
  9. }) 

 

后来的 Vue 更是将模板与虚拟 DOM 进行了结合,更进一步的提升了 Vue 中模板的性能,但是模板也有其缺陷存在。

  • 不管是什么模板引擎,在启动时,解析模板是需要花时间,这是没有办法避免的;
  • 连接模板与 JavaScript 的数据比较麻烦,而且在数据更新时还需进行模板的更新;
  • 各式各样的模板创造了自己的语法结构,使用不同的模板引擎,就需要重新学习一遍其语法糖,这对开发体验不是很友好;

JSX

[[390835]]

GitHub - OpenJSX/logo: Logo of JSX-IR

React 在官方文档中这样介绍 JSX:

“JSX,是一个 JavaScript 的语法扩展。我们建议在 React 中配合使用 JSX,JSX 可以很好地描述 UI 应该呈现出它应有交互的本质形式。JSX 可能会使人联想到模板语言,但它具有 JavaScript 的全部功能。

  1. var title = '关注我的公众号' 
  2. var content = '打开微信搜索:『自然醒的笔记本』' 
  3.  
  4. const element = <div> 
  5.   <h1>{title}</h1> 
  6.   <div>{content}</div> 
  7. </div>; 
  8.  
  9. ReactDOM.render( 
  10.   element, 
  11.   document.getElementById('root'

 

JSX 的出现,给前端的开发模式带来更大的想象空间,更是引入了函数式编程的思想。

  1. UI = fn(state) 

 但是这也带来了一个问题,JSX 语法必须经过转义,将其处理成 React.createElement 的形式,这也提高了 React 的上手难度,很多新手望而却步。

lit-html 介绍

lit-html 的出现就尽可能的规避了之前模板引擎的问题,通过现代浏览器原生的能力来构建模板。

  • ES6 提供的模板字面量;
  • Web Components 提供的<template> 标签;
  1. // Import lit-html 
  2. import {html, render} from 'lit-html'
  3.  
  4. // Define a template 
  5. const template = (title, content) => html` 
  6.   <h1>${title}</h1> 
  7.   <div>${content}</div> 
  8. `; 
  9.  
  10. // Render the template to the document 
  11. render( 
  12.   template('关注我的公众号''打开微信搜索:『自然醒的笔记本』'), 
  13.   document.body 
  14. ); 

 

模板语法

由于使用了原生的模板字符,可以无需转义,直接进行使用,而且和 JSX 一样也能使用 JavaScript 语法进行遍历和逻辑控制。

  1. const skillTpl = (title, skills) => html` 
  2.   <h2>${title || '技能列表' }</h2> 
  3.   <ul> 
  4.     ${skills.map(i => html`<li>${i}</li>`)} 
  5.   </ul> 
  6. `; 
  7.  
  8. render( 
  9.   skillTpl('我的技能', ['Vue''React''Angluar']), 
  10.   document.body 
  11. ); 

 

除了这种写法上的便利,lit-html 内部也提供了Vue 类似的事件绑定方式。

  1. const Input = (defaultValue) => html` 
  2.   name: <input value=${defaultValue} @input=${(evt) => { 
  3.     console.log(evt.target.value) 
  4.   }} /> 
  5. `; 
  6.  
  7. render( 
  8.   Input('input your name'), 
  9.   document.body 
  10. ); 

 

样式的绑定

除了使用原生模板字符串编写模板外,lit-html 天生自带的 CSS-in-JS 的能力。

  1. import {html, render} from 'lit-html'
  2. import {styleMap} from 'lit-html/directives/style-map.js'
  3.  
  4. const skillTpl = (title, skills, highlight) => { 
  5.  const styles = { 
  6.    backgroundColor: highlight ? 'yellow' : ''
  7.  }; 
  8.  return html` 
  9.    <h2>${title || '技能列表' }</h2> 
  10.    <ul style=${styleMap(styles)}> 
  11.      ${skills.map(i => html`<li>${i}</li>`)} 
  12.    </ul> 
  13.  ` 
  14. }; 
  15.  
  16. render( 
  17.  skillTpl('我的技能', ['Vue''React''Angluar'], true), 
  18.  document.body 
  19. ); 

 

渲染流程

做为一个模板引擎,lit-html 的主要作用就是将模板渲染到页面上,相比起 React、Vue 等框架,它更加专注于渲染,下面我们看看 lit-html 的基本工作流程。

  1. // Import lit-html 
  2. import { html, render } from 'lit-html'
  3.  
  4. // Define a template 
  5. const myTemplate = (name) => html`<p>Hello ${name}</p>`; 
  6.  
  7. // Render the template to the document 
  8. render(myTemplate('World'), document.body); 

 通过前面的案例也能看出,lit-html 对外常用的两个 api 是 html 和 render。

构造模板

html 是一个标签函数,属于 ES6 新增语法,如果不记得标签函数的用法,可以打开 Mozilla 的文档(https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Template_literals)复习下。

  1. export const html = (strings, ...values) => { 
  2.   …… 
  3. }; 

 html 标签函数会接受多个参数,第一个参数为静态字符串组成的数组,后面的参数为动态传入的表达式。我们可以写一个案例,看看传入的 html 标签函数的参数到底长什么样:

  1. const foo = '吴彦祖'
  2. const bar = '梁朝伟'
  3.  
  4. html`<p>Hello ${foo}, I'm ${bar}</p>`; 

整个字符串会被动态的表达式进行切割成三部分,这个三个部分会组成一个数组,做为第一个参数传入 html 标签函数,而动态的表达式经过计算后得到的值会做为后面的参数一次传入,我们可以将 strings 和 values 打印出来看看:

log

lit-html 会将这两个参数传入 TemplateResult 中,进行实例化操作。

  1. export const html = (strings, ...values) => { 
  2.   return new TemplateResult(strings, values); 
  3. }; 
  1.  
  2. const marker = `{{lit-${String(Math.random()).slice(2)}}}`; 
  3. const nodeMarker = `<!--${marker}-->`; 
  4.  
  5. export class TemplateResult { 
  6.  constructor(strings, values) { 
  7.   this.strings = strings; 
  8.   this.values = values
  9.  } 
  10.  getHTML() { 
  11.   const l = this.strings.length - 1; 
  12.   let html = ''
  13.   let isCommentBinding = false
  14.   for (let i = 0; i < l; i++) { 
  15.    const s = this.strings[i]; 
  16.    html += s + nodeMarker; 
  17.   } 
  18.   html += this.strings[l]; 
  19.   return html; 
  20.  } 
  21.  getTemplateElement() { 
  22.   const template = document.createElement('template'); 
  23.   let value = this.getHTML(); 
  24.   template.innerHTML = value; 
  25.   return template; 
  26.  } 

实例化的 TemplateResult 会提供一个 getTemplateElement 方法,该方法会创建一个 template 标签,然后会将 getHTML 的值传入 template 标签的 innerHTML 中。而 getHTML 方法的作用,就是在之前传入的静态字符串中间插入 HTML 注释。前面的案例中,如果调用 getHTML 得到的结果如下。

渲染到页面

render 方法会接受两个参数,第一个参数为 html 标签函数返回的 TemplateResult,第二个参数为一个真实的 DOM 节点。

  1. export const parts = new WeakMap(); 
  2. export const render = (result, container) => { 
  3.   // 先获取DOM节点之前对应的缓存 
  4.   let part = parts.get(container); 
  5.   // 如果不存在缓存,则重新创建 
  6.   if (part === undefined) { 
  7.     part = new NodePart() 
  8.     parts.set(container, part); 
  9.     part.appendInto(container); 
  10.   } 
  11.   // 将 TemplateResult 设置到 part 中 
  12.   part.setValue(result); 
  13.   // 调用 commit 进行节点的创建或更新 
  14.   part.commit(); 
  15. }; 

render 阶段会先到 parts 里面查找之前构造过的 part 缓存。可以将 part 理解为一个节点的构造器,用来将 template 的内容渲染到真实的 DOM 节点中。

如果 part 缓存不存在,会先构造一个,然后调用 appendInto 方法,该方法会在 DOM 节点的前后插入两个注释节点,用于后续插入模板。

  1. const createMarker = () => document.createComment(''); 
  2. export class NodePart { 
  3.   appendInto(container) { 
  4.     this.startNode = container.appendChild(createMarker()); 
  5.     this.endNode = container.appendChild(createMarker()); 
  6.   } 

 

然后通过 commit 方法创建真实的节点,并插入到两个注释节点中。下面我们看看 commit方法的具体操作:

  1. export class NodePart { 
  2.   setValue(result) { 
  3.     // 将 templateResult 放入 __pendingValue 属性中 
  4.     this.__pendingValue = result; 
  5.   } 
  6.   commit() { 
  7.     const value = this.__pendingValue; 
  8.     // 依据 value 的不同类型进行不同的操作 
  9.     if (value instanceof TemplateResult) { 
  10.       // 通过 html 标签方法得到的 value 
  11.       // 肯定是 TemplateResult 类型的 
  12.       this.__commitTemplateResult(value); 
  13.     } else { 
  14.       this.__commitText(value); 
  15.     } 
  16.   } 
  17.   __commitTemplateResult(value) { 
  18.     // 调用 templateFactory 构造模板节点 
  19.     const template = templateFactory(value); 
  20.     // 如果之前已经构建过一次模板,则进行更新 
  21.     if (this.value.template === template) { 
  22.       // console.log('更新DOM', value) 
  23.       this.value.update(value.values); 
  24.     } else { 
  25.       // 通过模板节点构造模板实例 
  26.       const instance = new TemplateInstance(template); 
  27.       // 将 templateResult 中的 values 更新到模板实例中 
  28.    const fragment = instance._clone(); 
  29.       instance.update(value.values); 
  30.       // 拷贝模板中的 DOM 节点,插入到页面 
  31.       this.__commitNode(fragment); 
  32.       // 模板实例放入 value 属性进行缓存,用于后续判断是否是更新操作 
  33.       this.value = instance; 
  34.     } 
  35.   } 

实例化之后的模板,首先会调用 instance._clone() 进行一次拷贝操作,然后通过 instance.update(value.values) 将计算后的动态表达式插入其中。

最后调用 __commitNode 将拷贝模板得到的节点插入真实的 DOM 中。

  1. export class NodePart { 
  2.   __insert(node) { 
  3.     this.endNode.parentNode.insertBefore(node, this.endNode); 
  4.   } 
  5.   __commitNode(value) { 
  6.     this.__insert(value); 
  7.     this.value = value; 
  8.   } 

 

可以看到 lit-html 并没有类似 Vue、React 那种将模板或 JSX 构造成虚拟 DOM 的流程,只提供了一个轻量的 html 标签方法,将模板字符转化为 TemplateResult,然后用注释节点去填充动态的位置。TemplateResult 最终也是通过创建 标签,然后通过浏览器内置的 innerHTML 进行模板解析的,这个过程也是十分轻量,相当于能交给浏览器的部分全部交给浏览器来完成,包括模板创建完后的节点拷贝操作。

  1. export class TemplateInstance { 
  2.   _clone() { 
  3.     const { element } = this.template; 
  4.     const fragment = document.importNode(element.content, true); 
  5.     // 省略部分操作…… 
  6.     return fragment; 
  7.   } 

其他lit-html 只是一个高效的模板引擎,如果要用来编写业务代码还缺少了类似 Vue、React 提供的生命周期、数据绑定等能力。为了完成这部分的能力,Polymer 项目组还提供了另一个框架:lit-element,可以用来创建 WebComponents。

除了官方的 lit-element 框架,Vue 的作者还将 Vue 的响应式部分剥离,与 lit-html 进行了结合,创建了一个 vue-lit(https://github.com/yyx990803/vue-lit) 的框架,一共也就写了 70 行代码,感兴趣可以看看。

 

责任编辑:姜华 来源: 自然醒的笔记本
相关推荐

2013-07-27 21:28:44

2015-10-15 10:30:32

2013-06-27 11:21:17

2021-04-21 07:53:14

云原生PulsarGo

2020-06-02 08:05:28

智能电表蜂窝物联网NB-IoT

2024-02-26 14:46:53

移动计算人工智能5G

2018-09-11 08:00:00

DevOpsAIOps机器学习

2020-09-16 10:28:54

边缘计算云计算数据中心

2018-09-27 18:47:45

AIOpsDevOps

2020-09-27 17:27:58

边缘计算云计算技术

2014-07-18 17:14:34

2009-06-26 09:06:01

2013-09-09 16:28:36

2013-07-09 09:35:03

搜索引擎功能开发搜索

2016-01-26 11:58:12

2013-04-25 13:21:30

2011-12-08 10:16:53

2012-06-15 09:21:03

Windows 7Windows XP

2022-06-17 14:48:38

物联网住房危机数据

2024-02-07 09:00:00

点赞
收藏

51CTO技术栈公众号