HTML imports 入门

HTML imports 入门

2015/02/10 · HTML5 ·
HTML,
imports

本文由 伯乐在线 –
XfLoops
翻译,周进林
校稿。未经许可,禁止转载!
英文出处:webcomponents.org。欢迎加入翻译组。

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

XHTML

<link rel=”import” href=”component.html” >

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

XHTML

<link rel=”stylesheet” href=”css/style.css”> <script
src=”js/script.js”></script>

1
2
<link rel="stylesheet" href="css/style.css">
<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

XHTML

<link rel=”import” href=”component.html”> // 1.
<title>Import Example</title> <script
src=”script3.js”></script> // 4.

1
2
3
<link rel="import" href="component.html"> // 1.
<title>Import Example</title>
<script src="script3.js"></script>        // 4.

component.html

XHTML

<script src=”js/script1.js”></script> // 2. <script
src=”js/script2.js”></script> // 3.

1
2
<script src="js/script1.js"></script>     // 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导入是不能从其他的域名导入资源的。

比如,你不能从向 
导入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

XHTML

var link = document.querySelector(‘link[rel=”import”]’);
link.addEventListener(‘load’, function(e) { var importedDoc =
link.import; // importedDoc points to the document under component.html
});

1
2
3
4
5
var link = document.querySelector(‘link[rel="import"]’);
link.addEventListener(‘load’, function(e) {
  var importedDoc = link.import;
  // importedDoc points to the document under component.html
});

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

component.html

XHTML

var mainDoc = document.currentScript.ownerDocument; // mainDoc points to
the document under component.html

1
2
var mainDoc = document.currentScript.ownerDocument;
// mainDoc points to the document under component.html

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

component.html

XHTML

var mainDoc = document._currentScript.ownerDocument; // mainDoc points
to the document under component.html

1
2
var mainDoc = document._currentScript.ownerDocument;
// mainDoc points to the document under component.html

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

XHTML

document._currentScript = document._currentScript ||
document.currentScript;

1
document._currentScript = document._currentScript || document.currentScript;

性能方面的考虑

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

解析依赖

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

index.html

XHTML

<link rel=”import” href=”component1.html”> <link rel=”import”
href=”component2.html”>

1
2
<link rel="import" href="component1.html">
<link rel="import" href="component2.html">

component1.html

XHTML

<script src=”js/jquery.js”></script>

1
<script src="js/jquery.js"></script>

component2.html

XHTML

<script src=”js/jquery.js”></script>

1
<script src="js/jquery.js"></script>

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

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

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

合并网络请求

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

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

JavaScript

$ vulcanize -o vulcanized.html index.html

1
$ 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

XHTML

<template id=”template”> <style> … </style> <div
id=”container”> <img
src=”; <content
select=”h1″></content> </div> </template>
<script> // This element will be registered to index.html //
Because `document` here means the one in index.html var XComponent =
document.registerElement(‘x-component’, { prototype:
Object.create(HTMLElement.prototype, { createdCallback: { value:
function() { var root = this.createShadowRoot(); var template =
document.querySelector(‘#template’); var clone =
document.importNode(template.content, true); root.appendChild(clone); }
} }) }); </script>

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
<template id="template">
  <style>
    …
  </style>
  <div id="container">
    <img src="http://webcomponents.org/img/logo.svg">
    <content select="h1"></content>
  </div>
</template>
<script>
  // This element will be registered to index.html
  // Because `document` here means the one in index.html
  var XComponent = document.registerElement(‘x-component’, {
    prototype: Object.create(HTMLElement.prototype, {
      createdCallback: {
        value: function() {
          var root = this.createShadowRoot();
          var template = document.querySelector(‘#template’);
          var clone = document.importNode(template.content, true);
          root.appendChild(clone);
        }
      }
    })
  });
</script>

index.html

XHTML

… <link rel=”import” href=”x-component.html”> </head>
<body> <x-component> <h1>This is Custom
Element</h1> </x-component> …

1
2
3
4
5
6
7
8
  <link rel="import" href="x-component.html">
</head>
<body>
  <x-component>
    <h1>This is Custom Element</h1>
  </x-component>
  …

注意,因为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

    赞 1 收藏
    评论

关于作者:XfLoops

图片 1

新浪微博:@XfLoops
个人主页 ·
我的文章 ·
10

图片 2

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图