好用的import: Vite的Glob 导入

简介: 好用的import: Vite的Glob 导入

Vite 的 Glob 导入


【内容简介】 在 Vite 中有一个特殊的导入方式,即我们今天打算讨论的 Glob 导入 。这种导入弥补完善了JavaScript导入体系中不能同时导入到某个文件目录的多个文件的缺陷。


1. 回顾 JavaScript import

JavaScript 模块是声明性的,模块之间的关系是根据文件级别的导入和导出来指定的。模块中声明的变量、函数、类等在模块外是不可见的模块依赖于importexport

如果想要导入,那么以为着你必须先在一个文件中导出,如:

export const numberRegexp = /^[0-9]+$/;

静态导入可以用以下方式来表达:

import "module-name";
import { export1 , export2 } from "module-name";
import defaultExport from "module-name";
import { export1 , export2 as alias2 , [...] } from "module-name";
import defaultExport, { export [ , [...] ] } from "module-name";
import * as name from "module-name";
import defaultExport, * as name from "module-name";
import { export } from "module-name";
import { export as alias } from "module-name";

你也可以动态加载模块,这需要一个import()函数。它返回一个 promise,它用一个模块对象来实现。如:

import('/modules/myModule.js')
  .then(module => {
    ...
  })
  .catch(err => {
    ...
  });
// 也可以用 await 
let module = await import('/modules/myModule.js');

这些基于JavaScript的导入方法用起来有一个缺点,就是无法监视目录文件的变化。在开发中我们如果能将一个目录是为一个整体进行导入,那么该目录中的所有子目录与文件就可以有层级的获取,而不是一个一个写在道路路径里如'/modules/myModule.js'

比如Python的著名重量型Web框架Dajngo,其一个子应用就是以一个目录为整体的模块进行组织的,这当然要求一次能够导入一个目录并能够区分目录中的层级。

2. Glob 导入即基本使用与原理

Glob 导入即Vite中提供的 import.meta.glob()import.meta.globEager() 导入函数。 Glob 导入可以导入目录中的所有文件/目录,也可以对文件/目录进行匹配筛选。

会被当成导入标识符:必须是相对路径(以 ./ 开头)或绝对路径(以 / 开头,相对于项目根目录解析)。

2.1 glob()导入函数

glob()导入函数指的是 import.meta.glob() ,这种导入是动态导入,匹配到的文件默认是懒加载的。因此如果你使用该导入,自然如果被导入的某个模块中具体代码有错误页不会被抛出。

现在有一个目录如下:

我们在另外一个位置建立一个文件,相对目录表示该路径为'./test/,现在我们尝试以下几种方法看看导入完成了什么事情:

(1)所有当前目录层级下的文件

export const modules = import.meta.glob('./test/*')

这里我们使用了通配符来匹配所有的文件。但是这不会包含其中的目录。

展开后可以看到:

{./test/b.ts: ƒ, ./test/c.ts: ƒ, ./test/d.ts: ƒ}
./test/b.ts: () => import("/src/test/b.ts")
./test/c.ts: () => import("/src/test/c.ts")
./test/d.ts: () => import("/src/test/d.ts?t=1639678566331")

因为,import.meta.glob(‘./test/*’)相当于在上面被转译成了以下代码:

const modules = {
  './test/b.ts': () => import("/src/test/b.ts"),
  './test/c.ts': () => import("/src/test/c.ts"),
  './test/d.ts: ()' => import("/src/test/d.ts")
}

显然,这时以模块的相对路径作为“键”,导入的内容整体作为为响应 你可以遍历 modules 对象的 key 值来访问相应的模块:

for (const path in modules) {
  modules[path]().then((mod) => {
    console.log(path, mod)
  })
}

(2)所有当前目录层级下特定类型的文件

export const modules = import.meta.glob('./test/*.ts')

2.2 globEager()导入函数

globEager()导入函数是指 import.meta.globEager() 。从功能上来看,它与glob()函数几乎完全一样。但是这中导入是静态的,它将在你掉用该函数时直接引入所有的模块。

这意味这,如果你在一次性导入所有模块时,这些某块都将被加载,且要求所有模块在语法上时正确的,否则将抛出错误。

还是刚才的目录:

export const aaa = import.meta.globEager('./test/*.ts')

可以清楚的看到有一个最明显的区别时,各个模块被立即导入进来作为以各自相对路径为键的值。

这种方式将被转换成如下代码:

// vite 生成的代码
import * as __glob__0_0 from './test/b.ts''
import * as __glob__0_1 from './test/c.ts''
import * as __glob__0_2 from './test/d.ts''
const modules = {
  './test/b.ts'': __glob__0_0,
  './test/c.ts'': __glob__0_1,
  './test/db.ts'': __glob__0_2,
}

3. 示例:通过Glob 导入子目录特定文件

这时一个简单的例子。由于在之前的例子中我们看到,导入没有将文件系统中的目录带进来,而只有文件的键值对,似乎不能同时处理所有子目录中的文件,其实不然。

现在我们动态导入test所有子目录中的文件:

export const aaa = import.meta.glob('./test/*/*')

仅此小例启发诸君。

目录
相关文章
|
存储 JavaScript API
vue3+ant design vue 自定义文件上传和自定义上传进度条
1.关键点是Upload组件中customRequest的API,它能通过覆盖默认的上传行为,可以自定义自己的上传实现(具体可看官方文档); 2.通过在Upload组件中绑定progress实现。 下面是详细代码
3951 0
|
JavaScript 前端开发
vue全局公共组件自动引入并注册,开发效率直接起飞!
【10月更文挑战第14天】vue全局公共组件自动引入并注册,开发效率直接起飞!
673 1
|
前端开发 JavaScript
如何让input框在用户输入后,文字居中显示
如何让input框在用户输入后,文字居中显示
1032 0
|
前端开发 JavaScript
怎么在vite项目中全局导入一个scss文件
在Vite项目中全局导入SCSS文件的方法:通过配置`vite.config.js`中的`css.preprocessorOptions.scss.additionalData`属性,可以将SCSS变量或混合内容全局引入。此方法同样适用于LESS文件。详情参见Vite官方文档。
1170 1
怎么在vite项目中全局导入一个scss文件
|
JavaScript 前端开发 开发工具
web项目规范配置(husky、eslint、lint-staged、commit)
通过上述配置,可以确保在Web项目开发过程中自动进行代码质量检查和规范化提交。Husky、ESLint、lint-staged和Commitlint共同作用,使得每次提交代码之前都会自动检查代码风格和语法问题,防止不符合规范的代码进入代码库。这不仅提高了代码质量,还保证了团队协作中的一致性。希望这些配置指南能帮助你建立高效的开发流程。
904 5
|
移动开发 资源调度 JavaScript
Vue移动端网页(H5)预览pdf文件(pdfh5和vue-pdf)
这篇文章介绍了在Vue移动端网页中使用`pdfh5`和`vue-pdf`两个插件来实现PDF文件的预览,包括滚动查看、缩放、添加水印、分页加载、跳转指定页数等功能。
11789 1
Vue移动端网页(H5)预览pdf文件(pdfh5和vue-pdf)
|
JavaScript
vue3,使用watch监听props中的数据
【10月更文挑战第3天】
4281 2
|
存储 缓存 JavaScript
Vue3.0监听器watch与watchEffect
Vue3.0监听器watch与watchEffect
445 6
|
JavaScript 安全 API
vue3注册添加全局实例属性的方法,如何在setup函数中调用
vue3注册添加全局实例属性的方法,如何在setup函数中调用
2158 2
|
存储 JavaScript API
《VitePress 简易速速上手小册》第7章 高级功能与动态内容(2024 最新版)(上)
《VitePress 简易速速上手小册》第7章 高级功能与动态内容(2024 最新版)
850 2