简单介绍HTML5中的文件导入


Posted in HTML / CSS onMay 08, 2015

Template、Shadow DOM及Custom Elements 让你创建UI组件比以前更容易了。但是像HTML、CSS、JavaScript这样的资源仍然需要一个个地去加载,这是很没效率的。

删除重复依赖也并不简单。例如,现在加载jQuery UI或Bootstrap就需要为JavaScript、CSS及Web Fonts添加单独的标签。如果你的Web 组件应用了多重的依赖,那事情就变得更为复杂。

HTML 导入让你以一个合并的HTML文件来加载这些资源。
使用HTML导入

为加载一个HTML文件,你需要增加一个link标签,其rel属性为import,herf属性是HTML文件的路径。例如,如果你想把component.html加载到index.html:

index.html
 

XML/HTML Code复制内容到剪贴板
  1. <link rel="import" href="component.html" >    

你可以往HTML导入文件(译者注:本文将“ the imported HTML”译为“HTML导入文件”,将“the original HTML”译为“HTML主文件”。例如,index.html是HTML主文件,component.html是HTML导入文件。)添加任何的资源,包括脚本、样式表及字体,就跟往普通的HTML添加资源一样。

component.html
 

XML/HTML Code复制内容到剪贴板
  1. <link rel="stylesheet" href="css/style.css">  
  2. <script src="js/script.js"></script>  

doctype、html、 head、 body这些标签是不需要的。HTML 导入会立即加载要导入的文档,解析文档中的资源,如果有脚本的话也会立即执行它们。
执行顺序

浏览器解析HTML文档的方式是线性的,这就是说HTML顶部的script会比底部先执行。并且,浏览器通常会等到JavaScript代码执行完毕后,才会接着解析后面的代码。

为了不让script 妨碍HTML的渲染,你可以在标签中添加async或defer属性(或者你也可以将script 标签放到页面的底部)。defer 属性会延迟脚本的执行,直到全部页面解析完毕。async 属性让浏览器异步地执行脚本,从而不会妨碍HTML的渲染。那么,HTML 导入是怎样工作的呢?

HTML导入文件中的脚本就跟含有defer属性一样。例如在下面的示例中,index.html会先执行script1.js和script2.js ,然后再执行script3.js。

index.html
 

XML/HTML Code复制内容到剪贴板
  1. <link rel="import" href="component.html"> // 1.   
  2. <title>Import Example</title>  
  3. <script src="script3.js"></script>        // 4.  

component.html
 

XML/HTML Code复制内容到剪贴板
  1. <script src="js/script1.js"></script>     // 2.   
  2. <script src="js/script2.js"></script>     // 3.  

1.在index.html 中加载component.html并等待执行

2.执行component.html中的script1.js

3.执行完script1.js后执行component.html中的script2.js

4.执行完 script2.js继而执行index.html中的script3.js

注意,如果给link[rel="import"]添加async属性,HTML导入会把它当做含有async属性的脚本来对待。它不会等待HTML导入文件的执行和加载,这意味着HTML 导入不会妨碍HTML主文件的渲染。这也给提升网站性能带来了可能,除非有其他的脚本依赖于HTML导入文件的执行。
跨域导入

从根本上说,HTML导入是不能从其他的域名导入资源的。

比如,你不能从http://webcomponents.org/向 http://example.com/ 导入HTML 文件。为了绕过这个限制,可以使用CORS(跨域资源共享)。想了解CORS,请看这篇文章。
HTML导入文件中的window和document对象

前面我提过在导入HTML文件的时候里面的脚本是会被执行的,但这并不意味着HTML导入文件中的标签也会被浏览器渲染。你需要写一些JavaScript代码来帮忙。

当在HTML导入文件中使用JavaScript时,有一点要提防的是,HTML导入文件中的document对象实际上指的是HTML主文件中的document对象。以前面的代码为例,index.html和  component.html 的document都是指index.html的document对象。怎么才能使用HTML导入文件中的document 呢?借助link中的import 属性。

index.html
 

XML/HTML Code复制内容到剪贴板
  1. var link = document.querySelector('link[rel="import"]');   
  2. link.addEventListener('load', function(e) {   
  3.   var importedDoc = link.import;   
  4.   // importedDoc points to the document under component.html   
  5. });  

为了获取component.html中的document 对象,要使用document.currentScript.ownerDocument.

component.html
 

XML/HTML Code复制内容到剪贴板
  1. var mainDoc = document.currentScript.ownerDocument;   
  2. // mainDoc points to the document under component.html  

如果你在用webcomponents.js,那么就用document._currentScript来代替document.currentScript。下划线用于填充currentScript属性,因为并不是所有的浏览器都支持这个属性。

component.html

 

XML/HTML Code复制内容到剪贴板
  1. var mainDoc = document._currentScript.ownerDocument;   
  2. // mainDoc points to the document under component.html   

通过在脚本开头添加下面的代码,你就可以轻松地访问component.html中的document对象,而不用管浏览器是不是支持HTML导入。

document._currentScript = document._currentScript || document.currentScript;
性能方面的考虑

使用HTML 导入的一个好处是能够将资源组织起来,但是也意味着在加载这些资源的时候,由于使用了一些额外的HTML文件而让头部变得过大。有几点是需要考虑的:
解析依赖

假如HTML主文件要依赖多个导入文件,而且导入文件中含有相同的库,这时会怎样呢?例如,你要从导入文件中加载jQuery,如果每个导入文件都含有加载jQuery的script标签,那么jQuery就会被加载两次,并且也会被执行两次。

index.html
 

XML/HTML Code复制内容到剪贴板
  1. <link rel="import" href="component1.html">  
  2. <link rel="import" href="component2.html">  

component1.html
 

XML/HTML Code复制内容到剪贴板
  1. <script src="js/jquery.js"></script>  

component2.html
 
HTML导入自动帮你解决了这个问题。

与加载两次script标签的做法不同,HTML 导入对已经加载过的HTML文件不再进行加载和执行。以前面的代码为例,通过将加载jQuery的script标签打包成一个HTML导入文件,这样jQuery就只被加载和执行一次了。

但这还有一个问题:我们增加了一个要加载的文件。怎么处理数目膨胀的文件呢?幸运的是,我们有一个叫vulcanize的工具来解决这个问题。
合并网络请求

Vulcanize 能将多个HTML文件合并成一个文件,从而减少了网络连接数。你可以借助npm安装它,并且用命令行来使用它。你可能也在用 grunt和gulp 托管一些任务,这样的话你可以把vulcanize作为构建过程的一部分。

为了解析依赖以及合并index.html中的导入文件,使用如下命令:

复制代码
代码如下:
$ vulcanize -o vulcanized.html index.html

通过执行这个命令,index.html中的依赖会被解析,并且会产生一个合并的HTML文件,称作 vulcanized.html。学习更多有关vulcanize的知识,请看这儿。

注意:http2的服务器推送功能被考虑用于以后消除文件的连结与合并。
把Template、Shadow DOM、自定义元素跟HTML导入结合起来

让我们对这个文章系列的代码使用HTML导入。你之前可能没有看过这些文章,我先解释一下:Template可以让你用声明的方式定义你的自定义元素的内容。Shadow DOM可以让一个元素的style、ID、class只作用到其本身。自定义元素可以让你自定义HTML标签。通过把这些跟HTML导入结合起来,你自定义的web 组件会变得模块化,具有复用性。任何人添加一个Link标签就可以使用它。

x-component.html

 

XML/HTML Code复制内容到剪贴板
  1. <template id="template">  
  2.   <style>  
  3.     ...   
  4.   </style>  
  5.   <div id="container">  
  6.     <img src="http://webcomponents.org/img/logo.svg">  
  7.     <content select="h1"></content>  
  8.   </div>  
  9. </template>  
  10. <script>  
  11.   // This element will be registered to index.html   
  12.   // Because `document` here means the one in index.html   
  13.   var XComponent = document.registerElement('x-component', {   
  14.     prototype: Object.create(HTMLElement.prototype, {   
  15.       createdCallback: {   
  16.         value: function() {   
  17.           var root = this.createShadowRoot();   
  18.           var template = document.querySelector('#template');   
  19.           var clone = document.importNode(template.content, true);   
  20.           root.appendChild(clone);   
  21.         }   
  22.       }   
  23.     })   
  24.   });   
  25. </script>  

index.html
 

XML/HTML Code复制内容到剪贴板
  1. ...   
  2.   <link rel="import" href="x-component.html">  
  3. </head>  
  4. <body>  
  5.   <x-component>  
  6.     <h1>This is Custom Element</h1>  
  7.   </x-component>  
  8.   ...  

注意,因为x-component.html 中的document 对象跟index.html的一样,你没必要再写一些棘手的代码,它会自动为你注册。
支持的浏览器

Chrome 和 Opera提供对HTML导入的支持,Firefox要在2014年12月后才支持(Mozilla表示Firefox不计划在近期提供对HTML导入的支持,声称需要首先了解ES6的模块是怎样实现的)。

你可以去chromestatus.com或caniuse.com查询浏览器是否支持HTML导入。想要在其他浏览器上使用HTML导入,可以用webcomponents.js(原名platform.js)。
相关资源

HTML导入就介绍这么多了。如果你想学更多关于HTML导入的知识,请前往:

    HTML Imports: #include for the web – HTML5Rocks
    HTML Imports spec

 

HTML / CSS 相关文章推荐
利用纯CSS3实现文字向右循环闪过效果实例(可用于移动端)
Jun 15 HTML / CSS
CSS3的transition和animation的用法实例介绍
Aug 20 HTML / CSS
利用css3径向渐变做一张优惠券的示例
Mar 22 HTML / CSS
HTML5 Geolocation API的正确使用方法
Dec 04 HTML / CSS
html+css实现自定义图片上传按钮功能
Sep 04 HTML / CSS
HTML中fieldset标签概述及使用方法
Feb 01 HTML / CSS
使用phonegap获取位置信息的实现方法
Mar 31 HTML / CSS
canvas像素点操作之视频绿幕抠图
Sep 11 HTML / CSS
canvas拼图功能实现代码示例
Nov 21 HTML / CSS
HTML5新增form控件和表单属性实例代码详解
May 15 HTML / CSS
H5最强接口之canvas实现动态图形功能
May 31 HTML / CSS
CSS 左边固定宽右边自适应的6种方法
May 15 HTML / CSS
使用HTML5的Notification API制作web通知的教程
May 08 #HTML / CSS
利用HTML5中的Canvas绘制一张笑脸的教程
May 07 #HTML / CSS
HTML5实现获取地理位置信息并定位功能
Apr 25 #HTML / CSS
HTML5 canvas标签实现刮刮卡效果
Apr 24 #HTML / CSS
HTML5 DeviceOrientation实现手机网站摇一摇功能代码实例
Apr 24 #HTML / CSS
Html5+JS实现手机摇一摇功能
Apr 24 #HTML / CSS
HTML5 Canvas的事件处理介绍
Apr 24 #HTML / CSS
You might like
学习使用PHP数组
2006/10/09 PHP
解决文件名解压后乱码的问题 将文件名进行转码的代码
2012/01/10 PHP
PHP+redis实现添加处理投票的方法
2015/11/14 PHP
Yii净化器CHtmlPurifier用法示例(过滤不良代码)
2016/07/15 PHP
利用php-cli和任务计划实现订单同步功能的方法
2017/05/03 PHP
浅谈PHP发送HTTP请求的几种方式
2017/07/25 PHP
JQueryEasyUI datagrid框架的进阶使用
2013/04/08 Javascript
js+html5实现canvas绘制圆形图案的方法
2015/06/05 Javascript
jQuery点击改变class并toggle及toggleClass()方法定义用法
2015/12/11 Javascript
AngularJS基础 ng-show 指令简单示例
2016/08/03 Javascript
手机端 HTML5使用photoswipe.js仿微信朋友圈图片放大效果
2016/08/25 Javascript
javascript简单进制转换实现方法
2016/11/24 Javascript
微信小程序 实现列表项滑动显示删除按钮的功能
2017/04/13 Javascript
实现微信小程序的wxml文件和wxss文件在webstrom的支持
2017/06/12 Javascript
利用types增强vscode中js代码提示功能详解
2017/07/07 Javascript
AngularJs导出数据到Excel的示例代码
2017/08/11 Javascript
关于vue-router的beforeEach无限循环的问题解决
2017/09/09 Javascript
基于js的变量提升和函数提升(详解)
2017/09/17 Javascript
利用canvas中toDataURL()将图片转为dataURL(base64)的方法详解
2017/11/20 Javascript
详解Angular5 路由传参的3种方法
2018/04/28 Javascript
JavaScript设计模式之工厂模式简单实例教程
2018/07/03 Javascript
vue中使用 pako.js 解密 gzip加密字符串的方法
2019/06/10 Javascript
Node.js API详解之 util模块用法实例分析
2020/05/09 Javascript
Python整型运算之布尔型、标准整型、长整型操作示例
2017/07/21 Python
Python如何实现强制数据类型转换
2019/11/22 Python
什么是Python变量作用域
2020/06/03 Python
HTML5之web workers_动力节点Java学院整理
2017/07/17 HTML / CSS
ToysRus日本官网:玩具反斗城
2018/09/08 全球购物
thinkphp5 redis缓存新增方法实例讲解
2021/03/24 PHP
应聘医学检验人员自荐信
2013/09/27 职场文书
办公室文员自荐书
2014/02/03 职场文书
公司接待方案
2014/03/08 职场文书
初二学习计划书范文
2014/04/27 职场文书
城市创卫标语
2014/06/17 职场文书
房产销售员2015年终工作总结
2015/10/22 职场文书
关于艺术节的开幕致辞
2016/03/04 职场文书