【CSS模块化】(1) webpack之Local Scope

CSS是一门15分钟就能入门,但是却需要很长很长的时间才能掌握好的语言。它有着它自身的一些复杂性与局限性。其中非常重要的一点就是,本身不具备模块化的能力。

面临的问题

你可能会说,CSS有@import功能。然而,我们都知道,这里的@import仅仅是表示引入相应的CSS文件,但其模块化核心问题并未解决——CSS文件中的任何一个选择器都会作用在整个文档范围里。

因此,其实我们面临的最大问题就是——所有的选择器都是在一个全局作用域内的。一旦引入一个新的CSS文件,就有着与预期不符的样式表现的风险(因为一些不可预测的选择器)。

而如今的前端项目规模越来越大,已经不是过去随便几个css、js文件就可以搞定的时代。与此同时的,对于一个大型的应用,前端开发团队往往也不再是一两个人。随着项目与团队规模的扩大,甚至是项目过程中人员的变动,如何更好进行代码开发的管理已经成为了一个重要问题。

回想一下,有多少次:

  • 我们讨论着如何对class进行有效的命名,以避免协作开发时的冲突;
  • 我们面对一段别人写的css、html代码,想要去修改,然后疯狂查找、猜测每个类都是什么作用,哪些是可以去掉的,哪些是可以修改的——到最后我们选择重新添加一个新的class;
  • 我们准备重构代码时,重构也就成了重写
  • ……

写一段CSS往往并不是困难所在,难得确实团队的合作与后续的维护。

针对这些实际项目中的问题,一直以来,开发者们都在探索解决方案。这一篇文章主要介绍了,如何在webpack中使用一种类似“CSS模块化”的解决方案———Local Scope,来规避一些开发中的问题。

什么是Local Scope

通常来说,CSS中的所有选择器可以算是“全局作用域”。而“Local Scope”顾名思义,使CSS具有类似于局部作用域的能力,同时搭配类似JavaScript中模块化的写法,到达CSS模块化的效果。

这么说可能有些抽象,我们可以来看一个例子。

在webpack中引入css往往是这样的:

// index.css
.title {
    font-size: 30px;
    color: #333;
}

// index.js
import './index.css';

funciont createTitle(str) {
    var title = document.createElement('h1');
    title.appendChild(document.createTextNode(str));
    title.setAttribute('class', 'title');
    document.body.appendChild(title);
}

createTitle('Hi!');

由于,webpack中将js、css、png等这些资源都视为模块,所以可以通过import导入。但是,实际上,对于导入的所有css,其“地位”都是平等的,都是在全局有效的。例如:

// index.css
.title {
    font-size: 30px;
    color: #333;
}

// other.css
.title {
    font-size: 15px;
    color: #999;
}

// index.js
import './index.css';
import './other.css';

funciont createTitle(str) {
    var title = document.createElement('h1');
    title.appendChild(document.createTextNode(str));
    title.setAttribute('class', 'title');
    document.body.appendChild(title);
}

createTitle('Hi!');

当我们引入了新的CSS文件other.css后,其中的.title和index.css中的.title有着同样的“作用域”——全局。

回想一下在JavaScript中:

// a.js
var a = 1;

// other.js
var a = 2;

// index.html
<script src="./a.js"></script>
<script src="./other.js"></script>
<script>
    console.log(a); // 2
</script>

如果某个html页面通过script标签引入这两js文件,那么a的值必定会有冲突,其中一个会被覆盖。如果使用模块化的方式,可以变成:

// a.js
export var a = 1;

// other.js
export var a = 2;

// app.js
import {a} from './a';
import {a as other} from './other';

console.log(a); // 1
console.log(a); // 2

而所谓的Local Scope就是webpack中在CSS上针对这种问题的一个解决方案。类似JavaScript的模块化,通过对CSS文件进行模块引用与导出的方式,能够在开发时,更有效得控制各个class的作用范围。

使用方法

首先,需要在webpack中对css-loader进行一定的配置。

// loader: 'css-loader',
// options: {
//     modules: true,
//     localIdentName: '[local]__[name]--[hash:base64:5]'
// }
const config = {
    entry: './src/index.js',
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: 'bundle.js'
    },
    module: {
        rules: [{
            test: /\.css$/,
            use: [{
                loader: 'style-loader'
            }, {
                loader: 'css-loader',
                options: {
                    modules: true,
                    localIdentName: '[local]__[name]--[hash:base64:5]'
                }
            }]
        }]
    }
};

然后,我们还是使用前一节例子中的那个场景:

// index.css
:local .title {
    font-size: 30px;
    color: #333;
}

// other.css
:local .title {
    font-size: 15px;
    color: #999;
}

// index.js
import styles from './index.css';
import others from './other.css';

funciont createTitle(str) {
    var title = document.createElement('h1');
    title.appendChild(document.createTextNode(str));
    // styles.title  font-size: 30px;color: #333;
    title.setAttribute('class', styles.title);
    document.body.appendChild(title);
}

createTitle('Hi!');

其中需要注意的有三个地方:

  • 第一个是在CSS文件中的,类选择器前多了:local这个语法。通过添加:local就可以指示webpack,这不是一个“全局”的选择器(当然,实际上也是全局的,后面会简单解释)。
  • 第二个地方是在js文件中,将import 'index.css'变为了import styles from './index.css'。是不是看着很熟悉,没错,和JavaScript中的模块化方案用法一样。
  • 第三个地方,在使用到该class的地方,由原来的title.setAttribute('class', ‘title’)变为了title.setAttribute('class', styles.title)。这样我们可以选择在一部分dom元素上使用styles.title,即index.css的样式;在另一部分dom元素上使用other.css的样式。

这样就解决了我们之前提到的问题。

当然,有些时候,我们希望类选择器中的某一部分仍然是“全局”的,那么我们可以这么写:

:local .title :global(.sub-title) { color: #666; }

关于Local Scope

虽然我们上面说了这么多次的“模块化”、“作用域”、“全局”,然而,实际上,对于CSS这门语言来说,它在自己本身的逻辑上是不具备这些特点的。而webpack中Local Scope的相关方案,其实也并不是(CSS本身逻辑支持的)真正意义上所谓的模块化。所以很多地方我都打上了引号。

如果对着打包后的页面,打开chrome控制台,会发现,我们的html是这个样子的

<body>
    <h1 class="title__index--330EV">Hi!</h1>
</body>

h1标签的class并不是我们在CSS中所写的title,而是一串奇怪的字符串title__index--330EV

当使用webpack进行打包时,由于检查到:local这个语法,因此会为.title这个class生成一个新的class名称,而我们在js文件中所使用的styles.title对应的就是这个新的classname。

所以可以理解,其实当前的CSS语法逻辑中中并没有实际意义上所谓的local scope,但是,通过webpack打包时的操作,我们会为每个:local的class生成一个唯一的名称,而我们使用样式实际是指向了这个classname。这就实现了两个CSS文件中,相同名称的class在使用时就不会有冲突了,相当于避开了“全局作用域”。

如果打开打包后的bundle.js,我们可以发现一段很有趣的代码

// ……其余省略
// exports
exports.locals = {
    "title": "title__index--330EV"
};

// ……其余省略
// exports
exports.locals = {
    "title": "title__other--3vRzX"
};

这是在两个不同的模块内的部分。上面一个就是导出的index.css中对应的classname,下面一个就是other.css的。通过styles.title就可以引用到title__index--330EV这个实际值。

最后,再来说一下title__index--330EV这个值得由来。在上一节的一开始,我们对webpack进行了配置,其中有一行

localIdentName: '[local]__[name]--[hash:base64:5]'

其实就是指示了唯一标识的命名方式:local是class的名称,name是文件的名称,而最后加上hash值。当然,你完全可以使用其他你喜欢的方式。默认是使用[hash:base64]

最后

其实webpack中的CSS模块化方案Local Scope,粗浅的来说也是通过生成唯一的classname来避免冲突,控制作用范围。只是和BEM不同,BEM是一个建议标准,更多的还是人为的操控,而webpack中的Local Scope则提供了一个完整的模块化与打包方案。在一定程度上提高了开发的效率,降低了错误率。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,265评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,078评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,852评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,408评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,445评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,772评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,921评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,688评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,130评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,467评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,617评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,276评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,882评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,740评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,967评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,315评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,486评论 2 348

推荐阅读更多精彩内容

  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,147评论 7 35
  • 版权声明:本文为博主原创文章,未经博主允许不得转载。 webpack介绍和使用 一、webpack介绍 1、由来 ...
    it筱竹阅读 11,055评论 0 21
  • 前言 WebPack 是什么? WebPack 是什么,WebPack 可以看做是模块打包机:它做的事情是,分析你...
    Promise__阅读 1,123评论 3 12
  • 前两部分我们已经完成了博客页面的展示和后台页面的展示: React技术栈+Express+Mongodb实现个人博...
    SamDing阅读 5,450评论 1 12
  • 犹记得自小表达欲望低的我,中学时代无数次为800字的作文困扰,心中无所触动,笔下难成文章。最终只能套用总-分-总似...
    小猴梨梨阅读 252评论 0 2