webpack/examples/code-splitting/README.md

363 lines
12 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`
2018-09-25 23:08:35 +08:00
* `1.output.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");
});
```
# dist/output.js
2012-03-10 20:11:23 +08:00
2017-03-31 02:42:42 +08:00
<details><summary><code>/******/ (function(modules) { /* webpackBootstrap */ })</code></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
2017-11-23 16:47:19 +08:00
/******/ function webpackJsonpCallback(data) {
/******/ var chunkIds = data[0];
2018-04-04 21:17:13 +08:00
/******/ var moreModules = data[1];
/******/
2018-09-25 23:08:35 +08:00
/******/
2014-07-24 17:29:49 +08:00
/******/ // add "moreModules" to the modules object,
/******/ // then flag all "chunkIds" as loaded and fire callback
/******/ var moduleId, chunkId, i = 0, resolves = [];
2014-07-24 17:29:49 +08:00
/******/ for(;i < chunkIds.length; i++) {
/******/ chunkId = chunkIds[i];
2017-05-23 04:45:18 +08:00
/******/ if(installedChunks[chunkId]) {
2016-02-04 07:27:47 +08:00
/******/ resolves.push(installedChunks[chunkId][0]);
2017-05-23 04:45:18 +08:00
/******/ }
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
/******/ }
2017-11-23 16:47:19 +08:00
/******/ if(parentJsonpFunction) parentJsonpFunction(data);
2018-09-25 23:08:35 +08:00
/******/
2017-05-23 04:45:18 +08:00
/******/ while(resolves.length) {
2016-02-04 07:27:47 +08:00
/******/ resolves.shift()();
2017-05-23 04:45:18 +08:00
/******/ }
2017-03-31 02:25:01 +08:00
/******/
2014-07-24 17:29:49 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
/******/
2013-03-28 17:31:52 +08:00
/******/ // The module cache
/******/ var installedModules = {};
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ // object to store loaded and loading chunks
2018-05-07 18:36:38 +08:00
/******/ // undefined = chunk not loaded, null = chunk preloaded/prefetched
/******/ // Promise = chunk loading, 0 = chunk loaded
2013-12-16 06:30:50 +08:00
/******/ var installedChunks = {
2018-09-25 23:08:35 +08:00
/******/ 0: 0
2013-12-16 06:30:50 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
/******/
2017-11-23 16:47:19 +08:00
/******/
2018-05-07 18:36:38 +08:00
/******/ // script path function
/******/ function jsonpScriptSrc(chunkId) {
/******/ return __webpack_require__.p + "" + chunkId + ".output.js"
/******/ }
/******/
2013-03-28 17:31:52 +08:00
/******/ // The require function
2014-03-25 17:44:10 +08:00
/******/ function __webpack_require__(moduleId) {
2017-03-31 02:25:01 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // Check if module is in cache
2017-05-23 04:45:18 +08:00
/******/ if(installedModules[moduleId]) {
2014-03-25 17:44:10 +08:00
/******/ return installedModules[moduleId].exports;
2017-05-23 04:45:18 +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
/******/ };
2017-03-31 02:25:01 +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__);
2017-03-31 02:25:01 +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;
2017-03-31 02:25:01 +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
/******/ }
2017-03-31 02:25:01 +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) {
2017-11-23 16:47:19 +08:00
/******/ var promises = [];
2017-03-31 02:25:01 +08:00
/******/
/******/
2017-11-23 16:47:19 +08:00
/******/ // JSONP chunk loading for javascript
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ var installedChunkData = installedChunks[chunkId];
/******/ if(installedChunkData !== 0) { // 0 means "already installed".
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ // a Promise means "currently loading".
/******/ if(installedChunkData) {
/******/ promises.push(installedChunkData[2]);
/******/ } else {
/******/ // setup Promise in chunk cache
/******/ var promise = new Promise(function(resolve, reject) {
/******/ installedChunkData = installedChunks[chunkId] = [resolve, reject];
/******/ });
/******/ promises.push(installedChunkData[2] = promise);
/******/
/******/ // start chunk loading
/******/ var head = document.getElementsByTagName('head')[0];
/******/ var script = document.createElement('script');
2018-09-25 23:08:35 +08:00
/******/ var onScriptComplete;
2018-01-05 04:14:02 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ script.charset = 'utf-8';
2018-04-04 21:17:13 +08:00
/******/ script.timeout = 120;
2017-11-23 16:47:19 +08:00
/******/ if (__webpack_require__.nc) {
/******/ script.setAttribute("nonce", __webpack_require__.nc);
2017-05-23 04:45:18 +08:00
/******/ }
2018-05-07 18:36:38 +08:00
/******/ script.src = jsonpScriptSrc(chunkId);
2018-09-25 23:08:35 +08:00
/******/
/******/ onScriptComplete = function (event) {
2017-11-23 16:47:19 +08:00
/******/ // avoid mem leaks in IE.
/******/ script.onerror = script.onload = null;
/******/ clearTimeout(timeout);
/******/ var chunk = installedChunks[chunkId];
/******/ if(chunk !== 0) {
/******/ if(chunk) {
/******/ var errorType = event && (event.type === 'load' ? 'missing' : event.type);
/******/ var realSrc = event && event.target && event.target.src;
/******/ var error = new Error('Loading chunk ' + chunkId + ' failed.\n(' + errorType + ': ' + realSrc + ')');
/******/ error.type = errorType;
/******/ error.request = realSrc;
/******/ chunk[1](error);
/******/ }
/******/ installedChunks[chunkId] = undefined;
/******/ }
/******/ };
2018-09-25 23:08:35 +08:00
/******/ var timeout = setTimeout(function(){
/******/ onScriptComplete({ type: 'timeout', target: script });
/******/ }, 120000);
/******/ script.onerror = script.onload = onScriptComplete;
2017-11-23 16:47:19 +08:00
/******/ head.appendChild(script);
2016-02-04 07:27:47 +08:00
/******/ }
2017-11-23 16:47:19 +08:00
/******/ }
/******/ return Promise.all(promises);
2013-03-28 17:31:52 +08:00
/******/ };
2017-03-31 02:25:01 +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;
2017-03-31 02:25:01 +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;
2017-03-31 02:25:01 +08:00
/******/
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) {
2016-12-14 19:03:24 +08:00
/******/ if(!__webpack_require__.o(exports, name)) {
2018-09-25 23:08:35 +08:00
/******/ Object.defineProperty(exports, name, { enumerable: true, get: getter });
2016-12-14 19:03:24 +08:00
/******/ }
2016-09-07 18:28:56 +08:00
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2017-11-24 15:40:39 +08:00
/******/ // define __esModule on exports
/******/ __webpack_require__.r = function(exports) {
2018-09-25 23:08:35 +08:00
/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
/******/ }
2017-11-24 15:40:39 +08:00
/******/ Object.defineProperty(exports, '__esModule', { value: true });
/******/ };
/******/
2018-09-25 23:08:35 +08:00
/******/ // create a fake namespace object
/******/ // mode & 1: value is a module id, require it
/******/ // mode & 2: merge all properties of value into the ns
/******/ // mode & 4: return value when already ns object
/******/ // mode & 8|1: behave like require
/******/ __webpack_require__.t = function(value, mode) {
/******/ if(mode & 1) value = __webpack_require__(value);
/******/ if(mode & 8) return value;
/******/ if((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;
/******/ var ns = Object.create(null);
/******/ __webpack_require__.r(ns);
/******/ Object.defineProperty(ns, 'default', { enumerable: true, value: value });
/******/ if(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));
/******/ return ns;
/******/ };
/******/
2016-09-07 18:28:56 +08:00
/******/ // 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;
/******/ };
2017-03-31 02:25:01 +08:00
/******/
2016-09-07 18:28:56 +08:00
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
2017-03-31 02:25:01 +08:00
/******/
2016-02-04 20:02:53 +08:00
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "dist/";
2017-03-31 02:25:01 +08:00
/******/
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; };
2017-03-31 02:25:01 +08:00
/******/
2017-11-23 16:47:19 +08:00
/******/ var jsonpArray = window["webpackJsonp"] = window["webpackJsonp"] || [];
/******/ var oldJsonpFunction = jsonpArray.push.bind(jsonpArray);
2017-11-23 16:47:19 +08:00
/******/ jsonpArray.push = webpackJsonpCallback;
/******/ jsonpArray = jsonpArray.slice();
/******/ for(var i = 0; i < jsonpArray.length; i++) webpackJsonpCallback(jsonpArray[i]);
/******/ var parentJsonpFunction = oldJsonpFunction;
/******/
2017-11-23 16:47:19 +08:00
/******/
2013-03-28 17:31:52 +08:00
/******/ // Load entry module and return exports
2018-09-26 05:13:58 +08:00
/******/ return __webpack_require__(__webpack_require__.s = 0);
2013-03-28 17:31:52 +08:00
/******/ })
2013-03-27 01:22:30 +08:00
/************************************************************************/
2016-09-07 18:28:56 +08:00
```
2017-03-31 02:42:42 +08:00
2016-09-07 18:28:56 +08:00
</details>
2017-03-31 02:42:42 +08:00
2016-09-07 18:28:56 +08:00
``` javascript
2013-12-16 06:30:50 +08:00
/******/ ([
/* 0 */
2016-02-04 07:27:47 +08:00
/*!********************!*\
!*** ./example.js ***!
\********************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports, __webpack_require__) {
2013-01-31 01:49:25 +08:00
2018-09-26 05:13:58 +08:00
var a = __webpack_require__(/*! a */ 1);
var b = __webpack_require__(/*! b */ 2);
2018-09-25 23:08:35 +08:00
__webpack_require__.e(/*! require.ensure */ 1).then((function(require) {
2018-09-26 05:13:58 +08:00
__webpack_require__(/*! b */ 2).xyz();
2018-09-25 23:08:35 +08:00
var d = __webpack_require__(/*! d */ 4);
2016-12-14 19:03:24 +08:00
}).bind(null, __webpack_require__)).catch(__webpack_require__.oe);
2013-01-31 01:49:25 +08:00
2017-03-31 02:25:01 +08:00
/***/ }),
2013-12-16 06:30:50 +08:00
/* 1 */
2017-12-21 18:19:53 +08:00
/*!***************************!*\
!*** ./node_modules/a.js ***!
\***************************/
/*! no static exports found */
/***/ (function(module, exports) {
// module a
/***/ }),
/* 2 */
2018-09-26 05:13:58 +08:00
/*!***************************!*\
!*** ./node_modules/b.js ***!
\***************************/
2017-06-05 22:12:12 +08:00
/*! no static exports found */
2018-09-26 05:13:58 +08:00
/***/ (function(module, exports) {
2013-01-31 01:49:25 +08:00
2018-09-26 05:13:58 +08:00
// module b
2013-01-31 01:49:25 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2015-06-13 23:41:14 +08:00
/******/ ]);
2012-03-10 20:11:23 +08:00
```
2018-09-25 23:08:35 +08:00
# dist/1.output.js
2012-03-10 20:11:23 +08:00
``` javascript
2018-09-25 23:08:35 +08:00
(window["webpackJsonp"] = window["webpackJsonp"] || []).push([[1],[
2013-12-16 06:30:50 +08:00
/* 0 */,
/* 1 */,
2017-03-31 02:25:01 +08:00
/* 2 */,
/* 3 */
2017-06-05 22:12:12 +08:00
/*!***************************!*\
2018-09-25 23:08:35 +08:00
!*** ./node_modules/c.js ***!
2017-06-05 22:12:12 +08:00
\***************************/
/*! no static exports found */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2012-11-08 17:53:54 +08:00
2018-09-25 23:08:35 +08:00
// module c
2012-11-08 17:53:54 +08:00
2017-03-31 02:25:01 +08:00
/***/ }),
/* 4 */
2017-06-05 22:12:12 +08:00
/*!***************************!*\
2018-09-25 23:08:35 +08:00
!*** ./node_modules/d.js ***!
2017-06-05 22:12:12 +08:00
\***************************/
/*! no static exports found */
2017-03-31 02:25:01 +08:00
/***/ (function(module, exports) {
2012-11-08 17:53:54 +08:00
2018-09-25 23:08:35 +08:00
// module d
2012-11-08 17:53:54 +08:00
2017-03-31 02:25:01 +08:00
/***/ })
2017-11-23 16:47:19 +08:00
]]);
2012-03-10 20:11:23 +08:00
```
Minimized
``` javascript
2018-09-25 23:08:35 +08:00
(window.webpackJsonp=window.webpackJsonp||[]).push([[1],[,,,function(n,o){},function(n,o){}]]);
2012-03-10 20:11:23 +08:00
```
# Info
2017-12-14 17:58:03 +08:00
## Unoptimized
2012-03-10 20:11:23 +08:00
2012-03-20 03:47:58 +08:00
```
2017-12-14 17:58:03 +08:00
Hash: 0a1b2c3d4e5f6a7b8c9d
2018-09-26 05:13:58 +08:00
Version: webpack 5.0.0-next
Asset Size Chunks Chunk Names
2018-09-25 23:08:35 +08:00
1.output.js 490 bytes 1 [emitted]
2018-09-26 05:13:58 +08:00
output.js 8.75 KiB 0 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2018-09-26 05:13:58 +08:00
chunk {0} output.js (main) 166 bytes >{1}< [entry] [rendered]
> .\example.js main
2018-09-26 05:13:58 +08:00
[0] ./example.js 144 bytes {0} [built]
[used exports unknown]
entry .\example.js main
2017-08-08 20:00:06 +08:00
+ 2 hidden modules
2018-09-25 23:08:35 +08:00
chunk {1} 1.output.js 22 bytes <{0}> [rendered]
2018-09-26 05:13:58 +08:00
> [0] ./example.js 3:0-6:2
2018-09-25 23:08:35 +08:00
2 modules
2012-03-10 20:11:23 +08:00
```
2017-12-14 17:58:03 +08:00
## Production mode
2012-03-10 20:11:23 +08:00
2012-03-20 03:47:58 +08:00
```
2017-12-14 17:58:03 +08:00
Hash: 0a1b2c3d4e5f6a7b8c9d
2018-09-26 05:13:58 +08:00
Version: webpack 5.0.0-next
Asset Size Chunks Chunk Names
2018-09-25 23:08:35 +08:00
1.output.js 95 bytes 1 [emitted]
2018-09-26 05:13:58 +08:00
output.js 2.08 KiB 0 [emitted] main
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2018-09-26 05:13:58 +08:00
chunk {0} output.js (main) 166 bytes >{1}< [entry] [rendered]
> .\example.js main
2018-09-26 05:13:58 +08:00
[1] ./example.js 144 bytes {0} [built]
entry .\example.js main
2017-08-08 20:00:06 +08:00
+ 2 hidden modules
2018-09-25 23:08:35 +08:00
chunk {1} 1.output.js 22 bytes <{0}> [rendered]
> [1] ./example.js 3:0-6:2
2 modules
2012-03-10 20:11:23 +08:00
```