了解CSS Module作用域隔離原理
CSS Module出現(xiàn)的背景?
我們知道,Javascript發(fā)展到現(xiàn)在出現(xiàn)了眾多模塊化規(guī)范,比如AMD、CMD、 Common JS、ESModule等,這些模塊化規(guī)范能夠讓我們的JS實(shí)現(xiàn)作用域隔離。但CSS卻并沒有這么幸運(yùn),發(fā)展到現(xiàn)在卻一直沒有模塊化規(guī)范,由于CSS是 根據(jù)選擇器去全局匹配元素的,所以入鍋你在頁面的兩個(gè)不同的地方定義了一個(gè)相同的類名,先定義的樣式就會(huì)被后定義的覆蓋掉。由于這個(gè)原因,CSS的命名沖突一直困擾著前端人員。
這種現(xiàn)狀是前端開發(fā)者不能接受的,所以CSS社區(qū)也誕生了各種各樣的CSS模塊化解決方案(這并不是規(guī)范),比如:
- 「命名方法:」人為約定命名規(guī)則
- 「scoped:」vue中常見隔離方式
- 「CSS Module:」 每個(gè)文件都是一個(gè)獨(dú)立的模塊
- 「CSS-in-JS:」這個(gè)常見于react、 JSX中
現(xiàn)在來看CSS Module是目前最為流行的一種解決方案,它能夠與CSS預(yù)處理器搭配使用在各種框架中。
CSS Module?
CSS Module的流行源于React社區(qū),它獲得了社區(qū)的迅速采用,后面由于Vue-cli對其集成后開箱即用的支持,將其推到了一個(gè)新高度。
局部作用域
在w3c 規(guī)范中,CSS 始終是「全局生效的」。在傳統(tǒng)的 web 開發(fā)中,最為頭痛的莫過于處理 CSS 問題。因?yàn)槿中?,明明定義了樣式,但就是不生效,原因可能是被其他樣式定義所強(qiáng)制覆蓋。
產(chǎn)生局部作用域的唯一方法就是為樣式取一個(gè)獨(dú)一無二的名字,CSS Module也就是用這個(gè)方法來實(shí)現(xiàn)作用域隔離的。
在CSS Module中可以使用:local(className)來聲明一個(gè)局部作用域的CSS規(guī)則。
CSS Module會(huì)對:local()包含的選擇器做localIdentName規(guī)則處理,也就是為其生成一個(gè)唯一的選擇器名稱,以達(dá)到作用域隔離的效果。
以上css經(jīng)過編譯后會(huì)生成這樣的代碼:
這里的:export是CSS Module為解決導(dǎo)出而新增的偽類,后面再進(jìn)行介紹。
全局作用域
當(dāng)然CSS Module也允許使用:global(className)來聲明一個(gè)全局作用域的規(guī)則。
而對于:global()包含的選擇器CSS Module則不會(huì)做任何處理,因?yàn)镃SS規(guī)則默認(rèn)就是全局的。
或許很多了會(huì)好奇我們在開發(fā)過程好像很少使用到:local(),比如在vue中,我們只要在style標(biāo)簽上加上module就能自動(dòng)達(dá)到作用域隔離的效果。
是的,為了我們開發(fā)過程方便,postcss-modules-local-by-default插件已經(jīng)默認(rèn)幫我們處理了這一步,只要我們開啟了CSS模塊化,里面的CSS在編譯過程會(huì)默認(rèn)加上:local()。
Composing(組合)
組合的意思就是一個(gè)選擇器可以繼承另一個(gè)選擇器的規(guī)則。
繼承當(dāng)前文件內(nèi)容
繼承其它文件
Composes 還可以繼承外部文件中的樣式
編譯后會(huì)生成如下代碼:
導(dǎo)入導(dǎo)出
從上面的這些編譯結(jié)果我們會(huì)發(fā)現(xiàn)有兩個(gè)我們平時(shí)沒用過的偽類::import、:export。
CSS Module 內(nèi)部通過ICSS來解決CSS的導(dǎo)入導(dǎo)出問題,對應(yīng)的就是上面兩個(gè)新增的偽類。
Interoperable CSS (ICSS) 是標(biāo)準(zhǔn) CSS 的超集。
:import
語句:import允許從其他 CSS 文件導(dǎo)入變量。它執(zhí)行以下操作:
- 獲取并處理依賴項(xiàng)
- 根據(jù)導(dǎo)入的令牌解析依賴項(xiàng)的導(dǎo)出,并將它們匹配到localAlias
- 在當(dāng)前文件中的某些地方(如下所述)查找和替換使用localAlias依賴項(xiàng)的exportedValue.
:export
一個(gè):export塊定義了將要導(dǎo)出給消費(fèi)者的符號(hào)??梢哉J(rèn)為它在功能上等同于以下 JS:
語法上有以下限制:export:
- 它必須在頂層,但可以在文件中的任何位置。
- 如果一個(gè)文件中有多個(gè),則將鍵和值組合在一起并一起導(dǎo)出。
- 如果exportedKey重復(fù)某個(gè)特定項(xiàng),則最后一個(gè)(按源順序)優(yōu)先。
- AnexportedValue可以包含對 CSS 聲明值有效的任何字符(包括空格)。
- exportedValue不需要引用an ,它已被視為文字字符串。
以下是輸出可讀性所需要的,但不是強(qiáng)制的:
應(yīng)該只有一個(gè):export塊
它應(yīng)該位于文件的頂部,但在任何:import塊之后
CSS Module原理?
大概了解完CSS Module語法后,我們可以再來看看它的內(nèi)部實(shí)現(xiàn),以及它的核心原理 —— 作用域隔離。
一般來講,我們平時(shí)在開發(fā)中使用起來沒有這么麻煩,比如我們在vue項(xiàng)目中能夠做到開箱即用,最主要的插件就是css-loader,我們可以從這里入手一探究竟。
「這里大家可以思考下,?css-loader主要會(huì)依賴哪些庫來進(jìn)行處理?」
我們要知道,CSS Module新增的這些語法其實(shí)并不是CSS 內(nèi)置語法,那么它就一定需要進(jìn)行編譯處理
那么編譯CSS我們最先想到的是哪個(gè)庫?
postcss對吧?它對于CSS就像Babel對于javascript
可以安裝css-loader來驗(yàn)證一下:
跟我們預(yù)期的一致,這里我們能看到幾個(gè)以postcss-module開頭的插件,這些應(yīng)該就是實(shí)現(xiàn)CSS Module的核心插件。
從上面這些插件應(yīng)該能看出哪個(gè)才是實(shí)現(xiàn)作用域隔離的吧
- Postcss-modules-extract-imports:導(dǎo)入導(dǎo)出功能
- Postcss-modules-local-by-default:默認(rèn)局部作用域
- Postcss-modules-scope:作用域隔離
- Posts-modules-values:變量功能
編譯流程
整個(gè)流程大體上跟Babel編譯javascript類似:parse ——> transform ——> stringier
與Babel不同的是,PostCSS自身只包括css分析器,css節(jié)點(diǎn)樹API,source map生成器以及css節(jié)點(diǎn)樹拼接器。
css的組成單元是一條一條的樣式規(guī)則(rule),每一條樣式規(guī)則又包含一個(gè)或多個(gè)屬性&值的定義。所以,PostCSS的執(zhí)行過程是,先css分析器讀取css字符內(nèi)容,得到一個(gè)完整的節(jié)點(diǎn)樹,接下來,對該節(jié)點(diǎn)樹進(jìn)行一系列轉(zhuǎn)換操作(基于節(jié)點(diǎn)樹API的插件),最后,由css節(jié)點(diǎn)樹拼接器將轉(zhuǎn)換后的節(jié)點(diǎn)樹重新組成css字符。期間可生成source map表明轉(zhuǎn)換前后的字符對應(yīng)關(guān)系。
CSS在編譯期間也是需要生成AST得,這點(diǎn)與Babel處理JS一樣。
AST
PostCSS的AST主要有以下這四種:
- rule: 選擇器開頭
- atrule: 以@開頭
- decl: 具體樣式規(guī)則
- comment: 注釋
與Babel類似,這些我們同樣可以使用工具來更清晰地了解CSS 的 AST:
- Root: 繼承自 Container。AST 的根節(jié)點(diǎn),代表整個(gè) css 文件
- AtRule: 繼承自 Container。以 @ 開頭的語句,核心屬性為 params,例如:@import url('./default.css'),params 為url('./default.css')
- Rule: 繼承自 Container。帶有聲明的選擇器,核心屬性為 selector,例如: .color2{},selector為.color2
- Comment: 繼承自 Node。標(biāo)準(zhǔn)的注釋/* 注釋 */ 節(jié)點(diǎn)包括一些通用屬性:
- type:節(jié)點(diǎn)類型
- parent:父節(jié)點(diǎn)
- source:存儲(chǔ)節(jié)點(diǎn)的資源信息,計(jì)算 sourcemap
- start:節(jié)點(diǎn)的起始位置
- end:節(jié)點(diǎn)的終止位置
- raws:存儲(chǔ)節(jié)點(diǎn)的附加符號(hào),分號(hào)、空格、注釋等,在 stringify 過程中會(huì)拼接這些附加符號(hào)
安裝體驗(yàn)
這些插件的功能我們都可以自己一一去體驗(yàn),我們先將這些主要的插件串聯(lián)起來試一試效果,再來自行實(shí)現(xiàn)一個(gè)Postcss-modules-scope插件
把這幾個(gè)核心插件集成進(jìn)來,我們會(huì)發(fā)現(xiàn),我們的css中的樣式不用再寫:local也能生成唯一hash名稱了,并且也能夠?qū)肫渌募臉邮搅恕_@主要是依靠postcss-modules-local-by-default、postcss-modules-extract-imports兩個(gè)插件。
編寫插件
現(xiàn)在我們就自己來實(shí)現(xiàn)一下類似postcss-modules-scope的插件吧,其實(shí)原理很簡單,就是遍歷AST,為選擇器生成一個(gè)唯一的名字,并將其與選擇器的名稱維護(hù)在exports里面。
主要API
說到遍歷AST,與Babel相似Post CSS也同樣提供了很多API用于操作AST:
- 「walk:」
- 「??walkAtRules:」 遍歷所有atrule 類型節(jié)點(diǎn)
- 「walkRules:」 遍歷所有rule類型節(jié)點(diǎn)
- walkComments: comment 類型節(jié)點(diǎn)
- 「walkDecls:」 遍歷所有 decl類型節(jié)點(diǎn)
(更多內(nèi)容可在postcss文檔上查看)
有了這些API我們處理AST就非常方便了
插件格式
編寫PostCSS插件與Babel類似,我們只需要按照它的規(guī)范進(jìn)行處理AST就行,至于它的編譯以及目標(biāo)代碼生成我們都不需要關(guān)心。