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
你可以往HTML導入文件(譯者注:本文將“ the imported HTML”譯為“HTML導入文件”,將“the original HTML”譯為“HTML主文件”。例如,index.html是HTML主文件,component.html是HTML導入文件。)添加任何的資源,包括腳本、樣式表及字體,就跟往普通的HTML添加資源一樣。
component.html
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
component.html
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
為了獲取component.html中的document 對象,要使用document.currentScript.ownerDocument.
component.html
如果你在用webcomponents.js,那麼就用document._currentScript來代替document.currentScript。下劃線用於填充currentScript屬性,因為並不是所有的浏覽器都支持這個屬性。
component.html
XML/HTML Code復制內容到剪貼板
通過在腳本開頭添加下面的代碼,你就可以輕松地訪問component.html中的document對象,而不用管浏覽器是不是支持HTML導入。
document._currentScript = document._currentScript || document.currentScript;
性能方面的考慮
使用HTML 導入的一個好處是能夠將資源組織起來,但是也意味著在加載這些資源的時候,由於使用了一些額外的HTML文件而讓頭部變得過大。有幾點是需要考慮的:
解析依賴
假如HTML主文件要依賴多個導入文件,而且導入文件中含有相同的庫,這時會怎樣呢?例如,你要從導入文件中加載jQuery,如果每個導入文件都含有加載jQuery的script標簽,那麼jQuery就會被加載兩次,並且也會被執行兩次。
index.html
component1.html
component2.html
HTML導入自動幫你解決了這個問題。
與加載兩次script標簽的做法不同,HTML 導入對已經加載過的HTML文件不再進行加載和執行。以前面的代碼為例,通過將加載jQuery的script標簽打包成一個HTML導入文件,這樣jQuery就只被加載和執行一次了。
但這還有一個問題:我們增加了一個要加載的文件。怎麼處理數目膨脹的文件呢?幸運的是,我們有一個叫vulcanize的工具來解決這個問題。
合並網絡請求
Vulcanize 能將多個HTML文件合並成一個文件,從而減少了網絡連接數。你可以借助npm安裝它,並且用命令行來使用它。你可能也在用 grunt和gulp 托管一些任務,這樣的話你可以把vulcanize作為構建過程的一部分。
為了解析依賴以及合並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復制內容到剪貼板
index.html
注意,因為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)。