webpack/examples/extra-async-chunk/README.md

372 lines
11 KiB
Markdown
Raw Normal View History

2015-01-12 06:17:24 +08:00
This example shows how to create a async loaded commons chunk.
When a chunk has many child chunks which share common modules the `CommonsChunkPlugin` can extract these common modules into a commons chunk which is loaded in parallel to the requested child chunk.
The example entry references two chunks:
* entry chunk
* async require -> chunk X
* async require -> chunk Y
* chunk X
* module `a`
* module `b`
* module `c`
* chunk Y
* module `a`
* module `b`
* module `d`
These chunks share modules `a` and `b`. The `CommonsChunkPlugin` extract these into chunk Z:
* entry chunk
* async require -> chunk X & Z
* async require -> chunk Y & Z
* chunk X
* module `c`
* chunk Y
* module `d`
* chunk Z
* module `a`
* module `b`
Pretty useful for a router in a SPA.
# example.js
``` javascript
// a chunks with a, b, c
require(["./a", "./b", "./c"], function(a, b, c) {});
// a chunk with a, b, d
require.ensure(["./a"], function(require) {
require("./b");
require("./d");
});
```
# webpack.config.js
``` javascript
var path = require("path");
var CommonsChunkPlugin = require("../../lib/optimize/CommonsChunkPlugin");
module.exports = {
plugins: [
new CommonsChunkPlugin({
// process all children of the main chunk
// if omitted it would process all chunks
name: "main",
// create a additional async chunk for the common modules
// which is loaded in parallel to the requested chunks
async: true
})
]
}
```
# js/output.js
2016-09-07 18:28:56 +08:00
<details><summary>`/******/ (function(modules) { /* webpackBootstrap */ })`</summary>
``` javascript
/******/ (function(modules) { // webpackBootstrap
/******/ // install a JSONP callback for chunk loading
/******/ var parentJsonpFunction = window["webpackJsonp"];
2016-06-06 02:51:44 +08:00
/******/ window["webpackJsonp"] = function webpackJsonpCallback(chunkIds, moreModules, executeModules) {
/******/ // add "moreModules" to the modules object,
/******/ // then flag all "chunkIds" as loaded and fire callback
2016-06-06 02:51:44 +08:00
/******/ var moduleId, chunkId, i = 0, resolves = [], result;
/******/ for(;i < chunkIds.length; i++) {
/******/ chunkId = chunkIds[i];
/******/ if(installedChunks[chunkId])
2016-02-04 07:27:47 +08:00
/******/ resolves.push(installedChunks[chunkId][0]);
/******/ installedChunks[chunkId] = 0;
/******/ }
/******/ for(moduleId in moreModules) {
2016-06-06 02:51:44 +08:00
/******/ if(Object.prototype.hasOwnProperty.call(moreModules, moduleId)) {
/******/ modules[moduleId] = moreModules[moduleId];
/******/ }
/******/ }
2016-06-06 02:51:44 +08:00
/******/ if(parentJsonpFunction) parentJsonpFunction(chunkIds, moreModules, executeModules);
2016-02-04 07:27:47 +08:00
/******/ while(resolves.length)
/******/ resolves.shift()();
2015-06-13 23:41:14 +08:00
/******/ };
2015-06-13 23:41:14 +08:00
/******/ // The module cache
/******/ var installedModules = {};
2015-06-13 23:41:14 +08:00
2016-02-04 07:27:47 +08:00
/******/ // objects to store loaded and loading chunks
/******/ var installedChunks = {
2016-09-07 18:28:56 +08:00
/******/ 3: 0
/******/ };
2015-06-13 23:41:14 +08:00
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
2015-06-13 23:41:14 +08:00
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId])
/******/ return installedModules[moduleId].exports;
2015-06-13 23:41:14 +08:00
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
2016-06-06 02:51:44 +08:00
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
2015-06-13 23:41:14 +08:00
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
2015-06-13 23:41:14 +08:00
/******/ // Flag the module as loaded
2016-06-06 02:51:44 +08:00
/******/ module.l = true;
2015-06-13 23:41:14 +08:00
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
2015-06-13 23:41:14 +08:00
/******/ // This file contains only the entry chunk.
/******/ // The chunk loading function for additional chunks
2016-02-04 07:27:47 +08:00
/******/ __webpack_require__.e = function requireEnsure(chunkId) {
/******/ if(installedChunks[chunkId] === 0)
2016-06-06 02:51:44 +08:00
/******/ return Promise.resolve();
2016-02-04 07:27:47 +08:00
/******/ // an Promise means "currently loading".
/******/ if(installedChunks[chunkId]) {
/******/ return installedChunks[chunkId][2];
/******/ }
2016-02-04 07:27:47 +08:00
/******/ // start chunk loading
/******/ var head = document.getElementsByTagName('head')[0];
/******/ var script = document.createElement('script');
/******/ script.type = 'text/javascript';
/******/ script.charset = 'utf-8';
/******/ script.async = true;
/******/ script.timeout = 120000;
/******/ script.src = __webpack_require__.p + "" + chunkId + ".output.js";
2016-02-04 07:27:47 +08:00
/******/ var timeout = setTimeout(onScriptComplete, 120000);
/******/ script.onerror = script.onload = onScriptComplete;
/******/ function onScriptComplete() {
/******/ // avoid mem leaks in IE.
/******/ script.onerror = script.onload = null;
/******/ clearTimeout(timeout);
/******/ var chunk = installedChunks[chunkId];
/******/ if(chunk !== 0) {
/******/ if(chunk) chunk[1](new Error('Loading chunk ' + chunkId + ' failed.'));
/******/ installedChunks[chunkId] = undefined;
/******/ }
/******/ };
/******/ head.appendChild(script);
/******/ var promise = new Promise(function(resolve, reject) {
/******/ installedChunks[chunkId] = [resolve, reject];
/******/ });
/******/ return installedChunks[chunkId][2] = promise;
/******/ };
2015-06-13 23:41:14 +08:00
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
2015-06-13 23:41:14 +08:00
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
2015-06-13 23:41:14 +08:00
2016-12-08 02:14:47 +08:00
/******/ // identity function for calling harmony imports with the correct context
2016-06-06 02:51:44 +08:00
/******/ __webpack_require__.i = function(value) { return value; };
2016-12-08 02:14:47 +08:00
/******/ // define getter function for harmony exports
2016-09-07 18:28:56 +08:00
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ Object.defineProperty(exports, name, {
/******/ configurable: false,
/******/ enumerable: true,
/******/ get: getter
/******/ });
/******/ };
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__.n = function(module) {
/******/ var getter = module && module.__esModule ?
/******/ function getDefault() { return module['default']; } :
/******/ function getModuleExports() { return module; };
/******/ __webpack_require__.d(getter, 'a', getter);
/******/ return getter;
/******/ };
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
2016-02-04 20:02:53 +08:00
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "js/";
2016-02-04 07:27:47 +08:00
/******/ // on error function for async loading
2016-06-06 02:51:44 +08:00
/******/ __webpack_require__.oe = function(err) { console.error(err); throw err; };
2016-02-04 07:27:47 +08:00
/******/ // Load entry module and return exports
2016-02-04 07:27:47 +08:00
/******/ return __webpack_require__(__webpack_require__.s = 4);
/******/ })
/************************************************************************/
2016-09-07 18:28:56 +08:00
```
</details>
``` javascript
2016-02-04 07:27:47 +08:00
/******/ ({
/***/ 4:
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
/*!********************!*\
!*** ./example.js ***!
\********************/
/***/ function(module, exports, __webpack_require__) {
2016-09-07 18:28:56 +08:00
// a chunks with a, b, c
Promise.all/* require */([__webpack_require__.e(0), __webpack_require__.e(2)]).catch(function(err) { __webpack_require__.oe(err); }).then(function() { var __WEBPACK_AMD_REQUIRE_ARRAY__ = [__webpack_require__(/*! ./a */ 0), __webpack_require__(/*! ./b */ 1), __webpack_require__(/*! ./c */ 2)]; (function(a, b, c) {}.apply(null, __WEBPACK_AMD_REQUIRE_ARRAY__));});
2016-09-07 18:28:56 +08:00
// a chunk with a, b, d
Promise.all/* nsure */([__webpack_require__.e(0), __webpack_require__.e(1)]).catch(function(err) { __webpack_require__.oe(err); }).then((function(require) {
__webpack_require__(/*! ./b */ 1);
__webpack_require__(/*! ./d */ 3);
}).bind(null, __webpack_require__));
/***/ }
2016-02-04 07:27:47 +08:00
/******/ });
```
# js/0.output.js
``` javascript
2016-02-04 07:27:47 +08:00
webpackJsonp([0],[
/* 0 */
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
2016-02-04 07:27:47 +08:00
/*!**************!*\
!*** ./a.js ***!
\**************/
/***/ function(module, exports) {
2016-09-07 18:28:56 +08:00
module.exports = "a";
2016-02-04 07:27:47 +08:00
/***/ },
/* 1 */
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
/*!**************!*\
2016-02-04 07:27:47 +08:00
!*** ./b.js ***!
\**************/
2015-06-13 23:41:14 +08:00
/***/ function(module, exports) {
2016-09-07 18:28:56 +08:00
module.exports = "b";
/***/ }
2016-02-04 07:27:47 +08:00
]);
```
# js/1.output.js
``` javascript
2016-09-07 18:28:56 +08:00
webpackJsonp([1],{
2016-02-04 07:27:47 +08:00
/***/ 3:
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
/*!**************!*\
!*** ./d.js ***!
\**************/
2015-06-13 23:41:14 +08:00
/***/ function(module, exports) {
2016-09-07 18:28:56 +08:00
module.exports = "d";
/***/ }
});
```
# js/2.output.js
``` javascript
2016-09-07 18:28:56 +08:00
webpackJsonp([2],{
2016-02-04 07:27:47 +08:00
/***/ 2:
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
/*!**************!*\
2016-02-04 07:27:47 +08:00
!*** ./c.js ***!
\**************/
2015-06-13 23:41:14 +08:00
/***/ function(module, exports) {
2016-09-07 18:28:56 +08:00
module.exports = "c";
/***/ }
2016-02-04 07:27:47 +08:00
});
```
# Info
## Uncompressed
```
Hash: 2697c2e890ef9a735355
Version: webpack 2.1.0-beta.25
Time: 125ms
Asset Size Chunks Chunk Names
0.output.js 397 bytes 0 [emitted]
1.output.js 212 bytes 1 [emitted]
2.output.js 212 bytes 2 [emitted]
output.js 6.13 kB 3 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
chunk {0} 0.output.js 42 bytes {3} [rendered]
2016-02-04 07:27:47 +08:00
> async commons [4] ./example.js 2:0-52
> async commons [4] ./example.js 5:0-8:2
[0] ./a.js 21 bytes {0} [built]
amd require ./a [4] ./example.js 2:0-52
require.ensure item ./a [4] ./example.js 5:0-8:2
[1] ./b.js 21 bytes {0} [built]
amd require ./b [4] ./example.js 2:0-52
cjs require ./b [4] ./example.js 6:1-15
chunk {1} 1.output.js 21 bytes {3} [rendered]
2016-02-04 07:27:47 +08:00
> [4] ./example.js 5:0-8:2
2016-09-07 18:28:56 +08:00
[3] ./d.js 21 bytes {1} [built]
2016-02-04 07:27:47 +08:00
cjs require ./d [4] ./example.js 7:1-15
chunk {2} 2.output.js 21 bytes {3} [rendered]
2016-02-04 07:27:47 +08:00
> [4] ./example.js 2:0-52
2016-09-07 18:28:56 +08:00
[2] ./c.js 21 bytes {2} [built]
2016-02-04 07:27:47 +08:00
amd require ./c [4] ./example.js 2:0-52
chunk {3} output.js (main) 186 bytes [entry] [rendered]
2016-09-07 18:28:56 +08:00
> main [4] ./example.js
[4] ./example.js 186 bytes {3} [built]
```
## Minimized (uglify-js, no zip)
```
Hash: 2697c2e890ef9a735355
Version: webpack 2.1.0-beta.25
Time: 279ms
Asset Size Chunks Chunk Names
0.output.js 78 bytes 0 [emitted]
1.output.js 51 bytes 1 [emitted]
2.output.js 51 bytes 2 [emitted]
output.js 1.54 kB 3 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
chunk {0} 0.output.js 42 bytes {3} [rendered]
2016-02-04 07:27:47 +08:00
> async commons [4] ./example.js 2:0-52
> async commons [4] ./example.js 5:0-8:2
[0] ./a.js 21 bytes {0} [built]
amd require ./a [4] ./example.js 2:0-52
require.ensure item ./a [4] ./example.js 5:0-8:2
[1] ./b.js 21 bytes {0} [built]
amd require ./b [4] ./example.js 2:0-52
cjs require ./b [4] ./example.js 6:1-15
chunk {1} 1.output.js 21 bytes {3} [rendered]
2016-02-04 07:27:47 +08:00
> [4] ./example.js 5:0-8:2
2016-09-07 18:28:56 +08:00
[3] ./d.js 21 bytes {1} [built]
2016-02-04 07:27:47 +08:00
cjs require ./d [4] ./example.js 7:1-15
chunk {2} 2.output.js 21 bytes {3} [rendered]
2016-02-04 07:27:47 +08:00
> [4] ./example.js 2:0-52
2016-09-07 18:28:56 +08:00
[2] ./c.js 21 bytes {2} [built]
2016-02-04 07:27:47 +08:00
amd require ./c [4] ./example.js 2:0-52
chunk {3} output.js (main) 186 bytes [entry] [rendered]
2016-09-07 18:28:56 +08:00
> main [4] ./example.js
[4] ./example.js 186 bytes {3} [built]
```