純原生組件化-模塊化的探索

時間  2019-11-24
標籤 原生 組件 模塊化 探索 简体版
原文   原文鏈接

純原生的組件化、模塊化的一次小小的嘗試，用到了以下幾個新特性：
shadown-DOM 對HTML標籤結構的一個封裝，真正意義上的組件，能保證 shadow-DOM 中的DOM元素不會被外界影響，內部也不會影響到外部的行爲，變成了一個獨立的模塊。
custom-elements 能夠在瀏覽器中註冊自定義的標籤來使用，相似這樣的效果<my-tag></my-tag>，標籤內容基於兩種形式：1. 普通子元素 2. shadow-DOM
custom-events 使用各類自定義事件輔助完成組件之間的通信
ES-module 爲瀏覽器原生支持的模塊化的一種方案，直接在瀏覽器裏使用import和export這類語法，以 module 的方式來引入 js 文件。
幾個算是比較新的事物，彙集在一塊兒確實能夠作點兒好玩的東西出來。javascript

shadow-DOM

想象有這樣的一個場景，相似資料卡的東東，須要在頁面中展現頭像和用戶的名稱。
頭像在左，寬高100px，圓形；
姓名在右，字號16px，垂直居中。css

這算是一段很簡單的CSS了，實現起來大概是這樣的：html

<style>
.info { display: flex; }

.info-avatar { width: 100px; height: 100px; border-radius: 50%; }

.info-name { display: flex; align-items: center; font-size: 16px; }
</style>
<div class="info">
  <img class="info-avatar" src="https://avatars1.githubusercontent.com/u/9568094?v=4" />
  <p class="info-name">Jarvis</p>
</div>

 

此時，咱們完成了需求，一切都沒有什麼不對的，可是一個很現實的問題。
不會有這麼簡單的頁面存在的，就算簡潔如 Google 首頁，也用到了400左右的DOM元素。
很難保證其餘資源文件中的CSS、JS會不會對上邊的DOM產生影響。
就好比若是有一個main.css文件中寫了一行：p { color: red;}，那麼這條CSS就會對咱們上邊所寫的.info-name元素產生影響，致使文本顏色變爲紅色。前端

這種問題常常會出如今一些須要用到第三方插件的頁面中，極可能對方提供的CSS會影響到你的DOM元素，也頗有可能你的CSS會對插件中的DOM形成影響。java

解決這個問題有一種簡單的辦法，那就是All with !important，使用shadow-DOM。webpack

目前瀏覽器中就有一些shadow-DOM的例子：git

  • <video>
  • <audio>
  • 甚至<input>

這些元素在 Chrome 上的構建都是採用了shadow-DOM的方式，可是默認狀況下在開發者工具中是看不到這些元素的。
github

開啓shadow-DOM的流程： Chrome DevTools -> Settings -> 默認 Preferences 面板中找到 Elements -> 點擊勾選 Show user agent shadow DOM 便可web

這時候就能夠經過開發者工具查看到shadow-DOM的實際結構了。
瀏覽器

shadow-DOM的一個特色，shadow 裏邊全部的DOM元素不會被外界的代碼所影響，這也就是爲何video和audio的 UI 難以自定義的緣由了-.-。

基本語法

shadow-DOM的建立必需要使用JavaScript才能完成，咱們須要在文檔中有一個用於掛在shadow-DOM的真實元素，也被稱爲host。
除此以外的建立過程，就能夠像普通DOM樹那樣的增刪改子元素了。

let $tag = document.querySelector('XXX') // 用於掛載的真實元素

let shadow = $tag.attachShadow({ mode: 'open' }) // 掛載shadow-DOM元素，並獲取其根元素

 

attachShadow中的mode參數有兩個有效的取值，open和closed，用來指定一個 shadow-DOM 結構的封裝模式。

當值爲open時，則咱們能夠經過掛載時使用的真實元素獲取到shadow-DOM。

$tag.shadowRoot; // shadow-DOM的root元素

 

當值爲closed時，則表示外層沒法獲取shadow-DOM。

$tag.shadowRoot; // null

 

後續的操做就與普通的DOM操做一致了，各類append、remove、innerHTML均可以了。

let $shadow = $tag.attachShadow({ mode: 'open' })

let $img = document.createElement('img')
$shadow.appendChild($img)  // 添加一個img標籤到shadow-DOM中

$shadow.removeChild($img) // 將img標籤從shadow-DOM中移除

$img.addEventListener('click', _ => console.log('click on img'))

$shadow.innerHTML = `
  <div class="wrap">
    <p>Some Text</p>
  </div>
`

 

須要注意的一點是，shadow-DOM自己並非一個實際的標籤，不具有定義CSS的能力。
可是綁定事件是能夠的

$shadow.appendChild('<p></p>') // 僞裝add了一個標籤
$shadow.appendChild('<p></p>') // 僞裝add了一個標籤

// 最後獲得的結構就是
// <外層容器>
//   <p></p>
//   <p></p>
// </外層容器>

// 沒有class相關的屬性
$shadow.classList // undefined
$shadow.className // undefined
$shadow.style     // undefined
// 綁定事件是沒問題的
$shadow.addEventListener('click', console.log)

 

shadow-DOM也會有CSS的屬性繼承，而不是徹底的忽略全部外層CSS

<style>
  body {
    font-size: 16px;  /* 屬性會被.text元素繼承 */
  }
  .host {
    color: red;       /* 一樣會被.text元素繼承 */
  }

  .text {
    color: green;     /* 直接設置shadow內的元素是無效的 */
  }

  p {
    font-size: 24px;  /* 針對p標籤的設置也不會被.text應用 */
  }

  /* 對外層設置flex，內部元素也會直接應用(但爲了保證對外層元素的非侵入性，建議內部建立一個容器DOM) */
  .host {
    display: flex;
  }
  .text {
    flex: 1;
  }
</style>
<div class="host">
  #shadow
    <p class="text">Text</p>
    <p class="text">Text</p>
  #shadow
</div>

 

因此說，對於shadow-DOM，CSS只是屏蔽了直接命中了內部元素的那一部分規則。
好比說寫了一個* { color: red; }，這個規則確定會生效的，由於*表明了所有，實際上shadow-DOM是從外層host元素繼承過來的color: red，而不直接是命中本身的這條規則。

簡單的小例子

咱們使用shadow-DOM來修改上邊的資料卡。

在線demo
源碼地址

<div id="info"></div>
<script>
  let $info = document.querySelector('#info') // host

  let $shadow = $info.attachShadow({mode: 'open'})

  let $style = document.createElement('style')
  let $wrap = document.createElement('div')
  let $avatar = document.createElement('img')
  let $name = document.createElement('p')

  $style.textContent = `
    .info { display: flex; }
    .info-avatar { width: 100px; height: 100px; border-radius: 50%; }
    .info-name { display: flex; align-items: center; font-size: 16px; }
  `

  $wrap.className = 'info'
  $avatar.className = 'info-avatar'
  $name.className = 'info-name'

  $avatar.src = 'https://avatars1.githubusercontent.com/u/9568094?v=4'
  $name.innerHTML = 'Jarvis'

  $wrap.appendChild($avatar)
  $wrap.appendChild($name)

  $shadow.appendChild($style)
  $shadow.appendChild($wrap)
</script>

 

P.S. 在 shadow-DOM 內部的 css，不會對外界所產生影響，因此使用 shadow-DOM 就能夠肆意的對 class 進行命名而不用擔憂衝突了。

若是如今在一個頁面中要展現多個用戶的頭像+姓名，咱們能夠將上邊的代碼進行封裝，將 className，appendChild之類的操做放到一個函數中去，相似這樣的結構：

在線demo
源碼地址

function initShadow($host, { isOpen, avatar, name }) {
  let $shadow = $host.attachShadow({ mode: isOpen ? 'open' : 'closed' });

  // ...省略各類操做
  $avatar.src = avatar
  $name.innerHTML = name
}

initShadow(document.querySelector('#info1'), {
  avatar: 'https://avatars1.githubusercontent.com/u/9568094?v=4',
  name: 'Jarvis'
});
initShadow(document.querySelector('#info2'), { 
  isOpen: true,
  avatar: 'https://avatars1.githubusercontent.com/u/9568094?v=4',
  name: 'Jarvis' 
})

 

這樣就實現了一個簡單的組件，能夠在須要用到的地方，直接傳入一個掛載的DOM便可。

custom-elements

就像上邊的shadow-DOM，已經在文檔樹中看不到組件的細節了，任何代碼也都不會影響到它的結構（open模式下的獲取root操做除外）。
可是，這樣在文檔中是存在一個用來掛在shadow-DOM的根元素，這個根元素依然是一個普通的HTML標籤。
若是是一個大型頁面中，存在了N多相似的組件，搜索一下，全是<div></div>，這個體驗實際上是很痛苦的，基本是毫無語義化。
並且咱們想要使用這個組件時，還必須額外的調用JavaScript來獲取DOM元素生成對應的shadow-DOM。
因此，咱們能夠嘗試用custom-elements來註冊本身獨有的標籤。
簡單的經過<my-tag>的方式來調用自定義組件。

custom-elements支持同時支持普通標籤的封裝以及shadow-DOM的封裝，但二者不能共存。

基本語法

首先咱們須要有一個繼承了HTMLElement的類。
而後須要將其註冊到當前環境中。

class Info extends HTMLElement {}

customElements.define(
  'cus-info', // 標籤名
  Info        // 標籤對應的構造函數
)

 

在調用define時還有一個可選的第三個參數，用來設置自定義標籤繼承自某個原生標籤。
二者在後續的標籤使用上稍微有些區別：

<!-- 若是設置了 { extends: 'p' } -->
<p is="cus-info" />
<script>
  document.createElement('p', { is: 'cus-info' })
</script>
<!-- 沒有設置 extends 的狀況 -->
<info />
<script>
  document.createElement('cus-info') // 必需要包含一個`-`
</script>

 

P.S. 自定義的標籤的註冊名至少要包含一個-
結合場景來選擇是否使用extends，我的不建議使用，由於看起來會舒服一些

普通標籤的方式

若是是針對普通的一組標籤進行封裝，就是解決了一些相同功能的組件須要在頁面中粘來粘去的問題。

在線demo
源碼地址

<cus-info>
  <p>native text</p>
  <!-- 默認是能夠直接嵌套的，除非在自定義組件中移除 -->
</cus-info>
<script>
  class CusInfo extends HTMLElement {
    constructor() {
      super()

      let $text = document.createElement('p')
      $text.innerHTML = 'Hello custom-elements.'

      this.appendChild($text) // this表明當前自定義元素的實例
    }
  }

  customElements.define('cus-info', CusInfo)
</script>

 

實現相似這樣的效果：

shadow-DOM的使用方式

P.S. 當一個元素激活了shadow-DOM之後，裏邊的普通子元素都會變得不可見，可是使用DOM API依然能夠獲取到

在線demo
源碼地址

<cus-info>
  <p>native text</p>
  <!-- 默認是能夠直接嵌套的，除非在自定義組件中移除 -->
</cus-info>
<script>
  class CusInfo extends HTMLElement {
    constructor() {
      super()

      let $shadow = this.attachShadow({ mode: 'open' })
      let $text = document.createElement('p')
      $text.innerHTML = 'Hello custom-elements.'

      $shadow.appendChild($text)
    }
  }

  customElements.define('cus-info', CusInfo)
  console.log(document.querySelector('cus-info').children[0].innerHTML) // native text
</script>

 

生命週期函數

自定義標籤並不僅是一個讓你多了一個標籤能夠用。
註冊的自定義標籤是有一些生命週期函數能夠設置的，目前有效的事件爲：

  • connectedCallback 標籤被添加到文檔流中觸發
  • disconnectedCallback 標籤被從文檔流中移除時觸發
  • adoptedCallback 標籤被移動時觸發，現有的API貌似沒有一個能夠觸發這個事件的，由於像appendChild或者insertBefore這一類的，對於已經存在的DOM元素都是先移除後新增的，因此不存在有直接移動的行爲
  • attributeChangedCallback 增刪改元素屬性時會觸發 須要提早設置observedAttributes，才能監聽對應的屬性變化

一個觸發各類事件的簡單示例：

在線demo
源碼地址

<div id="wrap">
  <div id="content"></div>
</div>
<script>
  class CusTag extends HTMLElement {
    static get observedAttributes() { return ['id'] } // 設置監聽哪些屬性變化
    connectedCallback () { console.log('DOM被添加到文檔中') }
    disconnectedCallback () { console.log('DOM被從文檔中移除') }
    adoptedCallback () { console.log('DOM被移動') }
    attributeChangedCallback () { console.log('DOM屬性有修改') }
  }

  customElements.define('cus-tag', CusTag)

  let $wrap = document.querySelector('#wrap')
  let $content = document.querySelector('#content')
  let $tag = document.createElement('cus-tag')

  $wrap.appendChild($tag)
  $content.appendChild($tag)
  $tag.setAttribute('id', 'tag-id')
  $tag.setAttribute('id', 'tag-id2')
  $tag.removeAttribute('id')
  $content.removeChild($tag)
</script>

 

P.S. 若是須要處理DOM結構以及綁定事件，推薦在connectedCallback回調中執行
想要attributeChangedCallback生效，必須設置observedAttributes來返回該標籤須要監聽哪些屬性的改變

使用自定義標籤封裝資料卡組件

接下來就是使用custome-elements結合着shadow-DOM來完成資料卡的一個簡單封裝。
由於shadow-DOM版本的組件相對更獨立一些，因此這裏採用的是shadow-DOM的方式進行封裝。
大體代碼以下：

在線demo
源碼地址

<info-card name="Jarvis" avatar="https://avatars1.githubusercontent.com/u/9568094?v=4" />
<!-- P.S. 這裏會觸發一個Chrome67版本的一個隱藏bug -->
<script>
  class InfoCard extends HTMLElement {
    connectedCallback () {
      // 穩妥的方式是在肯定標籤已經被添加到DOM中在進行渲染
      let avatar = this.getAttribute('avatar')
      let name = this.getAttribute('name')
      initShadow(this, { avatar, name })
    }
  }

  customElements.define('info-card', InfoCard)
</script>

 

針對上邊的initShadow調用也只是更換了avatar和name字段的來源罷了。
如今，咱們須要在頁面中使用封裝好的資料卡，僅僅須要註冊一個自定義標籤，而後在HTML中寫對應的標籤代碼便可

再開一下腦洞

由於是採用了註冊html標籤的方式，其實這個是對採用Server端模版渲染特別友好的一件事兒。
若是有使用服務端渲染的頁面，可能會動態的拼接一些DOM元素到請求的返回值中。
爲了應用一些樣式，可能須要在模版中添加各類className，也頗有可能手一抖之類的就會致使標籤沒有閉合、結構錯亂，或者某些屬性拼寫出錯，各類233的問題。
好比插入一些表單元素，以前多是這樣的代碼：

router.get('/', ctx => {
  ctx.body = `
    <body>
      <form>
        <div class="form-group">
          <label for="account">Account</label>
          <input id="account" placholder="put account" />
        </div>
        <div class="form-group">
          <label for="password">Account</label>
          <input id="password" placholder="put password" type="password" />
        </div>
        <button>Login</button>
      </form>
    </body>
  `
})

 

在使用了custom-elements之後，Server端的記憶成本也會下降不少。
Server端只須要代表這裏有一個表單元素就夠了，具體渲染成什麼樣，仍是交由前端來決定。

router.get('/', ctx => {
  ctx.body = `
    <body>
      <form>
        <form-field id="account" label="Account" placholder="put account" />
        <form-field id="password" label="Password" placholder="put password" type="password" />
        <form-login />
      </form>
    </body>
  `
})

 

custom-events

若是在頁面中使用不少的自定義組件，必然會遇到組件之間的通信問題的。
好比我一個按鈕點擊了之後如何觸發其餘組件的行爲。
由於是純原生的版本，因此自然的支持addEventListener，咱們能夠直接使用custom-events來完成組件之間的通信。

基本語法

使用自定義事件與原生DOM事件惟一的區別就在於須要本身構建Event實例並觸發事件：

document.body.addEventListener('ping', _ => console.log('pong')) // 設置事件監聽

document.body.dispatchEvent(new Event('ping')) // 觸發事件

 

自定義組件中的使用

如今頁面中有兩個組件，一個容器，容器中包含一個文本框和數個按鈕，點擊按鈕之後會將按鈕對應的文字輸出到文本框中：

在線demo
源碼地址

<cus-list>
  <input id="output" />
  <cus-btn data-text="Button 1"></cus-btn>
  <cus-btn data-text="Button 2"></cus-btn>
  <cus-btn data-text="Button 3"></cus-btn>
</cus-list>
<script>
  class CusList extends HTMLElement {
    connectedCallback() {
      let $output = this.querySelector('#output')
      Array.from(this.children).forEach(item => {
        if (item.tagName.toLowerCase() === 'cus-btn') {
          item.addEventListener('check', event => { // 註冊自定義事件的監聽
            $output.value = event.target.innerText
          })
        }
      })
    }
  }
  class CusBtn extends HTMLElement {
    connectedCallback() {
      let { text } = this.dataset

      let $text = document.createElement('p')
      $text.innerHTML = text

      $text.addEventListener('click', _ => {
        this.dispatchEvent(new Event('check')) // 觸發自定義事件
      })

      this.appendChild($text)
    }
  }

  customElements.define('cus-list', CusList)
  customElements.define('cus-btn', CusBtn)
</script>

 

上邊是在List中循環了本身的子節點，而後依次綁定事件，這種處理是低效的，並且是不靈活的。
若是有新增的子元素，則沒法觸發對應的事件。
因此，咱們能夠開啓事件的冒泡來簡化上邊的代碼：

在線demo
源碼地址

class CusList extends HTMLElement {
  connectedCallback() {
    let $output = this.querySelector('#output')

    this.addEventListener('check', event => { // 註冊自定義事件的監聽
      $output.value = event.target.innerText // 效果同樣，由於event.target就是觸發dispatchEvent的那個DOM對象
    })
  }
}
class CusBtn extends HTMLElement {
  connectedCallback() {
    let { text } = this.dataset

    let $text = document.createElement('p')
    $text.innerHTML = text

    $text.addEventListener('click', _ => {
      this.dispatchEvent(new Event('check'), {
        bubbles: true // 啓用事件冒泡
      }) // 觸發自定義事件
    })

    this.appendChild($text)
  }
}

 

ES-module

ES-module是原生模塊化的一種實現，使用ES-module可讓咱們上邊組件的調用變得更方便。
這裏有以前的一篇講解ES-module的文章：傳送陣
因此，再也不贅述一些module相關的基礎，直接將封裝好的組件代碼挪到一個js文件中，而後在頁面中引用對應的js文件完成調用。

在線demo
源碼地址

module.js

export default class InfoCard extends HTMLElement { }

customElements.define('info-card', InfoCard)

 

index.html

<info-card name="Jarvis" avatar="https://avatars1.githubusercontent.com/u/9568094?v=4"></info-card>
<script type="module" src="./cus-elements-info-card.js"></script>

 

第一眼看上去，這樣作好像與普通的js腳本引入並無什麼區別。
確實單純的寫這一個組件的話，是沒有什麼區別的。

可是一個現實中的頁面，不會只有這麼一個組件的，假設有這樣的一個頁面，其中包含了三個組件：

<cus-tab>
  <cus-list>
    <cus-card />
    <cus-card />
  </cus-list>
  <cus-list>
    <cus-card />
    <cus-card />
  </cus-list>
</cus-tab>

 

咱們在使用list時要保證card已經加載完成，在使用tab時要保證list已經加載完成。
最簡單的方法就是等到全部的資源所有加載完成後再執行代碼，主流的webpack打包就是這麼作的。
可是，這樣作帶來的後果就是，明明list和card加載完畢後就能夠處理本身的邏輯，註冊自定義標籤了，卻仍是要等外層的tab加載完畢後再執行代碼。
這個在使用webpack打包的React和Vue這類框架上邊就是很明顯的問題，若是打包完的js文件過大，幾百k，甚至數兆。
須要等到這個文件所有下載完畢後纔會開始運行代碼，構建頁面。

咱們徹底能夠利用下載其餘組件時的空白期來執行當前組件的一些邏輯，而使用webpack這類打包工具卻不能作到，這很顯然是一個時間上的浪費，而ES-module已經幫忙處理了這件事兒，module代碼的執行是創建在全部的依賴所有加載完畢的基礎上的。

當card和list加載完畢後，list就會開始執行代碼。而此時的tab可能還在加載過程當中，等到tab加載完畢開始執行時，list已經註冊到了document上，就等着被調用了，從某種程度上打散了代碼執行過於集中的問題。
可能以前頁面加載有200ms在下載文件，有50ms在構建組件，50ms渲染頁面（數值純屬扯淡，僅用於舉例）。
有些組件比較輕量級，可能用了20ms就已經下載完了文件，若是它沒有依賴其餘的module，這時就會開始執行自身組件的一些代碼，生成構造函數、註冊自定義組件到文檔中，而這些步驟執行的過程當中可能瀏覽器還在下載其餘的module，因此這就是兩條並行的線了，讓一部分代碼執行的時間和網絡請求消耗的時間所重疊。

舉一個現實中的例子：
你開了一家飯店，僱傭了三個廚師，一個作番茄炒蛋、一個作皮蛋豆腐、還有一個作拍黃瓜，由於場地有限，因此三個廚師共用一套炊具。（單線程）
今天第一天開業，這時候來了客人點了這三樣菜，可是菜還在路上。
webpack：「西紅柿、雞蛋、皮蛋、豆腐、黃瓜」全放到一塊給你送過來，送到了之後，三個廚師輪着作，而後給客人端過去。
ES-module：分撥送，什麼菜先送過來就先作哪一個，哪一個先作完給客人端哪一個。

一個簡單的組件嵌套示例

在線demo
源碼地址

cus-elements-info-list.js

import InfoCard from './cus-elements-info-card.js'

export default class InfoList extends HTMLElement {
  connectedCallback() {
    // load data
    let data = [
      {
        avatar: 'https://avatars1.githubusercontent.com/u/9568094?v=4',
        name: 'Jarvis'
      },
      {
        avatar: 'https://avatars1.githubusercontent.com/u/9568094?v=4',
        name: 'Jarvis'
      },
      {
        avatar: 'https://avatars1.githubusercontent.com/u/9568094?v=4',
        name: 'Jarvis'
      }
    ]
    // laod data end

    initShadow(this, { data })
  }
}

function initShadow($host, { data, isOpen }) {
  let $shadow = $host.attachShadow({ mode: isOpen ? 'open' : 'closed' })

  let $style = document.createElement('style')
  let $wrap = document.createElement('div')

  $style.textContent = `
    .list { display: flex; flex-direction: column; }
  `

  $wrap.className = 'list'

  // loop create
  data.forEach(item => {
    let $item = new InfoCard()
    $item.setAttribute('avatar', item.avatar)
    $item.setAttribute('name', item.name)

    $wrap.appendChild($item)
  })

  $shadow.appendChild($style)
  $shadow.appendChild($wrap)
}

customElements.define('info-list', InfoList)

 

<info-list></info-list>
<script type="module" src="./cus-elements-info-list.js"></script>

 

new Component與document.createElement效果同樣，用於在不知道組件的註冊名的狀況下使用

總結

一些小提示

  1. shadow-DOM沒法與普通的子元素共存，設置attachShadow之後會致使普通子元素在頁面不可見，可是DOM依然保留
  2. custom-elements的註冊名必需要包含一個-
  3. custom-elements的constructor函數觸發時不能保證DOM已經正確渲染完畢，對DOM進行的操做應該放到connectedCallback中
  4. custom-elements組件的屬性變化監聽須要提早配置observedAttributes，沒有通配符之類的操做
  5. ES-module相關的操做只能在type="module"中進行
  6. ES-module的引用是共享的，即便十個文件都import了同一個JS文件，他們拿到的都是同一個對象，不用擔憂浪費網絡資源

一個簡單的TODO-LIST的實現：

在線demo
源碼地址

瀏覽器原生支持的功能愈來愈豐富，ES-module、custom-elements、shadow-DOM以及各類新鮮的玩意兒；
web原生的組件化、模塊化，期待着普及的那一天，就像如今能夠放肆的使用qsa 、fetch，而不用考慮是否須要引入jQuery來幫助作兼容同樣（大部分狀況下）。

參考資料

  1. shadow-DOM | MDN
  2. custom-elements | MDN
  3. custom-events | MDN
  4. ES-module | MDN

文中全部示例的倉庫地址

倉庫地址

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程