webpack/examples/code-splitting/README.md

379 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
2019-04-09 02:29:40 +08:00
- `a` and `b` are required normally via CommonJS
- `c` is depended through the `require.ensure` array.
- 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
2014-07-24 17:29:49 +08:00
You can see that webpack outputs two files/chunks:
2019-04-09 02:29:40 +08:00
- `output.js` is the entry chunk and contains
- the module system
- chunk loading logic
- the entry point `example.js`
- module `a`
- module `b`
- `1.output.js` is an additional chunk (on demand loaded) and contains
- module `c`
- module `d`
2014-07-24 17:29:49 +08:00
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
2019-04-09 02:29:40 +08:00
```javascript
2012-03-10 20:11:23 +08:00
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
2019-04-09 02:29:40 +08:00
```javascript
2019-10-11 05:11:05 +08:00
/******/ (() => { // webpackBootstrap
/******/ var __webpack_modules__ = ([
/* 0 */,
2013-12-16 06:30:50 +08:00
/* 1 */
2017-12-21 18:19:53 +08:00
/*!***************************!*\
!*** ./node_modules/a.js ***!
\***************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: */
2019-10-09 05:45:47 +08:00
/***/ (() => {
2017-12-21 18:19:53 +08:00
// module a
/***/ }),
/* 2 */
2018-09-26 05:13:58 +08:00
/*!***************************!*\
!*** ./node_modules/b.js ***!
\***************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: */
2019-10-09 05:45:47 +08:00
/***/ (() => {
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
/***/ })
2019-10-11 05:11:05 +08:00
/******/ ]);
```
<details><summary><code>/* webpack runtime code */</code></summary>
``` js
2019-10-11 05:11:05 +08:00
/************************************************************************/
/******/ // The module cache
/******/ var __webpack_module_cache__ = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/ // Check if module is in cache
/******/ if(__webpack_module_cache__[moduleId]) {
/******/ return __webpack_module_cache__[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = __webpack_modules__;
/******/
/************************************************************************/
2018-12-19 21:05:17 +08:00
/******/ /* webpack/runtime/ensure chunk */
/******/ !function() {
/******/ __webpack_require__.f = {};
/******/ // This file contains only the entry chunk.
/******/ // The chunk loading function for additional chunks
2019-10-09 05:45:47 +08:00
/******/ __webpack_require__.e = (chunkId) => {
/******/ return Promise.all(Object.keys(__webpack_require__.f).reduce((promises, key) => {
2019-08-05 19:32:25 +08:00
/******/ __webpack_require__.f[key](chunkId, promises);
/******/ return promises;
/******/ }, []));
2018-12-19 21:05:17 +08:00
/******/ };
/******/ }();
/******/
/******/ /* webpack/runtime/get javascript chunk filename */
/******/ !function() {
2019-05-10 03:34:28 +08:00
/******/ // This function allow to reference async chunks
2019-10-09 05:45:47 +08:00
/******/ __webpack_require__.u = (chunkId) => {
2019-02-05 01:52:39 +08:00
/******/ // return url for filenames based on template
2018-12-19 21:05:17 +08:00
/******/ return "" + chunkId + ".output.js";
/******/ };
/******/ }();
/******/
2019-11-15 07:06:30 +08:00
/******/ /* webpack/runtime/publicPath */
/******/ !function() {
/******/ __webpack_require__.p = "dist/";
/******/ }();
/******/
2018-12-19 21:05:17 +08:00
/******/ /* webpack/runtime/jsonp chunk loading */
/******/ !function() {
/******/
/******/
/******/ // object to store loaded and loading chunks
/******/ // undefined = chunk not loaded, null = chunk preloaded/prefetched
/******/ // Promise = chunk loading, 0 = chunk loaded
/******/ var installedChunks = {
2019-05-10 03:34:28 +08:00
/******/ 179: 0
2018-12-19 21:05:17 +08:00
/******/ };
/******/
/******/
/******/
2019-08-05 19:32:25 +08:00
/******/
2019-10-09 05:45:47 +08:00
/******/ __webpack_require__.f.j = (chunkId, promises) => {
/******/ // JSONP chunk loading for javascript
/******/ var installedChunkData = Object.prototype.hasOwnProperty.call(installedChunks, chunkId) ? installedChunks[chunkId] : undefined;
/******/ if(installedChunkData !== 0) { // 0 means "already installed".
2018-12-19 21:05:17 +08:00
/******/
2019-10-09 05:45:47 +08:00
/******/ // a Promise means "currently loading".
/******/ if(installedChunkData) {
/******/ promises.push(installedChunkData[2]);
/******/ } else {
/******/ if(true) { // all chunks have JS
/******/ // setup Promise in chunk cache
/******/ var promise = new Promise((resolve, reject) => {
/******/ installedChunkData = installedChunks[chunkId] = [resolve, reject];
/******/ });
/******/ promises.push(installedChunkData[2] = promise);
2018-12-19 21:05:17 +08:00
/******/
2019-10-09 05:45:47 +08:00
/******/ // start chunk loading
/******/ var url = __webpack_require__.p + __webpack_require__.u(chunkId);
/******/ var loadingEnded = () => {
2019-11-15 07:06:30 +08:00
/******/ if(Object.prototype.hasOwnProperty.call(installedChunks, chunkId)) {
/******/ installedChunkData = installedChunks[chunkId];
/******/ if(installedChunkData !== 0) installedChunks[chunkId] = undefined;
/******/ if(installedChunkData) return installedChunkData[1];
/******/ }
2019-10-09 05:45:47 +08:00
/******/ };
/******/ var script = document.createElement('script');
/******/ var onScriptComplete;
2019-08-05 19:32:25 +08:00
/******/
2019-10-09 05:45:47 +08:00
/******/ script.charset = 'utf-8';
/******/ script.timeout = 120;
/******/ if (__webpack_require__.nc) {
/******/ script.setAttribute("nonce", __webpack_require__.nc);
2019-08-05 19:32:25 +08:00
/******/ }
2019-10-09 05:45:47 +08:00
/******/ script.src = url;
2018-12-19 21:05:17 +08:00
/******/
2019-10-09 05:45:47 +08:00
/******/ // create error before stack unwound to get useful stacktrace later
/******/ var error = new Error();
/******/ onScriptComplete = function (event) {
2019-11-15 07:06:30 +08:00
/******/ onScriptComplete = function() {};
2019-10-09 05:45:47 +08:00
/******/ // avoid mem leaks in IE.
/******/ script.onerror = script.onload = null;
/******/ clearTimeout(timeout);
/******/ var reportError = loadingEnded();
/******/ if(reportError) {
/******/ var errorType = event && (event.type === 'load' ? 'missing' : event.type);
/******/ var realSrc = event && event.target && event.target.src;
/******/ error.message = 'Loading chunk ' + chunkId + ' failed.\n(' + errorType + ': ' + realSrc + ')';
/******/ error.name = 'ChunkLoadError';
/******/ error.type = errorType;
/******/ error.request = realSrc;
/******/ reportError(error);
/******/ }
/******/ };
/******/ var timeout = setTimeout(function(){
/******/ onScriptComplete({ type: 'timeout', target: script });
/******/ }, 120000);
/******/ script.onerror = script.onload = onScriptComplete;
/******/ document.head.appendChild(script);
/******/ } else installedChunks[chunkId] = 0;
/******/
/******/ // no HMR
/******/ }
2018-12-19 21:05:17 +08:00
/******/ }
/******/
2019-10-09 05:45:47 +08:00
/******/ // no chunk preloading needed
2018-12-19 21:05:17 +08:00
/******/ };
/******/
/******/ // no prefetching
/******/
/******/ // no HMR
/******/
/******/ // no HMR manifest
/******/
2019-08-05 19:32:25 +08:00
/******/ // no deferred startup or startup prefetching
2018-12-19 21:05:17 +08:00
/******/
/******/ // install a JSONP callback for chunk loading
/******/ function webpackJsonpCallback(data) {
/******/ var chunkIds = data[0];
/******/ var moreModules = data[1];
/******/
/******/ var runtime = data[3];
/******/
/******/ // add "moreModules" to the modules object,
/******/ // then flag all "chunkIds" as loaded and fire callback
/******/ var moduleId, chunkId, i = 0, resolves = [];
/******/ for(;i < chunkIds.length; i++) {
/******/ chunkId = chunkIds[i];
2019-08-05 19:32:25 +08:00
/******/ if(Object.prototype.hasOwnProperty.call(installedChunks, chunkId) && installedChunks[chunkId]) {
2018-12-19 21:05:17 +08:00
/******/ resolves.push(installedChunks[chunkId][0]);
/******/ }
/******/ installedChunks[chunkId] = 0;
/******/ }
/******/ for(moduleId in moreModules) {
/******/ if(Object.prototype.hasOwnProperty.call(moreModules, moduleId)) {
/******/ __webpack_require__.m[moduleId] = moreModules[moduleId];
/******/ }
/******/ }
/******/ if(runtime) runtime(__webpack_require__);
/******/ if(parentJsonpFunction) parentJsonpFunction(data);
/******/
/******/ while(resolves.length) {
/******/ resolves.shift()();
/******/ }
/******/
/******/ };
/******/
/******/ var jsonpArray = window["webpackJsonp"] = window["webpackJsonp"] || [];
/******/ var oldJsonpFunction = jsonpArray.push.bind(jsonpArray);
/******/ jsonpArray.push = webpackJsonpCallback;
/******/
/******/ var parentJsonpFunction = oldJsonpFunction;
/******/ }();
/******/
2019-10-11 05:11:05 +08:00
/************************************************************************/
```
</details>
``` js
2019-10-11 05:11:05 +08:00
!function() {
/*!********************!*\
!*** ./example.js ***!
\********************/
/*! exports [maybe provided (runtime-defined)] [no usage info] */
/*! runtime requirements: __webpack_require__, __webpack_require__.e, __webpack_require__.* */
var a = __webpack_require__(/*! a */ 1);
var b = __webpack_require__(/*! b */ 2);
__webpack_require__.e(/*! require.ensure */ 796).then((function(require) {
__webpack_require__(/*! b */ 2).xyz();
var d = __webpack_require__(/*! d */ 4);
}).bind(null, __webpack_require__)).catch(__webpack_require__.oe);
}();
/******/ })()
;
2012-03-10 20:11:23 +08:00
```
2019-05-10 03:34:28 +08:00
# dist/796.output.js
2012-03-10 20:11:23 +08:00
2019-04-09 02:29:40 +08:00
```javascript
2019-05-10 03:34:28 +08:00
(window["webpackJsonp"] = window["webpackJsonp"] || []).push([[796],[
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
\***************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: */
2019-10-09 05:45:47 +08:00
/***/ (() => {
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
\***************************/
2019-08-05 19:32:25 +08:00
/*! exports [maybe provided (runtime-defined)] [no usage info] */
2018-12-19 21:05:17 +08:00
/*! runtime requirements: */
2019-10-09 05:45:47 +08:00
/***/ (() => {
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
2019-04-09 02:29:40 +08:00
```javascript
2019-10-09 05:45:47 +08:00
(window.webpackJsonp=window.webpackJsonp||[]).push([[796],{286:()=>{},882:()=>{}}]);
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
2019-11-15 07:06:30 +08:00
Version: webpack 5.0.0-beta.6
2019-10-11 05:11:05 +08:00
Asset Size
796.output.js 582 bytes [emitted]
2019-11-15 07:06:30 +08:00
output.js 8.45 KiB [emitted] [name: main]
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2019-11-15 07:06:30 +08:00
chunk output.js (main) 161 bytes (javascript) 4.23 KiB (runtime) [entry] [rendered]
2019-01-25 20:15:22 +08:00
> ./example.js main
2019-10-11 05:11:05 +08:00
./example.js 139 bytes [built]
2018-09-26 05:13:58 +08:00
[used exports unknown]
2019-02-05 01:52:39 +08:00
entry ./example.js main
2019-10-11 05:11:05 +08:00
./node_modules/a.js 11 bytes [built]
2018-12-19 21:05:17 +08:00
[used exports unknown]
2019-10-11 05:11:05 +08:00
cjs require a ./example.js 1:8-20
./node_modules/b.js 11 bytes [built]
2018-12-19 21:05:17 +08:00
[used exports unknown]
2019-10-11 05:11:05 +08:00
cjs require b ./example.js 2:8-20
cjs require b ./example.js 4:4-16
2018-12-19 21:05:17 +08:00
+ 4 hidden chunk modules
2019-10-11 05:11:05 +08:00
chunk 796.output.js 22 bytes [rendered]
> ./example.js 3:0-6:2
./node_modules/c.js 11 bytes [built]
2019-05-10 03:34:28 +08:00
[used exports unknown]
2019-10-11 05:11:05 +08:00
require.ensure item c ./example.js 3:0-6:2
./node_modules/d.js 11 bytes [built]
2019-05-10 03:34:28 +08:00
[used exports unknown]
2019-10-11 05:11:05 +08:00
cjs require d ./example.js 5:12-24
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
2019-11-15 07:06:30 +08:00
Version: webpack 5.0.0-beta.6
2019-10-11 05:11:05 +08:00
Asset Size
796.output.js 84 bytes [emitted]
2019-11-15 07:06:30 +08:00
output.js 1.5 KiB [emitted] [name: main]
2016-09-07 18:28:56 +08:00
Entrypoint main = output.js
2019-11-15 07:06:30 +08:00
chunk output.js (main) 161 bytes (javascript) 4.23 KiB (runtime) [entry] [rendered]
2019-01-25 20:15:22 +08:00
> ./example.js main
2019-10-11 05:11:05 +08:00
./example.js 139 bytes [built]
[no exports used]
entry ./example.js main
./node_modules/a.js 11 bytes [built]
cjs require a ./example.js 1:8-20
./node_modules/b.js 11 bytes [built]
cjs require b ./example.js 2:8-20
cjs require b ./example.js 4:4-16
2018-12-19 21:05:17 +08:00
+ 4 hidden chunk modules
2019-10-11 05:11:05 +08:00
chunk 796.output.js 22 bytes [rendered]
> ./example.js 3:0-6:2
./node_modules/c.js 11 bytes [built]
require.ensure item c ./example.js 3:0-6:2
./node_modules/d.js 11 bytes [built]
cjs require d ./example.js 5:12-24
2012-03-10 20:11:23 +08:00
```