webpack/examples/code-splitting/README.md

315 lines
9.5 KiB
Markdown
Raw Normal View History

2015-05-21 22:28:26 +08:00
This example illustrates a very simple case of Code Splitting with `require.ensure`.
2014-07-24 17:29:49 +08:00
2015-05-21 22:28:26 +08:00
* `a` and `b` are required normally via CommonJS
2016-03-13 15:36:56 +08:00
* `c` is depended through the `require.ensure` array.
2014-07-24 17:29:49 +08:00
* This means: make it available, but don't execute it
* webpack will load it on demand
* `b` and `d` are required via CommonJs in the `require.ensure` callback
* webpack detects that these are in the on-demand-callback and
* will load them on demand
* webpacks optimizer can optimize `b` away
* as it is already available through the parent chunks
You can see that webpack outputs two files/chunks:
2015-05-21 22:28:26 +08:00
* `output.js` is the entry chunk and contains
2014-07-24 17:29:49 +08:00
* the module system
* chunk loading logic
* the entry point `example.js`
* module `a`
* module `b`
2016-02-04 07:27:47 +08:00
* `1.js` is an additional chunk (on demand loaded) and contains
2014-07-24 17:29:49 +08:00
* module `c`
* module `d`
You can see that chunks are loaded via JSONP. The additional chunks are pretty small and minimize well.
2012-03-10 20:11:23 +08:00
# example.js
``` javascript
var a = require("a");
var b = require("b");
require.ensure(["c"], function(require) {
require("b").xyz();
var d = require("d");
});
```
# js/output.js
2016-09-07 18:28:56 +08:00
<details><summary>`/******/ (function(modules) { /* webpackBootstrap */ })`</summary>
2012-03-10 20:11:23 +08:00
``` javascript
2013-03-28 17:31:52 +08:00
/******/ (function(modules) { // webpackBootstrap
2014-07-24 17:29:49 +08:00
/******/ // 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) {
2014-07-24 17:29:49 +08:00
/******/ // 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;
2014-07-24 17:29:49 +08:00
/******/ for(;i < chunkIds.length; i++) {
/******/ chunkId = chunkIds[i];
/******/ if(installedChunks[chunkId])
2016-02-04 07:27:47 +08:00
/******/ resolves.push(installedChunks[chunkId][0]);
2014-07-24 17:29:49 +08:00
/******/ 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];
/******/ }
2014-07-24 17:29:49 +08:00
/******/ }
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
2014-07-24 17:29:49 +08:00
/******/ };
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +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
2013-12-16 06:30:50 +08:00
/******/ var installedChunks = {
2016-09-07 18:28:56 +08:00
/******/ 1: 0
2013-12-16 06:30:50 +08:00
/******/ };
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +08:00
/******/ // The require function
2014-03-25 17:44:10 +08:00
/******/ function __webpack_require__(moduleId) {
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +08:00
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId])
2014-03-25 17:44:10 +08:00
/******/ return installedModules[moduleId].exports;
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +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: {}
2013-03-28 17:31:52 +08:00
/******/ };
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +08:00
/******/ // Execute the module function
2014-03-25 17:44:10 +08:00
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +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
2013-03-28 17:31:52 +08:00
/******/ // Return the exports of the module
2014-03-25 17:44:10 +08:00
/******/ return module.exports;
2013-03-28 17:31:52 +08:00
/******/ }
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +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) {
2013-03-28 17:31:52 +08:00
/******/ 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];
2013-03-28 17:31:52 +08:00
/******/ }
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;
2013-03-28 17:31:52 +08:00
/******/ };
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +08:00
/******/ // expose the modules object (__webpack_modules__)
2014-03-25 17:44:10 +08:00
/******/ __webpack_require__.m = modules;
2015-06-13 23:41:14 +08:00
2013-03-28 17:31:52 +08:00
/******/ // expose the module cache
2014-03-25 17:44:10 +08:00
/******/ __webpack_require__.c = installedModules;
2015-06-13 23:41:14 +08:00
2016-06-06 02:51:44 +08:00
/******/ // identity function for calling harmory imports with the correct context
/******/ __webpack_require__.i = function(value) { return value; };
2016-09-07 18:28:56 +08:00
/******/ // define getter function for harmory exports
/******/ __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
2013-03-28 17:31:52 +08:00
/******/ // Load entry module and return exports
2016-09-07 18:28:56 +08:00
/******/ return __webpack_require__(__webpack_require__.s = 4);
2013-03-28 17:31:52 +08:00
/******/ })
2013-03-27 01:22:30 +08:00
/************************************************************************/
2016-09-07 18:28:56 +08:00
```
</details>
``` javascript
2013-12-16 06:30:50 +08:00
/******/ ([
/* 0 */
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
2016-02-04 07:27:47 +08:00
/*!****************!*\
!*** ./~/b.js ***!
\****************/
/***/ function(module, exports) {
2013-01-31 01:49:25 +08:00
2016-09-07 18:28:56 +08:00
// module b
2013-01-31 01:49:25 +08:00
/***/ },
2013-12-16 06:30:50 +08:00
/* 1 */
2016-09-07 18:28:56 +08:00
/* unknown exports provided */
/* all exports used */
2013-01-31 01:49:25 +08:00
/*!****************!*\
2015-06-13 23:41:14 +08:00
!*** ./~/a.js ***!
2013-01-31 01:49:25 +08:00
\****************/
2015-06-13 23:41:14 +08:00
/***/ function(module, exports) {
2013-01-31 01:49:25 +08:00
2016-09-07 18:28:56 +08:00
// module a
2013-01-31 01:49:25 +08:00
/***/ },
2016-09-07 18:28:56 +08:00
/* 2 */,
/* 3 */,
/* 4 */
/* unknown exports provided */
/* all exports used */
2016-02-04 07:27:47 +08:00
/*!********************!*\
!*** ./example.js ***!
\********************/
/***/ function(module, exports, __webpack_require__) {
2013-01-31 01:49:25 +08:00
2016-09-07 18:28:56 +08:00
var a = __webpack_require__(/*! a */ 1);
var b = __webpack_require__(/*! b */ 0);
__webpack_require__.e/* nsure */(0).catch(function(err) { __webpack_require__.oe(err); }).then((function(require) {
__webpack_require__(/*! b */ 0).xyz();
var d = __webpack_require__(/*! d */ 3);
}).bind(null, __webpack_require__));
2013-01-31 01:49:25 +08:00
/***/ }
2015-06-13 23:41:14 +08:00
/******/ ]);
2012-03-10 20:11:23 +08:00
```
# js/0.output.js
2012-03-10 20:11:23 +08:00
``` javascript
2016-09-07 18:28:56 +08:00
webpackJsonp([0],[
2013-12-16 06:30:50 +08:00
/* 0 */,
/* 1 */,
2016-09-07 18:28:56 +08:00
/* 2 */
/* unknown exports provided */
/* all exports used */
2013-01-31 01:49:25 +08:00
/*!****************!*\
!*** ./~/c.js ***!
\****************/
2015-06-13 23:41:14 +08:00
/***/ function(module, exports) {
2012-11-08 17:53:54 +08:00
2016-09-07 18:28:56 +08:00
// module c
2012-11-08 17:53:54 +08:00
2013-01-31 01:49:25 +08:00
/***/ },
2016-09-07 18:28:56 +08:00
/* 3 */
/* unknown exports provided */
/* all exports used */
2013-01-31 01:49:25 +08:00
/*!****************!*\
!*** ./~/d.js ***!
\****************/
2015-06-13 23:41:14 +08:00
/***/ function(module, exports) {
2012-11-08 17:53:54 +08:00
2016-09-07 18:28:56 +08:00
// module d
2012-11-08 17:53:54 +08:00
2013-01-31 01:49:25 +08:00
/***/ }
2014-07-24 17:29:49 +08:00
]);
2012-03-10 20:11:23 +08:00
```
Minimized
``` javascript
2016-09-07 18:28:56 +08:00
webpackJsonp([0],[,,function(n,c){},function(n,c){}]);
2012-03-10 20:11:23 +08:00
```
# Info
## Uncompressed
2012-03-20 03:47:58 +08:00
```
Hash: 577f55cf480fb59add7d
Version: webpack 2.1.0-beta.25
Time: 150ms
Asset Size Chunks Chunk Names
0.output.js 407 bytes 0 [emitted]
output.js 6.16 kB 1 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
chunk {0} 0.output.js 22 bytes {1} [rendered]
2016-09-07 18:28:56 +08:00
> [4] ./example.js 3:0-6:2
[2] ./~/c.js 11 bytes {0} [built]
require.ensure item c [4] ./example.js 3:0-6:2
[3] ./~/d.js 11 bytes {0} [built]
cjs require d [4] ./example.js 5:12-24
chunk {1} output.js (main) 161 bytes [entry] [rendered]
2016-09-07 18:28:56 +08:00
> main [4] ./example.js
[0] ./~/b.js 11 bytes {1} [built]
cjs require b [4] ./example.js 2:8-20
cjs require b [4] ./example.js 4:4-16
[1] ./~/a.js 11 bytes {1} [built]
cjs require a [4] ./example.js 1:8-20
[4] ./example.js 139 bytes {1} [built]
2012-03-10 20:11:23 +08:00
```
2012-03-12 04:37:18 +08:00
## Minimized (uglify-js, no zip)
2012-03-10 20:11:23 +08:00
2012-03-20 03:47:58 +08:00
```
Hash: 577f55cf480fb59add7d
Version: webpack 2.1.0-beta.25
Time: 292ms
Asset Size Chunks Chunk Names
0.output.js 54 bytes 0 [emitted]
output.js 1.44 kB 1 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
chunk {0} 0.output.js 22 bytes {1} [rendered]
2016-09-07 18:28:56 +08:00
> [4] ./example.js 3:0-6:2
[2] ./~/c.js 11 bytes {0} [built]
require.ensure item c [4] ./example.js 3:0-6:2
[3] ./~/d.js 11 bytes {0} [built]
cjs require d [4] ./example.js 5:12-24
chunk {1} output.js (main) 161 bytes [entry] [rendered]
2016-09-07 18:28:56 +08:00
> main [4] ./example.js
[0] ./~/b.js 11 bytes {1} [built]
cjs require b [4] ./example.js 2:8-20
cjs require b [4] ./example.js 4:4-16
[1] ./~/a.js 11 bytes {1} [built]
cjs require a [4] ./example.js 1:8-20
[4] ./example.js 139 bytes {1} [built]
2012-03-10 20:11:23 +08:00
```