在vue 中使用webpack require.context

在vue项目中,我们拆分某些组件,然后在使用组件的页面import进来。这样就会导致一个问题。

import BaseButton from './BaseButton.vue'
import BaseIcon from './BaseIcon.vue'
import BaseInput from './BaseInput.vue'
import BaseInput from './BaseWrap.vue'
import BaseInput from './BaseInfo.vue'
... 下面引入大量的组件

问题显而易见,引入很多组件不仅看上去不美观,同时也增加了一定的维护成本。
这个时候我们就可以利用require.context对于这些组件进行引入注册。
(其实在vue官网已经给出了例子https://cn.vuejs.org/v2/guide/components-registration.html#%E5%9F%BA%E7%A1%80%E7%BB%84%E4%BB%B6%E7%9A%84%E8%87%AA%E5%8A%A8%E5%8C%96%E5%85%A8%E5%B1%80%E6%B3%A8%E5%86%8C

简单的来说就是可以给这个函数传入三个参数:一个要搜索的目录,一个标记表示是否还搜索其子目录, 以及一个匹配文件的正则表达式。

import Vue from 'vue'
import upperFirst from 'lodash/upperFirst'
import camelCase from 'lodash/camelCase'

const requireComponent = require.context(
  // 其组件目录的相对路径
  './components',
  // 是否查询其子目录
  false,
  // 匹配基础组件文件名的正则表达式
  /Base[A-Z]\w+\.(vue|js)$/
)

requireComponent.keys().forEach(fileName => {
  // 获取组件配置
  const componentConfig = requireComponent(fileName)
  // 这个地方直接传入filename其实就是内部会调用了resolve方法,会返回对应的文件内容(不理解可以console一下看看)
  // 获取组件的 PascalCase 命名
  const componentName = upperFirst(
    camelCase(
      // 获取和目录深度无关的文件名
      fileName
        .split('/')
        .pop()
        .replace(/\.\w+$/, '')
    )
  )

  // 全局注册组件
  Vue.component(
    componentName,
    // 如果这个组件选项是通过 `export default` 导出的,
    // 那么就会优先使用 `.default`,
    // 否则回退到使用模块的根。
    componentConfig.default || componentConfig
  )
})

webpack官网上面的解释:

如果你的 request 含有表达式(expressions),就会创建一个上下文(context),因为在编译时(compile time)并不清楚 具体 导入哪个模块。会生成一个 context module(上下文模块)。会生成一个 context module(上下文模块)。它包含 目录下的所有模块 的引用,如果一个 request 符合正则表达式,就能 require 进来。该context module包含一个map(映射)对象,会把requests翻译成对应的模块id。

wepack大概就是会解析成下面这样

var map = {  "./approvals/AAdditionalBudgetApprove.vue": "./src/components/approvals/AAdditionalBudgetApprove.vue",  
"./approvals/AMonthlyBudgetApprove.vue": "./src/components/approvals/AMonthlyBudgetApprove.vue",  
"./approvals/ASpecialInMonthlyApprove.vue": "./src/components/approvals/ASpecialInMonthlyApprove.vue",  
"./approvals/ASpecialOutsideMonthlyApprove.vue": "./src/components/approvals/ASpecialOutsideMonthlyApprove.vue",  
"./approvals/BAdditionalBudgetApprove.vue": "./src/components/approvals/BAdditionalBudgetApprove.vue",  
"./approvals/BMonthlyBudgetApprove.vue": "./src/components/approvals/BMonthlyBudgetApprove.vue",  
"./approvals/BSpecialInMonthlyApprove.vue": "./src/components/approvals/BSpecialInMonthlyApprove.vue",  
"./details/AAdditionalBudgetDetail.vue": "./src/components/details/AAdditionalBudgetDetail.vue",  
"./details/AMonthlyBudgetDetail.vue": "./src/components/details/AMonthlyBudgetDetail.vue",  
"./details/ASpecialInMonthlyDetail.vue": "./src/components/details/ASpecialInMonthlyDetail.vue",  
"./details/ASpecialOutsideMonthlyDetail.vue": "./src/components/details/ASpecialOutsideMonthlyDetail.vue",  
"./details/BAdditionalBudgetDetail.vue": "./src/components/details/BAdditionalBudgetDetail.vue",  
"./details/BMonthlyBudgetDetail.vue": "./src/components/details/BMonthlyBudgetDetail.vue",  
"./details/BSpecialInMonthlyDetail.vue": "./src/components/details/BSpecialInMonthlyDetail.vue"  
}; 
 function webpackContext(req) {  
     var id = webpackContextResolve(req);  
      return __webpack_require__(id); 
 }  
function webpackContextResolve(req) {  
     var id = map[req]; 
     if(!(id + 1)) { // check for number or string 
         var e = new Error("Cannot find module '" + req + "'");  
         e.code = 'MODULE_NOT_FOUND';  
         throw e; 
      }  
      return id; 
 }  
webpackContext.keys = function webpackContextKeys() { 
     return Object.keys(map); 
 };  
webpackContext.resolve = webpackContextResolve;  
module.exports = webpackContext; 
webpackContext.id= "./src/components sync recursive (Detail|Approve)\\.vue$";

怎么样是不是明白一些了。
我们再来require.context函数会返回三个属性:resolve, keys, id。

resolve 是一个函数,它返回 request 被解析后得到的模块 id。
keys 也是一个函数,它返回一个数组,由所有可能被此 context module 处理的请组成。

对照上面的代码再来看这些参数:

keys 方法其实就是对map映射做了一个获取key的操作
然后resolve的时候需要传递相应的map 映射对象的key获取对应的文件
id 是 context module 的模块 id. (感觉像是解析了一下正则然后拼接的路径,这个感觉没啥大用)
来看webpack官网的解释:
id 是 context module 的模块 id. 它可能在你使用 module.hot.accept 时会用到。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350