CSS-LOADER配置详解
前注:
文档全文请查看 根目录的文档说明。
如果可以,请给本项目加【Star】和【Fork】持续关注。
有疑义请点击这里,发【Issues】。
1、概述
对于一般的css文件,我们需要动用三个loader(是不是觉得好麻烦);
1、css-loader
:
先附上官网文档(中文)的链接:css-loader文档。
不过说实话,这个官方文档讲的很糟糕,看的人一脸懵逼。
css-loader
主要用于处理图片路径(其实也包括例如导入css文件的路径),并且会将css样式打包进js文件中(以模块的形式打包导入);
但问题在于,他不会将这些代码插入html中,因此还需要通过例如style-loader
来实现将打包好的css代码插入html文件中。
2、style-loader
:
同样先附上官网文档(中文)的链接:style-loader文档
基本用法:
用于将 css-loader
打包好的css模块,插入到html文件中,变成一个 <style>
标签;
3、file-loader
:
file-loader文档
基本用法:
用于处理各种资源文件,一般是图片,不然图片是没办法被同时打包的。
2、css-loader配置详解
先吐槽一波,中文文档里的说明,真的是描述的一点都不清楚。
2.1、root
名称 | 类型 | 默认值 | 描述 |
root | {String} | / | 解析 URL 的路径,以 / 开头的 URL 不会被转译 |
官方文档里对这个解释不够严谨。
首先,假如不设置设个属性,如果理解为,以 /
开头的url不会被转译,从结果来看,也不算错;
然而,假如设置这个属性的话,那么就不一样了。
在面对图片路径时,这个属性有三种情况:
- 当不设置这个属性的时候,
css-loader
不会去解析以/
开头的图片路径,也不会报错; - 当设置这个属性的时候,即使你设置其值为默认值
/
,css-loader
也会去尝试解析这个路径,如果找不到对应的图片,会报错; - 当设置这个属性的值为非默认值,和【2】中的行为是一样的,
css-loader
去尝试解析这个路径,如果找到图片,则正常解析,找不到,会报错;
当设置这个属性时,是指,当url以 /
为开头时,到底去找哪里的文件夹作为解析以 /
为开头的url路径的文件;
当面对css文件路径时,即在css文件里,通过 @import
引入css文件时,这个是不对css文件的路径生效的(即使找不到,也不会报错)。
示例:
文件树:
根目录
|-- src
| |-- app.js
| |-- src
| |-- logo.png
|
|-- static
| |-- abc.png
|
|-- webpack.config.js
那么在 webpack.config.js
里配置的时候,应该这么写:root: __dirname + '/static/'
。
__dirname
表示根目录的绝对路径。假如根目录的路径是 D:/abc/def
,那么 __dirname
就表示 D:/abc/def
,而 __dirname + '/static/
则表示 D:/abc/def/static
这就是告诉 css-loader
,遇见 /
开头的url路径,你应该去 D:/abc/def/static
这个路径下去找文件。
2.2、
名称 | 类型 | 默认值 | 描述 |
url | {Boolean} | true | 启用/禁用 url() 处理 |
首先,我们已知,css-loader
正常会解析css属性里的图片url路径,例如 background: url('/logo.png')
里面的值。
那么,假如某图片不在你的工程里,而是在服务器上。
而你是可以预知打包后的html文件和这个图片的相对路径关系,你就可以直接写那个时候的路径,并将url设置为false。
但是,如果设置为false,那么所有url都不会进行转义了(也不会触发file-loader),自然也不会报错(即使图片不存在)。
示例:
假如打包后,上传到服务器的目录为:
dist
|-- app.js
|-- logo.png
那么你如果想引用 logo.png
,那么把 url
设置为 false
之后,然后路径这么写就行了 background: url('./logo.png')
。
2.3、alias
名称 | 类型 | 默认值 | 描述 |
alias | {Object} | {} | 创建别名更容易导入一些模块 |
说实话我自己捣鼓了半天也没彻底搞明白其原理,但是琢磨出來一些用法:
1、对图片路径生效
假如文件结构:
根目录
|--static
| |-- logo.png
|-- webpack.config.js
解释:
- 已知: 图片放在
/static
目录下; - 已知:不确认css文件放在哪里(因为模块化,方便移动,所以可能更改模块的目录结构);
- 需求:我想要确保我的css文件必然能引用到这个图片,即使更改模块的文件路径,也不影响(不需要我二次去修改);
- 行动:那么添加
css-loader
的属性,设置如下:alias: {'@': __dirname + '/static/'}
; - 行动:在css文件里,图片如下引用
background: url(~@/logo.png)
; - 结果:我就可以确保必然css文件必然能引用到这个图片了;
- 注意:
@
前要加~
让webpack
识别(~
是webpack
负责识别,认为是根目录,而@
是css-loader
负责);
2、对 @import
引入的css文件无效;
假如文件结构:
根目录
|--static
| |-- style.css
| |-- foo.css
|-- webpack.config.js
解释:
- 文件目录结构如上;
- 在
style.css
如果通过@import '~@/foo.css'
来导入; - 即使在
webpack.config.js
里这么设置alias: {'@': __dirname + '/src/style/'}
也是没有用的;
3、解决场景:
这个可以应用的场景挺多,不过现在很多是通过webpack的别名通用配置来解决
- css文件和图片文件分离;
- 也可以分类摆放图片(例如@开头的是风景类图片,peopel开头的是人物图片);
- 记得在别名之前加一个波浪线~让webpack识别,否则无法正常工作;
2.4、import
名称 | 类型 | 默认值 | 描述 |
import | {Boolean} | true | 启用/禁用 @import 处理 |
- 假如你通过@import导入的是某个打包后工程所在位置的css文件;
- 即该文件不在打包前的工程里(例如CDN);
- 那么这个就有用;
- 表现效果@import导进来的css没有被打包,只是单纯的引入了(该@import代码被直接放在style标签里);
- 你可以查看dist/index.html的style标签来深刻了解;
这里给一个简单的示例:
webpack打包前:
// foo.css
@import 'http://abc.com/m.css'
webpack打包后:
// html文件(假设使用了style-loader把css通过style标签插入)
<style>
@import 'http://abc.com/m.css'
</style>
2.5、minimize
名称 | 类型 | 默认值 | 描述 |
minimize | {Boolean|Object} | false | 启用/禁用 压缩 |
- 这个很好理解,原本写css文件的时候,我们各种换行空格,这个改为true之后,换行和空格就去掉了;
- 一般开发的时候,取环境变量,当环境变量为生产环境的时候,设置为true;开发环境的时候,设置为false;
- 关于生产环境的配置,可以查看参考示例,搜索
minimize
即可;
压缩前代码:
* {margin: 0;border: 0;padding: 0;
}.box {border-radius: 150px;
}
压缩后代码:
*{margin:0;border:0;padding:0}.box{border-radius:150px}
2.6、sourceMap
名称 | 类型 | 默认值 | 描述 |
sourceMap | {Boolean} | false | 启用/禁用 Sourcemap |
- 在
minimize
设置为true
后,css代码被压缩了,那么如果我们要调试的话就很麻烦; - 当
sourceMap
设置为true
后,通过Chrome控制台的Sources
标签,在左边栏上面选Sources
,可以在树结构的(no domain)
里,查看到压缩后和压缩前的CSS代码; - 即使
minimize
没有设置为true
(不压缩),由于css代码被扔到了js里,因此也是无法直接查看我们写的css代码的; - 但是
sourceMap
设置为true后,就可以通过【2】中描述的途径来查看我们写的css代码;
启用 sourceMap
压缩前的代码:
启用 sourceMap
压缩后的代码:
2.7、importLoaders
名称 | 类型 | 默认值 | 描述 |
importLoaders | {Number} | {Number} | 在 css-loader 前应用的 loader 的数量 |
说实话,加不加这个,感觉没啥区别(我还专门研究了一波postcss和autoprefixer让他生效。
见我关于postcss的配置,为了正常运行,我在项目里webpack把这个注释掉了,可以取消掉注释 // importLoaders: 0 // 感觉没什么用
如果有见解,欢迎指正
2.8、modules等
名称 | 类型 | 默认值 | 描述 | 说明 |
modules | {Boolean} | false | 启用/禁用 CSS 模块 | 1、初步理解:这个相当于把css视为模块。例如我有一个css文件 foo.css ,然后里面有一个类 .bar,我可以在js文件里通过 import foo from './foo.css'导入这个css文件; 2、在打包后,foo.css里的类 .bar 会变成具有唯一性的一个字符串(举个例子假设他变成了abcdefg); 3、假如我在html里使用的是class='bar',那么显然是无法正常生效的(bar被转为了abcdefg); 4、那么我可以使用变量foo.bar(在js这里,这是一个变量),赋给原本使用class='bar'的这个DOM节点; 5、由于是变量,所以他的值事实上已经被css-loader转为了abcdefg,可以正常运行了; 6、推荐阮一峰的博客CSS Modules 用法教程 |
camelCase | {Boolean|String} | false | 以驼峰化式命名导出类名 | 1、这个需要结合modules来看,在modules设置为true时,我们可以通过变量名来获取更名后的css类名; 2、但我们写css类名的时候,一般是例如foo-bar这种写法,在js里显然不合适; 3、因此把这个启用为true,我们就可以使用fooBar这种驼峰式写法了,方便js引用; |
localIdentName | {String} | [hash:base64] | 配置生成的标识符(ident) | 1、这个也是跟modules相关的,用于对原本混算复杂不具有可读性的类名,进行重命名; 2、我觉得这个文章讲这个比较好,你真的知道 css-loader 怎么用吗?,搜索关键词:localIdentName |
这三个是一起使用的的,见表格内容吧。
3、项目地址
https://github.com/qq20004604/webpack-study/tree/master/5%E3%80%81Loader/css_loader ,请 Star 和 fork 到本地后,注意相关配置。