你可以通过 require.context()
函数来创建自己的 context。
可以给这个函数传入三个参数:
- 要搜索的目录
- 标记表示是否还搜索其子目录
- 匹配文件的正则表达式。
Webpack 会在构建中解析代码中的 require.context()
。
语法如下:
require.context(
directory,
(useSubdirectories = true),
(regExp = /^\.\/.*$/),
(mode = 'sync')
);
示例:
require.context('./test', false, /\.test\.js$/);
//(创建出)一个 context,其中文件来自 test 目录,request 以 `.test.js` 结尾。
require.context('../', true, /\.stories\.js$/);
// (创建出)一个 context,其中所有文件都来自父文件夹及其所有子级文件夹,request 以 `.stories.js` 结尾。
Warning
传递给require.context
的参数必须是字面量(literal)!
一个 context module 会导出一个(require)函数,此函数可以接收一个参数:request。
此导出函数有三个属性:resolve
, keys
, id
。
resolve
是一个函数,它返回 request 被解析后得到的模块 id。keys
也是一个函数,它返回一个数组,由所有可能被此 context module 处理的请求(译者注:参考下面第二段代码中的 key)组成。如果想引入一个文件夹下面的所有文件,或者引入能匹配一个正则表达式的所有文件,这个功能就会很有帮助,例如:
const cache = {};
function importAll(r) {
r.keys().forEach((key) => (cache[key] = r(key)));
}
importAll(require.context('../components/', true, /\.js$/));
// 在构建时(build-time),所有被 require 的模块都会被填充到 cache 对象中。
id
是 context module 的模块 id. 它可能在你使用 module.hot.accept
时会用到。example_directory
│
└───modules
│ │─── a.js
│ │─── b.js
│ └─── c.js
└──────index.js
index.js
const files = require.context('./modules', false, /.js$/);
const modules = {};
console.log('files:', files);
files.keys().forEach((key) => {
console.log('key:', key);
modules[key.replace(/(\.\/|\.js)/g, '')] = files(key).default;
});
console.log('modules:', modules);
console.log('resolve:', files.resolve('./a.js'));
console.log('files.id:', files.id);
比如 Vuex 自动引入 ./modules 下所有的 vuex 子模块
store/index.js
import Vue from 'vue'
import Vuex from 'vuex'
import getters from './getters'
Vue.use(Vuex)
// 创建上下文
const files = require.context('./modules', false, /\.js$/)
const modules = {}
// 自动引入 ./modules 下所有的 vuex 子模块
files.keys().forEach((key) => {
modules[key.replace(/(\.\/|\.js)/g, '')] = files(key).default
})
export default new Vuex.Store({
modules,
state: {},
mutations: {},
actions: {},
getters,
})