|
众所周知,在vue中使用scoped可以避免父组件的样式渗透到子组件中。使用了scoped后会给html增加自定义属性,同时会给组件内CSS选择器添加对应的属性选择器。本文讲一下vue是如何给CSS选择器添加对应的属性选择器。注:本文中使用的vue版本为,的版本为。
先看个demo
代码如下:- <template>
- <div class="block">hello world</div>
- </template>
- <style scoped>
- .block {
- color: red;
- }
- </style>
复制代码 经过编译后,上面的demo代码就会变成下面这样:- <template>
- <div data-v-c1c19b25 class="block">hello world</div>
- </template>
- <style>
- .block[data-v-c1c19b25] {
- color: red;
- }
- </style>
复制代码 从上面的代码可以看到在div上多了一个自定义属性,并且css的属性选择器上面也多了一个。
那有人就会好奇,为什么生成这样的代码就可以避免样式污染呢?:这里面包含两个选择器。是一个类选择器,表示class的值包含。是一个属性选择器,表示存在自定义属性的元素。
所以只有class包含,并且存在自定义属性的元素才能命中这个样式,这样就能避免样式污染。并且由于在同一个组件里面生成的值是一样的,所以在同一组件内多个html元素只要class的值包含,就可以命中的样式。
接下来我将通过debug的方式带你了解,vue是如何在css中生成.block[data-v-c1c19b25]这样的属性选择器。
@vitejs/plugin-vue
还是一样的套路启动一个debug终端。这里以举例,打开终端然后点击终端中的号旁边的下拉箭头,下拉中点击- Javascript Debug Terminal
复制代码 就可以启动一个终端。
假如文件编译为文件是一个毛线团,那么他的线头一定是文件中使用的地方。通过这个线头开始我们就能够梳理清楚完整的工作流程。
vuePlugin函数
我们给上方图片的函数打了一个断点,然后在终端上面执行,我们看到断点已经停留在了函数这里。然后点击,断点走到了库中的一个函数中。我们看到简化后的函数代码如下:- function vuePlugin(rawOptions = {}) {
- return {
- name: "vite:vue",
- // ...省略其他插件钩子函数
- transform(code, id, opt) {
- // ..
- }
- };
- }
复制代码 是作为一个插件在vite中使用,函数返回的对象中的方法就是对应的插件钩子函数。vite会在对应的时候调用这些插件的钩子函数,vite每解析一个模块都会执行一次钩子函数。更多vite钩子相关内容查看官网。
我们这里只需要看钩子函数,解析每个模块时调用。
由于解析每个文件都会走到钩子函数中,但是我们只关注文件是如何解析的,所以我们给钩子函数打一个条件断点。如下图:
然后点击Continue(F5),服务启动后就会走到钩子函数中打的断点。我们可以看到简化后的钩子函数代码如下:- function transform(code, id, opt) {
- const { filename, query } = parseVueRequest(id);
- if (!query.vue) {
- return transformMain(
- code,
- filename,
- options.value,
- this,
- ssr,
- customElementFilter.value(filename)
- );
- } else {
- const descriptor = getDescriptor(filename);
- if (query.type === "style") {
- return transformStyle(
- code,
- descriptor,
- Number(query.index || 0),
- options.value
- );
- }
- }
- }
复制代码 首先调用函数解析出当前要处理的文件的和,在debug终端来看看此时这两个的值。如下图:
从上图中可以看到为当前处理的vue文件路径,的值为空数组。所以此时代码会走到函数中。
transformMain函数
将断点走进函数,在我们这个场景中简化后的函数代码如下:- async function transformMain(code, filename, options) {
- const { descriptor } = createDescriptor(filename, code, options);
- const { code: templateCode } = await genTemplateCode(
- descriptor
- // ...省略
- );
- const { code: scriptCode } = await genScriptCode(
- descriptor
- // ...省略
- );
- const stylesCode = await genStyleCode(
- descriptor
- // ...省略
- );
- const output = [scriptCode, templateCode, stylesCode];
- let resolvedCode = output.join("\n");
- return {
- code: resolvedCode,
- };
- }
复制代码 首先调用函数根据当前vue文件的code代码字符串生成一个对象,简化后的函数代码如下:- const cache = new Map();
- function createDescriptor(
- filename,
- source,
- { root, isProduction, sourceMap, compiler, template }
- ) {
- const { descriptor, errors } = compiler.parse(source, {
- filename,
- sourceMap,
- templateParseOptions: template?.compilerOptions,
- });
- const normalizedPath = slash(path.normalize(path.relative(root, filename)));
- descriptor.id = getHash(normalizedPath + (isProduction ? source : ""));
- cache.set(filename, descriptor);
- return { descriptor, errors };
- }
复制代码 首先调用方法根据当前vue文件的code代码字符串生成一个对象,此时的对象主要有三个属性、、,分别对应的是vue文件中的模块、模块、模块。
然后调用函数给对象生成一个属性,函数代码如下:- import { createHash } from "node:crypto";
- function getHash(text) {
- return createHash("sha256").update(text).digest("hex").substring(0, 8);
- }
复制代码 从上面的代码可以看出id是根据vue文件的路径调用node的加密函数生成的,这里生成的id就是scoped生成的自定义属性中的部分。
然后在函数中将生成的对象缓存起来,关于对象的处理就这么多了。
接着在函数中会分别以对象为参数执行、、函数,分别得到编译后的render函数、编译后的js代码、编译后的style代码。
编译后的render函数如下图:
从上图中可以看到template模块已经编译成了render函数
编译后的js代码如下图:
从上图中可以看到script模块已经编译成了一个名为的对象,因为我们这个demo中script模块没有代码,所以这个对象是一个空对象。
编译后的style代码如下图:
从上图中可以看到style模块已经编译成了一个import语句。
最后就是使用换行符将、、拼接起来就是vue文件编译后的js文件啦,如下图:
想必细心的同学已经发现有地方不对啦,这里的style模块编译后是一条import语句,并不是真正的css代码。这条import语句依然还是import导入的文件,只是加了一些额外的query参数。- ?vue&type=style&index=0&lang.css
复制代码 :这个query参数表明当前import导入的是vue文件的css部分。
还记得前面讲过的钩子函数吗?vite每解析一个模块都会执行一次钩子函数,这个import导入vue文件的css部分,当然也会触发钩子函数的执行。
第二次执行transform钩子函数
当在浏览器中执行vue文件编译后的js文件时会触发- import "/Users/xxx/index.vue?vue&type=style&index=0&lang.css"
复制代码 语句的执行,导致再次执行钩子函数。钩子函数代码如下:- function transform(code, id, opt) {
- const { filename, query } = parseVueRequest(id);
- if (!query.vue) {
- return transformMain(
- code,
- filename,
- options.value,
- this,
- ssr,
- customElementFilter.value(filename)
- );
- } else {
- const descriptor = getDescriptor(filename);
- if (query.type === "style") {
- return transformStyle(
- code,
- descriptor,
- Number(query.index || 0),
- options.value
- );
- }
- }
- }
复制代码 由于此时的中是有字段,所以的值为false,这次代码就不会走进函数中了。在代码在先执行函数拿到对象,函数代码如下:- function getDescriptor(filename) {
- const _cache = cache;
- if (_cache.has(filename)) {
- return _cache.get(filename);
- }
- }
复制代码 我们在第一次执行函数的时候会去执行函数,他的作用是根据当前vue文件的code代码字符串生成一个对象,并且将这个对象缓存起来了。在函数中就是将缓存的对象取出来。
由于中有,所以代码会走到函数中。
transformStyle函数
接着将断点走进函数,代码如下:- async function transformStyle(code, descriptor, index, options) {
- const block = descriptor.styles[index];
- const result = await options.compiler.compileStyleAsync({
- ...options.style,
- filename: descriptor.filename,
- id: `data-v-${descriptor.id}`,
- source: code,
- scoped: block.scoped,
- });
- return {
- code: result.code,
- };
- }
复制代码 从上面的代码可以看到函数依然不是干活的地方,而是调用的包暴露出的函数。
在调用函数的时候有三个参数需要注意:、和。字段的值为,值是当前css代码字符串。字段的值为,是不是觉得看着很熟悉?没错他就是使用后vue帮我们自动生成的html自定义属性和css选择属性选择器。
其中的就是在生成对象时根据vue文件路径加密生成的id。字段的值为,而的值为。由于一个vue文件可以写多个style标签,所以对象的属性是一个数组,分包对应多个style标签。我们这里只有一个标签,所以此时的值为0。的值为style标签上面是否有使用。
直到进入函数之前代码其实一直都还在包中执行,真正干活的地方是在包中。
@vue/compiler-sfc
接着将断点走进函数,代码如下:- function compileStyleAsync(options) {
- return doCompileStyle({
- ...options,
- isAsync: true,
- });
- }
复制代码 从上面的代码可以看到实际干活的是函数。
doCompileStyle函数
接着将断点走进函数,在我们这个场景中简化后的函数代码如下:- import postcss from "postcss";
- function doCompileStyle(options) {
- const {
- filename,
- id,
- scoped = false,
- postcssOptions,
- postcssPlugins,
- } = options;
- const source = options.source;
- const shortId = id.replace(/^data-v-/, "");
- const longId = `data-v-${shortId}`;
- const plugins = (postcssPlugins || []).slice();
- if (scoped) {
- plugins.push(scopedPlugin(longId));
- }
- const postCSSOptions = {
- ...postcssOptions,
- to: filename,
- from: filename,
- };
- let result;
- try {
- result = postcss(plugins).process(source, postCSSOptions);
- return result.then((result) => ({
- code: result.css || "",
- // ...省略
- }));
- } catch (e: any) {
- errors.push(e);
- }
- }
复制代码 在函数中首先使用定义了一堆变量,我们主要关注和。
其中的为当前css代码字符串,为根据vue文件路径加密生成的id,值的格式为。他就是使用后vue帮我们自动生成的html自定义属性和css选择属性选择器。
接着就是判断是否为true,也就是style中使用有使用scoped。如果为true,就将插件push到数组中。从名字你应该猜到了这个plugin插件就是用于处理css scoped的。
最后就是执行- result = postcss(plugins).process(source, postCSSOptions)
复制代码 拿到经过转换编译器处理后的css。
可能有的小伙伴对不够熟悉,我们这里来简单介绍一下。是 css 的 transpiler(转换编译器,简称转译器),它对于 css 就像 babel 对于 js 一样,能够做 css 代码的分析和转换。同时,它也提供了插件机制来做自定义的转换。
在我们这里主要就是用到了提供的插件机制来完成css scoped的自定义转换,调用的时候我们传入了,他的值是style模块中的css代码。并且传入的插件数组中有个插件,这个自定义插件就是vue写的用于处理css scoped的插件。
在执行对css代码进行转换之前我们在debug终端来看看此时的css代码是什么样的,如下图:
从上图可以看到此时的css代码还是和我们源代码是一样的,并没有css选择属性选择器
scopedPlugin插件
插件在我们这个场景中简化后的代码如下:- const scopedPlugin = (id = "") => {
- return {
- postcssPlugin: "vue-sfc-scoped",
- Rule(rule) {
- processRule(id, rule);
- },
- // ...省略
- };
- };
复制代码 这里的id就是我们在函数中传过来的,也就是生成的css选择属性选择器中的。
在我们这个场景中只需要关注钩子函数,当处理到选择器开头的规则就会走到钩子函数。
我们这里需要在使用了scoped后给css选择器添加对应的属性选择器,所以我们需要在插件中使用钩子函数,在处理css选择器时手动给选择器后面塞一个属性选择器。
给钩子函数打个断点,当处理到我们代码中的时就会走到断点中。在debug终端看看的值,如下图:
从上图中可以看到此时的值为,是一个class值为的类选择器。
processRule函数
将断点走进函数中,在我们这个场景中简化后的函数代码如下:- import selectorParser from "postcss-selector-parser";
- function processRule(id: string, rule: Rule) {
- rule.selector = selectorParser((selectorRoot) => {
- selectorRoot.each((selector) => {
- rewriteSelector(id, selector, selectorRoot);
- });
- }).processSync(rule.selector);
- }
复制代码 前面我们讲过的值为,通过重写的值可以将当前css选择器替换为一个新的选择器。在函数中就是使用来解析一个选择器,进行处理后返回一个新的选择器。方法的作用为接收一个选择器,然后在回调中对解析出来的选择器进行处理,最后将处理后的选择器以字符串的方式进行返回。
在我们这里方法接收的选择器是字符串,经过回调函数处理后返回的选择器字符串就变成了。
我们接下来看回调函数中的代码,在回调函数中会使用去遍历解析出来的选择器。
为什么这里需要去遍历呢?
答案是css选择器可以这样写:,如果是这样的选择器经过解析后,就会被解析成两个选择器,分别是和。
在each遍历中会调用函数对当前选取器进行重写。
rewriteSelector函数
将断点走进函数,在我们这个场景中简化后的代码如下:- function rewriteSelector(id, selector) {
- let node;
- const idToAdd = id;
- selector.each((n) => {
- node = n;
- });
- selector.insertAfter(
- node,
- selectorParser.attribute({
- attribute: idToAdd,
- value: idToAdd,
- raws: {},
- quoteMark: `"`,
- })
- );
- }
复制代码 在函数中each遍历当前选择器,给赋值。将断点走到each遍历之后,我们在debug终端来看看选择器和变量。如下图:
在这里是container容器,才是具体要操作的选择器节点。
比如我们这里要执行的方法就是在容器中在一个指定节点后面去插入一个新的节点。这个和操作浏览器DOM API很相似。
我们再来看看要插入的节点,函数的作用是创建一个attribute属性选择器。在我们这里就是创建一个的属性选择器,如下图:
所以这里就是在类选择器后面插入一个的属性选择器。
我们在debug终端来看看执行函数后的选择器,如下图:
将断点逐层走出,直到函数中。我们在debug终端来看看此时被重写后的字符串的值是什么样的,如下图
原来的值为,通过重写的值可以将类选择器替换为一个新的选择器,而这个新的选择器是在原来的类选择器后面再塞一个属性选择器。
总结
这篇文章我们讲了当使用scoped后,vue是如何给组件内CSS选择器添加对应的属性选择器。主要分为两部分,分别在两个包里面执行。
- 第一部分为在包内执行。
- 首先会根据当前vue文件的路径进行加密算法生成一个id,这个id就是添加的属性选择器中的。
- 然后就是执行函数,这个并不是实际干活的地方,他调用了包的函数。并且传入了、(css代码字符串)、(是否在style中使用)。
- 第二部分在包执行。
- 函数依然不是实际干活的地方,而是调用了函数。
- 在函数中,如果为true就向数组中插入一个插件,这个是vue写的插件,用于处理css scoped。然后使用转换编译器对css代码进行转换。
- 当处理到选择器开头的规则就会走到插件中的钩子函数中。在钩子函数中会执行函数。
ata-v-x]x`。
- 然后就是执行函数,这个并不是实际干活的地方,他调用了包的函数。并且传入了、(css代码字符串)、(是否在style中使用)。
到此这篇关于vue3是如何避免样式污染的的文章就介绍到这了,更多相关vue3 样式污染内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
来源:https://www.jb51.net/javascript/3267958cw.htm
免责声明:由于采集信息均来自互联网,如果侵犯了您的权益,请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容,谢谢合作! |
本帖子中包含更多资源
您需要 登录 才可以下载或查看,没有账号?立即注册
x
|