vue按需加载组件-webpack require.ensure
使用 vue-cli构建的项目,在 默认情况下 ,执行 npm run build 会将所有的js代码打包为一个整体,
打包位置是 dist/static/js/app.[contenthash].js
类似下面的路由代码
router/index.js 路由相关信息,该路由文件引入了多个 .vue组件
import Hello from \'@/components/Hello\'
import Province from \'@/components/Province\'
import Segment from \'@/components/Segment\'
import User from \'@/components/User\'
import Loading from \'@/components/Loading\'- 1
- 2
- 3
- 4
- 5
执行 npm run build 会打包为一个整体 app.[contenthash].js ,这个文件是非常大,可能几兆或者几十兆,加载会很慢
所以我们需要分模块打包,把我们想要组合在一起的组件打包到一个 chunk块中去,分模块打包需要下面这样使用 webpack的 require.ensure,并且在最后加入一个 chunk名,相同 chunk名字的模块将会打包到一起。
webpack中利用require.ensure()实现按需加载
1、require.ensure()
webpack 在编译时，会静态地解析代码中的 require.ensure()，同时将模块添加到一个分开的 chunk 当中。这个新的 chunk 会被 webpack 通过 jsonp 来按需加载。
语法如下：
require.ensure(dependencies: String[], callback: function(require), chunkName: String)- 1
- 依赖 dependencies
这是一个字符串数组，通过这个参数，在所有的回调函数的代码被执行前，我们可以将所有需要用到的模块进行声明。
- 回调 callback
当所有的依赖都加载完成后，webpack会执行这个回调函数。require 对象的一个实现会作为一个参数传递给这个回调函数。因此，我们可以进一步 require() 依赖和其它模块提供下一步的执行。
- chunk名称 chunkName
chunkName 是提供给这个特定的 require.ensure() 的 chunk 的名称。通过提供 require.ensure() 不同执行点相同的名称，我们可以保证所有的依赖都会一起放进相同的 文件束(bundle)。
让我们来看以下的项目
\\ file structure
|
js --|
| |-- entry.js
| |-- a.js
| |-- b.js
webpack.config.js
|
dist- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
\\ entry.js
require(\'a\');
require.ensure([], function(require){
require(\'b\');
});- 1
- 2
- 3
- 4
- 5
- 6
\\ a.js
console.log(\'***** I AM a *****\');- 1
- 2
\\ b.js
console.log(\'***** I AM b *****\');- 1
- 2
\\ webpack.config.js
var path = require(\'path\');
module.exports = function(env) {
return {
entry: \'./js/entry.js\',
output: {
filename: \'bundle.js\',
path: path.resolve(__dirname, \'dist\')
}
}
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
通过执行这个项目的 webpack 构建，我们发现 webpack 创建了2个新的文件束， bundle.js 和 0.bundle.js。
entry.js 和 a.js 被打包进 bundle.js.
b.js 被打包进 0.bundle.js.
2、require.ensure() 的坑点
（1）、空数组作为参数
require.ensure([], function(require){
require(\'./a.js\');
});- 1
- 2
- 3
以上代码保证了拆分点被创建，而且 a.js 被 webpack 分开打包。
（2）、依赖作为参数
require.ensure([\'./a.js\'], function(require) {
require(\'./b.js\');
});- 1
- 2
- 3
上面代码， a.js 和 b.js 都被打包到一起，而且从主文件束中拆分出来。但只有 b.js 的内容被执行。a.js 的内容仅仅是可被使用，但并没有被输出。
想去执行 a.js，我们需要异步地引用它，如 require(‘./a.js’)，让它的 JavaScritp 被执行。
（3）、单独打包成自己写的名字配置
需要配置chunkFilename,和publicPath。publicPath是按需加载单独打包出来的chunk是以publicPath会基准来存放的，chunkFilename:[name].js这样才会最终生成正确的路径和名字
module.exports={
entry:\'./js/entry.js\',
output:{
path:path.resolve(__dirname,"./dist"),
filename:\'js/a.bundle.js\',
publicPath:"./",
chunkFilename:\'js/[name].js\'
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
所以router/index.js 修改为懒加载组件：
const Province = r => require.ensure([], () => r(require(\'@/components/Province.vue\')), \'chunkname1\')
const Segment = r => require.ensure([], () => r(require(\'@/components/Segment.vue\')), \'chunkname2\')
const Loading = r => require.ensure([], () => r(require(\'@/components/Loading.vue\')), \'chunkname3\')
const User = r => require.ensure([], () => r(require(\'@/components/User.vue\')), \'chunkname3\')- 1
- 2
- 3
- 4
根据 chunkame的不同, 上面的四个组件, 将会被分成3个块打包,最终打包之后与组件相关的js文件会分为3个 (除了app.js,manifest.js, vendor.js)
分模块打包之后在 dist目录下是这样的, 这样就把一个大的 js文件分为一个个小的js文件了,按需去下载,其他的使用方法和import的效果一样
参考：http://blog.csdn.net/yangbingbinga/article/details/61417689
http://www.css88.com/doc/webpack2/guides/code-splitting-require/
一、require.ensure() 方法来实现代码打包分离
require.ensure() 是 webpack 特有的，已经被 import() 取代。
require.ensure( dependencies: String[], callback: function(require), errorCallback: function(error), chunkName: String ) 给定 dependencies 参数，将其对应的文件拆分到一个单独的 bundle 中，此 bundle 会被异步加载。 当使用 CommonJS 模块语法时，这是动态加载依赖的唯一方法。 意味着，可以在模块执行时才运行代码，只有在满足某些条件时才加载依赖项。 这个特性依赖于内置的 Promise。如果想在低版本浏览器使用 require.ensure， 记得使用像 es6-promise 或者 promise-polyfill 这样 polyfill 库， 来预先填充(shim) Promise 环境。
var a = require(\'normal-dep\');
if ( module.hot ) {
require.ensure([\'b\'], function(require) {
var c = require(\'c\');
// Do something special...
});
}
按照上面指定的顺序，webpack 支持以下参数：
-
dependencies：字符串构成的数组，声明callback回调函数中所需的所有模块。 -
callback：只要加载好全部依赖，webpack 就会执行此函数。require函数的实现，作为参数传入此函数。当程序运行需要依赖时，可以使用require()来加载依赖。函数体可以使用此参数，来进一步执行require()模块。 -
errorCallback：当 webpack 加载依赖失败时，会执行此函数。 -
chunkName：由require.ensure()创建出的 chunk 的名字。通过将同一个chunkName传递给不同的require.ensure()调用，我们可以将它们的代码合并到一个单独的 chunk 中，从而只产生一个浏览器必须加载的 bundle。
虽然我们将 require 的实现，作为参数传递给回调函数，然而如果使用随意的名字，
例如 require.ensure([], function(request) { request(\'someModule\'); })
则无法被 webpack 静态解析器处理，所以还是请使用 require，例如 require.ensure([], function(require) { require(\'someModule\'); })。
二、在vue中使用import()来代替require.ensure()实现代码打包分离
有时候我们想把某个路由下的所有组件都打包在同个异步块 (chunk) 中。
只需要使用 命名 chunk，一个特殊的注释语法来提供 chunk name (需要 Webpack > 2.4)。
const Foo = () => import(/* webpackChunkName: "group-foo" */ \'./Foo.vue\') const Bar = () => import(/* webpackChunkName: "group-foo" */ \'./Bar.vue\') const Baz = () => import(/* webpackChunkName: "group-foo" */ \'./Baz.vue\') Webpack 会将任何一个异步模块与相同的块名称组合到相同的异步块中。
例：require.ensure()实现
const notFound = r => require.ensure([], () => r(require(\'@views/common/404\')), \'index\') const login = r => require.ensure([], () => r(require(\'@views/common/login\')), \'index\') const register = r => require.ensure([], () => r(require(\'@views/common/register\')), \'index\') const main = r => require.ensure([], () => r(require(\'@views/main\')), \'index\') const myWorks = r => require.ensure([], () => r(require(\'@views/my/index\')), \'my\') const myAccountSetting = r => require.ensure([], () => r(require(\'@views/my/account-setting\')), \'my\') const makeIndex = r => require.ensure([], () => r(require(\'@views/make/index\')), \'make\')
例：import()实现
const notFound = () => import(/* webpackChunkName: "index" */ \'@views/common/404\') const login = () => import(/* webpackChunkName: "index" */ \'@views/common/login\') const register = () => import(/* webpackChunkName: "index" */ \'@views/common/register\') const main = () => import(/* webpackChunkName: "index" */ \'@views/main\') const myWorks = () => import(/* webpackChunkName: "my" */ \'@views/my/index\') const myAccountSetting = () => import(/* webpackChunkName: "my" */ \'@views/my/account-setting\') const makeIndex = () => import(/* webpackChunkName: "make" */ \'@views/make/index\')