20. css module 解决样式冲突 - 《webpack》

思路
实现原理
如何应用样式
其他操作
全局类名
如何控制最终类名
其他注意事项

通过命名规范来限制类名太过死板,而css in js 虽然足够灵活,但是书写不方便,css module 开辟一种全新的思路来解决类名冲突问题

思路

css module 遵循一下的思路解决类名冲突问题:

css的类名冲突往往发生在大型的项目中
大型的项目中往往使用构建工具(webpack)等,来搭建工程
构建工具允许将css切片分为更加精细的模块
同js质量一样,每个css模块文件中难以出现冲突的类名,冲突的类名往往发生在不同的css模块文件中
只要保证构建工具在合并代码的后不会出现类名冲突即可

实现原理

在webpack中,作为处理css的css-loader,它实现了css module思想,要启用css module,需要将css-loader的配置modules配置为true

css-loader实现方式如下

原理极其简单,开了css module以后,css-loader会将样式中的类名进行转换,转换为一个唯一的hash值

由于hash的值是根据模块的路径和类名生成的,因此,不同的css模块,哪怕具有相同类名,转换后的hash值也不一样

如何应用样式

css module 带来了一个新的问题: 源代码的类名和生成的类名是不一样的,而开发者知道自己写的源代码中的类名,并不知道最终的类名,那如何应用类名到元素上呢?

为了解决这个问题,css-loader会导出原始类名和最终类名的对应关系,该关系是通过一个对象描述的

style-loader 为了方便我们更加方便的应用类名,会去除掉其他的信息,仅暴露对应关系

其他操作

全局类名

某些类名是全局的,静态的,不需要真的进行转换,尽在需要类名的位置使用一个特殊的语法即可:

:global(.main){
    ...
}

使用了global的类名不会进行转换,相反的,没有使用global的类名,表示默认使用了local

:local(.main){
    ...
}

使用了local的类型表示局部的类名,可能会造成冲突的类名,会被css module进行转换

如何控制最终类名

在绝大部分情况下,我们不需要最终控制类名,因为控制它没有任何意义

如果一定要控制类名,需要配置css-loader 的localIdentName

const HtmlWebpackPlugin = require('html-webpack-plugin')
module.exports = {
    mode: "development",
    devtool: "source-map",
    module: {
        rules: [
            {
                test: /\.css$/, use: ["style-loader", {
                    loader: "css-loader",
                    options: {
                         modules: {
                              localIdentName: "[local]-[hash:5]"
                        }
                       //modules:true 不配置打包类名规范的时候,需要开启
                     }
                 }]
            }
        ]
    },
    plugins: [
        new HtmlWebpackPlugin({
            template: "./public/index.html"
        })
    ],
    devServer: {
        open: true
    }
}

其他注意事项

css module 往往配合构建工具使用
css module 仅需处理顶级类名,尽量不要写嵌套的类名,也没这个必要
css module 仅处理类名,不处理其他的选择器
css module 还会处理id选择器,不过任何时候都没有使用id选择的必要
使用了css module以后,只要能做到让类名望文知意即可,不需要遵循其他的任何命名规范