CSS Module出現(xiàn)的背景?
我們知道，Javascript發(fā)展到現(xiàn)在出現(xiàn)了眾多模塊化規(guī)范，比如AMD、CMD、 Common JS、ESModule等，這些模塊化規(guī)范能夠讓我們的JS實現(xiàn)作用域隔離。但CSS卻并沒有這么幸運，發(fā)展到現(xiàn)在卻一直沒有模塊化規(guī)范，由于CSS是 根據(jù)選擇器去全局匹配元素的，所以入鍋你在頁面的兩個不同的地方定義了一個相同的類名，先定義的樣式就會被后定義的覆蓋掉。由于這個原因，CSS的命名沖突一直困擾著前端人員。
這種現(xiàn)狀是前端開發(fā)者不能接受的，所以CSS社區(qū)也誕生了各種各樣的CSS模塊化解決方案（這并不是規(guī)范），比如：
- 「命名方法：」人為約定命名規(guī)則
- 「scoped：」vue中常見隔離方式
- 「CSS Module：」 每個文件都是一個獨立的模塊
- 「CSS-in-JS：」這個常見于react、 JSX中
現(xiàn)在來看CSS Module是目前最為流行的一種解決方案，它能夠與CSS預(yù)處理器搭配使用在各種框架中。
CSS Module?
CSS Module的流行源于React社區(qū)，它獲得了社區(qū)的迅速采用，后面由于Vue-cli對其集成后開箱即用的支持，將其推到了一個新高度。
局部作用域
在w3c 規(guī)范中，CSS 始終是「全局生效的」。在傳統(tǒng)的 web 開發(fā)中，最為頭痛的莫過于處理 CSS 問題。因為全局性，明明定義了樣式，但就是不生效，原因可能是被其他樣式定義所強制覆蓋。
產(chǎn)生局部作用域的唯一方法就是為樣式取一個獨一無二的名字，CSS Module也就是用這個方法來實現(xiàn)作用域隔離的。
在CSS Module中可以使用:local(className)來聲明一個局部作用域的CSS規(guī)則。
:local(.qd_btn) {
border-radius: 8px;
color: #fff;
}
:local(.qd_btn):nth(1) {
color: pink;
}
:local(.qd_title) {
font-size: 20px;
}CSS Module會對:local()包含的選擇器做localIdentName規(guī)則處理，也就是為其生成一個唯一的選擇器名稱，以達到作用域隔離的效果。
以上css經(jīng)過編譯后會生成這樣的代碼：
這里的:export是CSS Module為解決導(dǎo)出而新增的偽類，后面再進行介紹。
全局作用域
當然CSS Module也允許使用:global(className)來聲明一個全局作用域的規(guī)則。
:global(.qd_text) {
color: chocolate;
}而對于:global()包含的選擇器CSS Module則不會做任何處理，因為CSS規(guī)則默認就是全局的。
或許很多了會好奇我們在開發(fā)過程好像很少使用到:local()，比如在vue中，我們只要在style標簽上加上module就能自動達到作用域隔離的效果。
是的，為了我們開發(fā)過程方便，postcss-modules-local-by-default插件已經(jīng)默認幫我們處理了這一步，只要我們開啟了CSS模塊化，里面的CSS在編譯過程會默認加上:local()。
Composing(組合)
組合的意思就是一個選擇器可以繼承另一個選擇器的規(guī)則。
繼承當前文件內(nèi)容
:local(.qd_btn) {
border-radius: 8px;
color: #fff;
}
:local(.qd_title) {
font-size: 20px;
composes: qd_btn;
}
繼承其它文件
Composes 還可以繼承外部文件中的樣式
/* a.css */
:local(.a_btn) {
border: 1px solid salmon;
}
/** default.css **/
.qd_box {
border: 1px solid #ccc;
composes: a_btn from 'a.css'
}
編譯后會生成如下代碼：
導(dǎo)入導(dǎo)出
從上面的這些編譯結(jié)果我們會發(fā)現(xiàn)有兩個我們平時沒用過的偽類：:import、:export。
CSS Module 內(nèi)部通過ICSS來解決CSS的導(dǎo)入導(dǎo)出問題，對應(yīng)的就是上面兩個新增的偽類。
Interoperable CSS (ICSS) 是標準 CSS 的超集。
:import
語句:import允許從其他 CSS 文件導(dǎo)入變量。它執(zhí)行以下操作：
- 獲取并處理依賴項
- 根據(jù)導(dǎo)入的令牌解析依賴項的導(dǎo)出，并將它們匹配到localAlias
- 在當前文件中的某些地方（如下所述）查找和替換使用localAlias依賴項的exportedValue.
:export
一個:export塊定義了將要導(dǎo)出給消費者的符號。可以認為它在功能上等同于以下 JS：
module.exports = {
"exportedKey": "exportedValue"
}語法上有以下限制:export：
- 它必須在頂層，但可以在文件中的任何位置。
- 如果一個文件中有多個，則將鍵和值組合在一起并一起導(dǎo)出。
- 如果exportedKey重復(fù)某個特定項，則最后一個（按源順序）優(yōu)先。
- AnexportedValue可以包含對 CSS 聲明值有效的任何字符（包括空格）。
- exportedValue不需要引用an ，它已被視為文字字符串。
以下是輸出可讀性所需要的，但不是強制的：
應(yīng)該只有一個:export塊
它應(yīng)該位于文件的頂部，但在任何:import塊之后
CSS Module原理?
大概了解完CSS Module語法后，我們可以再來看看它的內(nèi)部實現(xiàn)，以及它的核心原理 —— 作用域隔離。
一般來講，我們平時在開發(fā)中使用起來沒有這么麻煩，比如我們在vue項目中能夠做到開箱即用，最主要的插件就是css-loader，我們可以從這里入手一探究竟。
「這里大家可以思考下，?css-loader主要會依賴哪些庫來進行處理？」
我們要知道，CSS Module新增的這些語法其實并不是CSS 內(nèi)置語法，那么它就一定需要進行編譯處理
那么編譯CSS我們最先想到的是哪個庫？
postcss對吧？它對于CSS就像Babel對于javascript
可以安裝css-loader來驗證一下:
跟我們預(yù)期的一致，這里我們能看到幾個以postcss-module開頭的插件，這些應(yīng)該就是實現(xiàn)CSS Module的核心插件。
從上面這些插件應(yīng)該能看出哪個才是實現(xiàn)作用域隔離的吧
- Postcss-modules-extract-imports：導(dǎo)入導(dǎo)出功能
- Postcss-modules-local-by-default：默認局部作用域
- Postcss-modules-scope：作用域隔離
- Posts-modules-values：變量功能
編譯流程
整個流程大體上跟Babel編譯javascript類似：parse ——> transform ——> stringier
與Babel不同的是，PostCSS自身只包括css分析器，css節(jié)點樹API，source map生成器以及css節(jié)點樹拼接器。
css的組成單元是一條一條的樣式規(guī)則（rule），每一條樣式規(guī)則又包含一個或多個屬性&值的定義。所以，PostCSS的執(zhí)行過程是，先css分析器讀取css字符內(nèi)容，得到一個完整的節(jié)點樹，接下來，對該節(jié)點樹進行一系列轉(zhuǎn)換操作（基于節(jié)點樹API的插件），最后，由css節(jié)點樹拼接器將轉(zhuǎn)換后的節(jié)點樹重新組成css字符。期間可生成source map表明轉(zhuǎn)換前后的字符對應(yīng)關(guān)系。
CSS在編譯期間也是需要生成AST得，這點與Babel處理JS一樣。
AST
PostCSS的AST主要有以下這四種：
#main {
border: 1px solid black;
}@media screen and (min-width: 480px) {
body {
background-color: lightgreen;
}
}與Babel類似，這些我們同樣可以使用工具來更清晰地了解CSS 的 AST：
- Root: 繼承自 Container。AST 的根節(jié)點，代表整個 css 文件
- AtRule: 繼承自 Container。以 @ 開頭的語句，核心屬性為 params，例如：@import url('./default.css')，params 為url('./default.css')
- Rule: 繼承自 Container。帶有聲明的選擇器，核心屬性為 selector，例如： .color2{}，selector為.color2
- Comment: 繼承自 Node。標準的注釋/* 注釋 */ 節(jié)點包括一些通用屬性:
- type：節(jié)點類型
- parent：父節(jié)點
- source：存儲節(jié)點的資源信息，計算 sourcemap
- start：節(jié)點的起始位置
- end：節(jié)點的終止位置
- raws：存儲節(jié)點的附加符號，分號、空格、注釋等，在 stringify 過程中會拼接這些附加符號
安裝體驗
npm i postcss postcss-modules-extract-imports postcss-modules-local-by-default postcss-modules-scope postcss-selector-parser
這些插件的功能我們都可以自己一一去體驗，我們先將這些主要的插件串聯(lián)起來試一試效果，再來自行實現(xiàn)一個Postcss-modules-scope插件
(async () => {
const css = await getCode('./css/default.css')
const pipeline = postcss([
postcssModulesLocalByDefault(),
postcssModulesExtractImports(),
postcssModulesScope()
])
const res = pipeline.process(css)
console.log('【output】', res.css)
})()把這幾個核心插件集成進來，我們會發(fā)現(xiàn)，我們的css中的樣式不用再寫:local也能生成唯一hash名稱了，并且也能夠?qū)肫渌募臉邮搅恕＿@主要是依靠postcss-modules-local-by-default、postcss-modules-extract-imports兩個插件。
/* default.css */
.qd_box {
border: 1px solid #ccc;
composes: a_btn from 'a.css'
}
.qd_header {
display: flex;
justify-content: center;
align-items: center;
width: 100%;
composes: qd_box;
}
.qd_box {
background: coral;
}
編寫插件
現(xiàn)在我們就自己來實現(xiàn)一下類似postcss-modules-scope的插件吧，其實原理很簡單，就是遍歷AST，為選擇器生成一個唯一的名字，并將其與選擇器的名稱維護在exports里面。
主要API
說到遍歷AST，與Babel相似Post CSS也同樣提供了很多API用于操作AST：
- 「walk:」
- 「??walkAtRules:」 遍歷所有atrule 類型節(jié)點
- 「walkRules:」 遍歷所有rule類型節(jié)點
- walkComments: comment 類型節(jié)點
- 「walkDecls:」 遍歷所有 decl類型節(jié)點
(更多內(nèi)容可在postcss文檔上查看)
有了這些API我們處理AST就非常方便了
插件格式
編寫PostCSS插件與Babel類似，我們只需要按照它的規(guī)范進行處理AST就行，至于它的編譯以及目標代碼生成我們都不需要關(guān)心。
const plugin = (options = {}) => {
return {
postcssPlugin: 'plugin name',
Once(root) {
// 每個文件都會調(diào)用一次，類似Babel的visitor
}
}
}
plugin.postcss = true
module.exports = plugin核心代碼
const selectorParser = require("postcss-selector-parser");
// 隨機生成一個選擇器名稱
const createScopedName = (name) => {
const randomStr = Math.random().toString(16).slice(2);
return `_${randomStr}__${name}`;
}
const plugin = (options = {}) => {
return {
postcssPlugin: 'css-module-plugin',
Once(root, helpers) {
const exports = {};
// 導(dǎo)出 scopedName
function exportScopedName(name) {
// css名稱與其對應(yīng)的作用域名城的映射
const scopedName = createScopedName(name);
exports[name] = exports[name] || [];
if (exports[name].indexOf(scopedName) < 0) {
exports[name].push(scopedName);
}
return scopedName;
}
// 本地節(jié)點，也就是需要作用域隔離的節(jié)點:local()
function localizeNode(node) {
switch (node.type) {
case "selector":
node.nodes = node.map(localizeNode);
return node;
case "class":
return selectorParser.className({
value: exportScopedName(
node.value,
node.raws && node.raws.value ? node.raws.value : null
),
});
case "id": {
return selectorParser.id({
value: exportScopedName(
node.value,
node.raws && node.raws.value ? node.raws.value : null
),
});
}
}
}
// 遍歷節(jié)點
function traverseNode(node) {
// console.log('【node】', node)
if(options.module) {
const selector = localizeNode(node.first, node.spaces);
node.replaceWith(selector);
return node
}
switch (node.type) {
case "root":
case "selector": {
node.each(traverseNode);
break;
}
// 選擇器
case "id":
case "class":
exports[node.value] = [node.value];
break;
// 偽元素
case "pseudo":
if (node.value === ":local") {
const selector = localizeNode(node.first, node.spaces);
node.replaceWith(selector);
return;
}else if(node.value === ":global") {
}
}
return node;
}
// 遍歷所有rule類型節(jié)點
root.walkRules((rule) => {
const parsedSelector = selectorParser().astSync(rule);
rule.selector = traverseNode(parsedSelector.clone()).toString();
// 遍歷所有decl類型節(jié)點 處理 composes
rule.walkDecls(/composes|compose-with/i, (decl) => {
const localNames = parsedSelector.nodes.map((node) => {
return node.nodes[0].first.first.value;
})
const classes = decl.value.split(/\s+/);
classes.forEach((className) => {
const global = /^global\(([^)]+)\)$/.exec(className);
// console.log(exports, className, '-----')
if (global) {
localNames.forEach((exportedName) => {
exports[exportedName].push(global[1]);
});
} else if (Object.prototype.hasOwnProperty.call(exports, className)) {
localNames.forEach((exportedName) => {
exports[className].forEach((item) => {
exports[exportedName].push(item);
});
});
} else {
console.log('error')
}
});
decl.remove();
});
});
// 處理 @keyframes
root.walkAtRules(/keyframes$/i, (atRule) => {
const localMatch = /^:local\((.*)\)$/.exec(atRule.params);
if (localMatch) {
atRule.params = exportScopedName(localMatch[1]);
}
});
// 生成 :export rule
const exportedNames = Object.keys(exports);
if (exportedNames.length > 0) {
const exportRule = helpers.rule({ selector: ":export" });
exportedNames.forEach((exportedName) =>
exportRule.append({
prop: exportedName,
value: exports[exportedName].join(" "),
raws: { before: "\n " },
})
);
root.append(exportRule);
}
},
}
}
plugin.postcss = true
module.exports = plugin使用
(async () => {
const css = await getCode('./css/index.css')
const pipeline = postcss([
postcssModulesLocalByDefault(),
postcssModulesExtractImports(),
require('./plugins/css-module-plugin')()
])
const res = pipeline.process(css)
console.log('【output】', res.css)
})()
