CSS命名规范-BEM（转载）

原文戳这里👉：https://bemcss.com

BEM 解决的问题

css 的样式应用是全局性的，没有作用域可言。考虑以下场景：

场景一：开发一个弹窗组件，在现有页面中测试都没问题，一段时间后，新需求新页面，该页面一打开这个弹窗组件，页面中样式都变样了，一查问题，原来是弹窗组件和该页面的样式相互覆盖了，接下来就是修改覆盖样式的选择器…又一段时间，又开发新页面，每次为元素命名都心惊胆战，求神拜佛，每写一条样式，F5 都按多几次，每个组件都测试一遍…

场景二：承接上文，由于页面和弹窗样式冲突了，所以把页面的冲突样式的选择器加上一些结构逻辑，比如子选择器、标签选择器，借此让选择器独一无二。一段时间后，新同事接手跟进需求，对样式进行修改，由于选择器是一连串的结构逻辑，看不过来，嫌麻烦，就干脆在样式文件最后用另一套选择器，加上了覆盖样式…接下来又有新的需求…最后的结果，一个元素对应多套样式，遍布整个样式文件…

以往开发组件，我们都用“重名概率小”或者干脆起个“当时认为是独一无二的名字”来保证样式不冲突，这是不可靠的。

理想的状态下，我们开发一套组件的过程中，我们应该可以随意的为其中元素进行命名，而不必担心它是否与组件以外的样式发生冲突。

BEM 解决这一问题的思路在于，由于项目开发中，每个组件都是唯一无二的，其名字也是独一无二的，组件内部元素的名字都加上组件名，并用元素的名字作为选择器，自然组件内的样式就不会与组件外的样式冲突了。

这是通过组件名的唯一性来保证选择器的唯一性，从而保证样式不会污染到组件外。

这也可以看作是一种“硬性约束”，因为一般来说，我们的组件会放置在同一目录下，那么操作系统中，同一目录下文件名必须唯一，这一点也就确保了组件之间不会冲突。

BEM 的命名规矩很容易记：block-name__element-name--modifier-name，也就是模块名 + 元素名 + 修饰器名。

一般来说，根据组件目录名来作为组件名字：

比如分页组件：/app/components/page-btn/

那么该组件模块就名为 page-btn，组件内部的元素命名都必须加上模块名，比如：

1
2
3
4
5

<div class="page-btn">
  <button type="button" class="page-btn__prev">上一页</button>
  <!-- ... -->
  <button type="button" class="page-btn__next">下一页</button>
</div> 

上面我们用双下划线来明确区分模块名和元素名，当然也可以用单下划线，比如 page-btn_prev和page-btn_next。我们只需保留 BEM 的思想，其命名规范可以任意变通。

一开始了解 BEM 的时候，可能会产生误解，出现以下不正确的命名方式：

1
2
3
4
5
6
7
8
9

<div class="page-btn">
  <!-- ... -->
  <ul class="page-btn__list">
    <li class="page-btn__list__item">
      <a href="#" class="page-btn__list__item__link">第一页</a>
    </li>
  </ul>
  <!-- ... -->
</div> 

分页组件有个 ul 列表名为：page-btn__list，列表里面存放每一页的按钮，名为：page-btn__list__item__link，这是不对的。

首先，有悖 BEM 命名规范，BEM 的命名中只包含三个部分，元素名只占其中一部分，所以不能出现多个元素名的情况，所以上述每一页的按钮名 page-btn__list__item__link 可以改成：page-btn__btn。

其次，有悖 BEM 思想，BEM 是不考虑结构的，比如上面的分页按钮，即使它是在 ul 列表里面，它的命名也不应该考虑其父级元素。当我们遵循了这个规定，无论父元素名发生改变，或是模块构造发生的改变，还是元素之间层级关系互相变动，这些都不会影响元素的名字。

所以即使需求变动了，分页组件该有按钮还是要有按钮的，DOM 构造发生变动，至多也就不同元素的增删减，模块内名称也随之增删减，而不会出现修改名字的情况，也就不会因为名字变动，牵涉到 JS 文件的修改，或样式文件的修改。

BEM 命名好长

BEM 的命名中包含了模块名，长长的命名会让 HTML 标签会显得臃肿。

其实每个使用 BEM 的开发团队多多少少会改变其命名规范，比如 Instagram 团队使用的驼峰式:

1

.blockName-elementName--modifierName { /* ... */ } 

还有单下划线：

1

.block-name_element-name--modifierName { /* ... */ } 

还有修饰器名用单横线连接：

1

.blockName__elementName-modifierName { /* ... */ } 

其实这些对缩短命名没有多大的帮助，但我们也无需担心文件体积的问题，由于服务端有 gzip 压缩，BEM 命名相同的部分多，压缩下来的体积不会太大。另外现在都用 IDE 来编写代码了，有自动提示功能，也无须担心重复的输入过长的名字。

因为命名长，我们是不是可以用子代选择器来代替 BEM 命名？这样至少在 HTML 编写时，让 HTML 标签看起来美观一点。

下面说说子代选择器带来的问题。

子选择器

子代选择器的方式是，通过组件的根节点的名称来选取子代元素。按照这个思路，分页按钮样式可以这么写：

1
2
3
4
5

<div class="page-btn">
  <!-- ... -->
  <ul class="list"></ul>
  <!-- ... -->
</div> 

1
2

.page-btn { /* ... */ } 
.page-btn .list { /* ... */ } 

HTML 看起来美观多了，但这解决了样式冲突问题么？试想下，如果让你来接手这个项目，要增加一个需求，新增一个组件，你命名放心么？

你面临的问题是：你打开组件目录，里面有个分页组件，叫做 page-btn，可是你完全不知道要怎么给新组件命名，因为即使新组件模块名与 page-btn 不一样，也不能保证新组件与分页组件不冲突。

比如新的需求是“新增一个列表组件”，如果该组件的名字叫做 list，其根节点的名字叫 list，那么这个组件下面写的样式，就很可能和 .page-btn .list 的样式冲突:

1

.list { /* ... */ } 

这还仅仅只有两个组件而已，实际项目中，十几个或几十个组件，难道我们要每个组件都检查一下来“新组件名是否和以往组件的子元素命名冲突了”么？这不现实。

BEM 禁止使用子代选择器，以上是原因之一。子代选择器不好的地方还在于，如果层次关系过长，逻辑不清晰，非常不利于维护。为了懒得命名或者追求所谓的“精简代码”，写出下面这种选择器：

1
2
3
4
5

.page-btn button:first-child {} 
.page-btn ul li a {}
/* ... */ 
/* 维护代码，新增需求 */
.page-btn .prev {} 

用层次关系结构关系来定位元素，可能会因为需求改变而大面积的重写样式文件。试想一下维护这类代码有多么痛苦，我们要一边检查该元素的上下文 DOM 结构，一边对照着 CSS 文件，一一对比，找到该元素对应的样式，也就是说我为了改一个元素的代码，需要不断翻阅 HTML 文件和 CSS 文件，可维护性非常之差。更有甚者，来维护这块代码的同事，直接在样式文件最后添加覆盖样式，这会造成一个非常严重的问题了：同一个元素样式零散的分布在文件的不同地方，而且定位该元素的选择器也可能各不相同。

这样的样式文件只会越写越糟糕，可以说，当我们用子代选择器来定位元素时，这个样式文件就已经注定是要被翻来覆去的重构的了，甚至，每个来维护这个文件的人都会将其重构一遍。

子代选择器还会造成权重过大的问题，当我们要做响应式的时候，某个带样式的元素需要适配不同的屏幕，此时，我们还要不断的确认该元素之前的选择器写法！为了覆盖前面权重过大的样式，甚至通过添加额外的类名或标签名来增加权重。可想而知，此后这个样式文件的维护难度就像雪球一样，越滚越大。

如果我们用的是 BEM，要覆盖样式很简单：找到要覆盖样式的元素，得知它的类名，在媒体查询中，用它的类名作为选择器，写下覆盖样式，样式就覆盖成功了，不需要担心前面样式的权重过大。

BEM 修饰器

根据不同的场景，组件可能会表现出不同的样式。比如分页组件在 pc 端具有具体的页码以及上下页按钮，但在移动端，因空间有限，可能只保留上下页按钮。我们可以用修饰器来区分这两种情况。默认情况下，分页按钮的类名为 page-btn，但在移动端，我们需要加多个类名 page-btn--min

1
2
3
4

/* 缩小版分页组件中，具体页码按钮隐去 */ 
.page-btn--min .page-btn__btn { display: none; }
.page-btn--min .page-btn__prev { width: 50%; }
.page-btn--min .page-btn__next { width: 50%; } 

上面这种情况用了子代选择器，BEM 是不允许这么写的，BEM 中修饰器的样式不依赖于任何结构关系，也就是说，元素的状态改变只会影响自身，不对其他元素进行影响，但实际上，这很难做到。以上的写法不会造成样式冲突，而且权重的影响也不大。

BEM 修饰器代表着元素的状态，但有时候元素的状态需要 js 来控制，此时遵循规范没有任何好处，比如激活状态，BEM 推荐的写法是：

1
2

.block__element { display: none; }
.block__element--active { display: block; } 

当用 js 为该元素添加状态时，我们需要知道该元素的名字 block__element，这样我们才能推导出它的激活状态为 block__element--active，这是不合理的，因为很多时候我们无法得知元素的名称，所以这时候，我们应该统一 js 控制状态的类名格式，比如 is-active、js-active 等等，这些类名只用作标识，不予许有默认的公共样式：

1
2

.block__element { display: none; }
.block__element.is-active { display: block; } 

原子类和 BEM

BEM 可以不需要用到原子类，但是如果已经引入了类似 Bootstrap 的框架，也没必要强制避免使用原子类，比如“pull-right”、”ellipsis”、“clearfix”等等类，这些类非常实用，和 BEM 是可以互补的。

在组件开发中其实不推荐使用原子类，因为这会降低组件的可复用性。可复用性的最理想状态就是组件不仅仅在不同的页面中表现一致，在跨项目的情况下，也能够运行良好。如果组件的样式因为依赖于某几个原子类就要依赖整个 Bootstrap 库，那么组件的迁移负担就重很多了。

原子类更适合应用在实际页面中，这是因为页面变动大而且不可复用，假设在 header 中，我们用到了两个组件 logo 和 user-panel（用户操作面板），两个组件分别置于 header 的左侧和右侧，我们可以这么写：

1
2
3
4
5
6
7
8

<div class="header clearfix">
  <div class="logo pull-left">
  <!-- ... -->
  </div>
  <div class="user-panel pull-left">
  <!-- ... -->
  </div>
</div> 

header 可以封装成一个模块，但它复用程度不高，不能算是组件，所以即使使用原子类也没有关系。在项目中，使用原子类之前应该考虑一下，这个场景是否变动大而且不可复用，如果是的话，我们可以放心的使用原子类。

组件应该是“自洽的”，其本身就应该构成了一个“生态圈”，也就是说，他几乎不需要外部供给，自给自足就能够运转下去。

实际页面中也应该使用 BEM

在实际页面中也需要用到 BEM 命名方法，不然乱起的一个名字很可能就和某一组件冲突了，导致样式相互覆盖。

假如我们有联系页面，路径是 /pages/contact/。那么该页面的模块名可以是 page-contact，其名下元素均以 page-contact__element-name 命名。

一般来说，实际页面中只是对组件进行调用，对组件的位置进行调整，但不会对组件内部细节进行修改。但实际情况下，同一个组件在不同页面不同模样的情况也是有的，所以会出现在实际页面中对组件样式进行微调的代码：

1
2

/* 联系页面对分页按钮进行微调 */
.page-contact .page-btn {} 

但更推荐的做法是给分页组件添加一个修饰器，将上面的样式放到修饰器名下，再根据实际情况运用到页面中。

webpack css-loader 解决之道

BEM 主要被诟病的一点在于其命名过长，结合 Angular 这种带有标签指令的框架时，整个 HTML 看起来会更混乱：

1
2

<!-- 发帖页面 -->
<span ng-repeat="post in postData track by post.id" ng-if="$index === 0" class="page-post__post-item" ng-class="{'page-post__post-item--even': $even}" popover-content=""></span> 

当然，我们可以通过换行来缓解这个问题:

1
2
3
4
5
6
7
8
9

<!-- 发帖页面 -->
<span
  ng-repeat="post in postData track by post.id"
  ng-if="$index === 0"
  class="page-post__post-item"
  ng-class="{'page-post__post-item--even': $even}"
  popover-content=""
>
</span> 

但其实说穿了，BEM 保证样式不冲突的核心就是：在元素名中加入唯一的标识。这个标识在 BEM 中对应的是模块名，也可能是一个独一无二的乱序字符串。

为模块中每个元素名加入标识，这可是重复的工作啊，重复的工作就应该交给机器去做。

webpack 加载器 css-loader，可在 js 中读取 css 样式，自2015年4月份起，该插件加入了 placeholder 功能，使得该插件可以解决 CSS 作用域的问题，原理也就是给元素的名称加入唯一的标识。

1
2

/* 分页组件 */
:local(.prev) {} 

css-loader 加载器自定义的语法：:local(.identifier){} 向外暴露出选择器 .prev。在 JS 代码中，我们可以拿到这个选择器：

1
2
3

import styles from './page-btn.css';
var $prevBtn = $('<button class="' + styles.prev + '">上一页</button>');
// ... 

styles.prev 返回的是一串独一无二且随机的字符串，该字符串对应着样式文件中的选择器。这名字有悖语义化，但 css-loader 支持配置字符串的生成格式。