在Vue项目开发中,我们常常会导入一些外部的模块,或者是自己写模块导入。
但是模块多了,一个个地导入很显然不是一个好办法,因此我们可以批量导入。
1,前置基础知识 - JavaScript模块化编程
在以往开发普通网页程序时,我们直接使用script
标签引入了js文件即可调用其函数,但是在vue中你发现就不行了,因为vue也是使用了模块化编程标准。
通常我们可以把一个封装了很多要复用的函数和变量的js文件称作模块,模块必须暴露(导出)其中的变量、函数才能被外部导入并调用其中的函数。
现在常见的模块标准有两个:CommonJS
和ES6
。
在这里我们着重讲解ES6
模块。
(1) export
语句 - 暴露函数和变量使外部调用
现在我们自己创建一个js文件表示我们自己的模块,里面封装一些常常复用的函数、变量等等,就需要使用export
暴露出来。
// 导出常量aexportconsta='test'; // 导出函数myPrintexportfunctionmyPrint(msg) { console.log('[]'+msg); }
可见在定义变量/函数时在前面加上export
即可。
除此之外,还可以批量导出:
consta='test'; functionmyPrint(msg) { console.log('[]'+msg); } // 导出常量a和函数myPrintexport { a, myPrint};
(2) import
语句 - 导入变量/函数并使用
上面封装好了函数、变量等等并导出了,但是还是不能直接使用的。需要在要使用的地方进行导入操作:
// 导入函数myPrint和常量aimport { a, myPrint} from'./mymodule.js'; // 使用导入的变量和函数console.log(a); myPrint('msg');
这样就可以使用了。
可见import
语法如下:
import { 变量1/函数1, 变量2/函数2, 变量3/函数3, } from'js文件路径';
需要注意,导入的变量和函数一次可以有多个,用大括号括起来,并且导入的变量/函数名必须和模块中导出的变量/函数名一致!
(3) import * as xxx
语句 - 全部导入
对于需要导入很多的模块,我们import
后面需要写一长串的导入的变量和函数,因此我们还可以一次性全部导入。
对于上面的mymodule
里面导出了一个变量和一个函数,在此我们可以一次性全部导入:
// 一次性全部导入该模块的内容并命名为myimport*asmyfrom'./mymodules.js'; // 调用模块属性aconsole.log(my.a); // 调用模块函数myPrintmy.myPrint('hhh');
可见,用import * as 名字 from '模块路径'
的方式不仅可以方便地导入一个模块js文件的所有内容,还可以自己定义一个名字以方便调用。
(4) export default
- 默认导出
上述的导出方式其实是命名式导出,其它文件导入时的变量/函数名必须和模块中导出的变量/函数名一致。
但是有时候不知道我们要导入的js文件中的函数/变量名怎么办呢?
可以使用默认导出,即export default
语句,例如默认导出一个函数:
// 默认导出myPrint函数exportdefaultfunctionmyPrint(msg) { console.log('[]'+msg); }
默认导出后,导入时可以自行命名:
// 导入文件中默认导出的函数/变量并命名为pimportpfrom'./mymodule.js'; //使用p('msg');
可见这里没有使用大括号,并且导入时可以自行命名,不需要和原模块中函数名一样。
注意,一个js文件只能有一个默认导出!不能多次默认导出!
因此,一个有很多变量和函数的复用模块,我们可以这么写:
exportdefault { // 变量aa: 'a', // 函数myPrintmyPrint() { console.log('aa'); } }
调用时:
importmfrom'./mymodule.js'; //使用console.log(m.a); m.myPrint();
很显然,这里是直接默认导出了一个大的匿名JavaScript对象,并把变量、函数写在这个对象里面。然后再导入,调用其中变量/函数即可。
其实在vue开发中,我们用到的很多外部JavaScript的库,都是这么做的。
事实上,我们的Vue单文件组件原理不也是这样的?
2,在Vite工程中批量导入js模块
在之前的Vue-cli开发中,我们可以使用require.context()
来实现批量导入。但是由于Vite是完全基于ES6模块的,因此就不能使用这种方式了。
当然,官方也提供了实现批量导入的方式,用import.meta.glob
或者import.meta.globEager
函数实现。前者懒加载的导入,后者则为直接导入。今天主要讲解后者。
例如我现在工程目录下src/assets/js
下有三个js文件:
现在要在根组件App.vue
批量导入它们,则在<script>
部分开头写:
constimportModules=import.meta.globEager('./assets/js/*.js');
这样就导入了./assets/js
下所有js模块文件。
当然这种方式也可以匹配多级目录:
constimportModules=import.meta.globEager('./assets/js/**/*.js');
这样就导入了./assets/js
下所有js文件及其子目录下的所有js文件。
在这里我们将其导入为一个变量importModules
,这个变量里面到底是啥呢?我们在mounted
函数里面打印一下看看:
console.log(importModules);
可见导入的是一个对象,这个对象中的每个属性即为模块路径,而对应的值中的default
属性即为导入的模块本身,模块的函数变量等等都在里面。因此我们可以取导入的变量的每个属性下的default
属性以调用我们的模块。
举个例子,现在要调用模块one
中的print
函数:
importModules['./assets/js/one.js'].default.print('hello');
到这相信大家又发现问题了:每次调用批量导入的模块,就要用模块的完整路径去取,还需要带上default
属性,及其不方便。
我们能不能实现就用模块名(js文件名)去取出对应的模块呢?当然可以,事实上方法很多,我来讲一下我的思路。
我们将上述存放导入模块的变量importModules
中的每个属性名都给用字符串裁剪的方式替换成模块名,并将每个属性对应的值直接替换为它的default
值不就行了吗?我们来试一下子:
// 对批量导入存放模块的对象进行处理// 先获取其全部属性constkeys=Object.keys(importModules); // 执行批量替换操作for (letpathofkeys) { // 裁剪字符串方式得到路径中的文件名(无扩展名)letname=path.substring(path.lastIndexOf('/') +1, path.lastIndexOf('.js')); // 对原对象执行添加新的属性并删除旧属性达到处理效果importModules[name] =importModules[path].default; deleteimportModules[path]; }
现在,我们就可以很方便地进行调用了!
// 调用模块one的printimportModules.one.print('hello'); // 打印模块two的name属性console.log(importModules.two.name);
3,在Vite工程中批量导入图片/音频等静态资源
在Vite中如果是想要动态绑定图片音频视频等等,也是要用import
语句的,同样地图片多了,不想一个个地import
应当怎么做呢?
事实上,我们还可以用import.meta.globEager
批量导入静态资源例如图片音频等等。
假设现在在src/assets/image
下有很多图片。
我们仍然可以用上面的方式批量导入:
constimportImages=import.meta.globEager('./assets/image/*');
方式和上面一模一样,只不过这次导入的是静态资源,所以说上述importImages
的default
变成了对应资源的路径。
打印看一看:
同样地,我们可以把上述导入的每个default
部分存起来再使用v-for
批量呈现,试一下子,整个Vue文件代码如下:
<template><divclass="app"><!-- 然后就可以批量呈现了 --><imgv-for="item in images":src="item"height="150"/></div></template><script>constimportImages=import.meta.globEager('./assets/image/*'); exportdefault { data() { return { // 存放批量导入的图片images: [] } }, mounted() { // 把导入的对象中每个default属性(对应实际导入的图片)取出来放到data中的变量images中去for (letpathinimportImages) { this.images.push(importImages[path].default); } } } </script>
效果:
可见Vite中的批量导入非常方便,无论是模块还是资源都可以。对于静态资源,我们是不是还可以用这个批量导入机制,结合我之前写的判断各个资源加载完成的方法的文章,更加简单地实现网站资源加载检测并制作进度条呢?