webpack/examples/code-splitting/README.md

378 lines
13 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 made available(,but doesn't get execute) through the `require.ensure` array.
2019-04-09 02:29:40 +08:00
- 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
- webpack's optimizer can optimize `b` away
2019-04-09 02:29:40 +08:00
- 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
2019-04-09 02:29:40 +08:00
- 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 ***!
\***************************/
2020-05-21 05:26:51 +08:00
/*! unknown exports (runtime-defined) */
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 ***!
\***************************/
2020-05-21 05:26:51 +08:00
/*! unknown exports (runtime-defined) */
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
2021-08-20 14:12:50 +08:00
/******/ var cachedModule = __webpack_module_cache__[moduleId];
/******/ if (cachedModule !== undefined) {
/******/ return cachedModule.exports;
2019-10-11 05:11:05 +08:00
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
2020-05-21 05:26:51 +08:00
/******/ // no module.id needed
/******/ // no module.loaded needed
2019-10-11 05:11:05 +08:00
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // 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 */
2020-05-21 05:26:51 +08:00
/******/ (() => {
2018-12-19 21:05:17 +08:00
/******/ __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
/******/ };
2020-05-21 05:26:51 +08:00
/******/ })();
2018-12-19 21:05:17 +08:00
/******/
/******/ /* webpack/runtime/get javascript chunk filename */
2020-05-21 05:26:51 +08:00
/******/ (() => {
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";
/******/ };
2020-05-21 05:26:51 +08:00
/******/ })();
/******/
/******/ /* webpack/runtime/hasOwnProperty shorthand */
/******/ (() => {
2021-08-20 14:12:50 +08:00
/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
2020-05-21 05:26:51 +08:00
/******/ })();
2018-12-19 21:05:17 +08:00
/******/
2020-09-21 04:39:12 +08:00
/******/ /* webpack/runtime/load script */
/******/ (() => {
/******/ var inProgress = {};
/******/ // data-webpack is not used as build has no uniqueName
/******/ // loadScript function to load a script via script tag
2021-08-20 14:12:50 +08:00
/******/ __webpack_require__.l = (url, done, key, chunkId) => {
2020-09-21 04:39:12 +08:00
/******/ if(inProgress[url]) { inProgress[url].push(done); return; }
/******/ var script, needAttach;
/******/ if(key !== undefined) {
/******/ var scripts = document.getElementsByTagName("script");
/******/ for(var i = 0; i < scripts.length; i++) {
/******/ var s = scripts[i];
/******/ if(s.getAttribute("src") == url) { script = s; break; }
/******/ }
/******/ }
/******/ if(!script) {
/******/ needAttach = true;
/******/ script = document.createElement('script');
/******/
/******/ script.charset = 'utf-8';
/******/ script.timeout = 120;
/******/ if (__webpack_require__.nc) {
/******/ script.setAttribute("nonce", __webpack_require__.nc);
/******/ }
/******/
/******/
2020-09-21 04:39:12 +08:00
/******/ script.src = url;
/******/ }
/******/ inProgress[url] = [done];
/******/ var onScriptComplete = (prev, event) => {
/******/ // avoid mem leaks in IE.
/******/ script.onerror = script.onload = null;
/******/ clearTimeout(timeout);
/******/ var doneFns = inProgress[url];
/******/ delete inProgress[url];
/******/ script.parentNode && script.parentNode.removeChild(script);
2021-08-20 14:12:50 +08:00
/******/ doneFns && doneFns.forEach((fn) => (fn(event)));
2020-09-21 04:39:12 +08:00
/******/ if(prev) return prev(event);
/******/ }
/******/ var timeout = setTimeout(onScriptComplete.bind(null, undefined, { type: 'timeout', target: script }), 120000);
/******/ script.onerror = onScriptComplete.bind(null, script.onerror);
/******/ script.onload = onScriptComplete.bind(null, script.onload);
/******/ needAttach && document.head.appendChild(script);
/******/ };
/******/ })();
/******/
2019-11-15 07:06:30 +08:00
/******/ /* webpack/runtime/publicPath */
2020-05-21 05:26:51 +08:00
/******/ (() => {
2019-11-15 07:06:30 +08:00
/******/ __webpack_require__.p = "dist/";
2020-05-21 05:26:51 +08:00
/******/ })();
2019-11-15 07:06:30 +08:00
/******/
2018-12-19 21:05:17 +08:00
/******/ /* webpack/runtime/jsonp chunk loading */
2020-05-21 05:26:51 +08:00
/******/ (() => {
2020-09-21 04:39:12 +08:00
/******/ // no baseURI
/******/
2018-12-19 21:05:17 +08:00
/******/ // object to store loaded and loading chunks
/******/ // undefined = chunk not loaded, null = chunk preloaded/prefetched
2021-08-20 14:12:50 +08:00
/******/ // [resolve, reject, Promise] = chunk loading, 0 = chunk loaded
2018-12-19 21:05:17 +08:00
/******/ var installedChunks = {
/******/ "main": 0
2018-12-19 21:05:17 +08:00
/******/ };
/******/
2019-10-09 05:45:47 +08:00
/******/ __webpack_require__.f.j = (chunkId, promises) => {
/******/ // JSONP chunk loading for javascript
2020-05-21 05:26:51 +08:00
/******/ var installedChunkData = __webpack_require__.o(installedChunks, chunkId) ? installedChunks[chunkId] : undefined;
2019-10-09 05:45:47 +08:00
/******/ 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
2021-08-20 14:12:50 +08:00
/******/ var promise = new Promise((resolve, reject) => (installedChunkData = installedChunks[chunkId] = [resolve, reject]));
2019-10-09 05:45:47 +08:00
/******/ 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);
2020-09-21 04:39:12 +08:00
/******/ // create error before stack unwound to get useful stacktrace later
/******/ var error = new Error();
/******/ var loadingEnded = (event) => {
2020-05-21 05:26:51 +08:00
/******/ if(__webpack_require__.o(installedChunks, chunkId)) {
2019-11-15 07:06:30 +08:00
/******/ installedChunkData = installedChunks[chunkId];
/******/ if(installedChunkData !== 0) installedChunks[chunkId] = undefined;
2020-09-21 04:39:12 +08:00
/******/ if(installedChunkData) {
/******/ 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;
/******/ installedChunkData[1](error);
/******/ }
2019-11-15 07:06:30 +08:00
/******/ }
2019-10-09 05:45:47 +08:00
/******/ };
2021-08-20 14:12:50 +08:00
/******/ __webpack_require__.l(url, loadingEnded, "chunk-" + chunkId, chunkId);
/******/ }
2019-10-09 05:45:47 +08:00
/******/ }
2018-12-19 21:05:17 +08:00
/******/ }
/******/ };
/******/
/******/ // no prefetching
/******/
2020-05-21 05:26:51 +08:00
/******/ // no preloaded
/******/
2018-12-19 21:05:17 +08:00
/******/ // no HMR
/******/
/******/ // no HMR manifest
/******/
2021-08-20 14:12:50 +08:00
/******/ // no on chunks loaded
2018-12-19 21:05:17 +08:00
/******/
/******/ // install a JSONP callback for chunk loading
/******/ var webpackJsonpCallback = (parentChunkLoadingFunction, data) => {
2020-09-21 04:39:12 +08:00
/******/ var [chunkIds, moreModules, runtime] = data;
2018-12-19 21:05:17 +08:00
/******/ // add "moreModules" to the modules object,
/******/ // then flag all "chunkIds" as loaded and fire callback
2021-08-20 14:12:50 +08:00
/******/ var moduleId, chunkId, i = 0;
/******/ if(chunkIds.some((id) => (installedChunks[id] !== 0))) {
/******/ for(moduleId in moreModules) {
/******/ if(__webpack_require__.o(moreModules, moduleId)) {
/******/ __webpack_require__.m[moduleId] = moreModules[moduleId];
/******/ }
/******/ }
/******/ if(runtime) var result = runtime(__webpack_require__);
/******/ }
/******/ if(parentChunkLoadingFunction) parentChunkLoadingFunction(data);
2018-12-19 21:05:17 +08:00
/******/ for(;i < chunkIds.length; i++) {
/******/ chunkId = chunkIds[i];
2020-05-21 05:26:51 +08:00
/******/ if(__webpack_require__.o(installedChunks, chunkId) && installedChunks[chunkId]) {
2021-08-20 14:12:50 +08:00
/******/ installedChunks[chunkId][0]();
2018-12-19 21:05:17 +08:00
/******/ }
2023-04-08 06:23:22 +08:00
/******/ installedChunks[chunkId] = 0;
2018-12-19 21:05:17 +08:00
/******/ }
/******/
2020-09-21 04:39:12 +08:00
/******/ }
2018-12-19 21:05:17 +08:00
/******/
2020-09-21 04:39:12 +08:00
/******/ var chunkLoadingGlobal = self["webpackChunk"] = self["webpackChunk"] || [];
/******/ chunkLoadingGlobal.forEach(webpackJsonpCallback.bind(null, 0));
/******/ chunkLoadingGlobal.push = webpackJsonpCallback.bind(null, chunkLoadingGlobal.push.bind(chunkLoadingGlobal));
2020-05-21 05:26:51 +08:00
/******/ })();
2018-12-19 21:05:17 +08:00
/******/
2019-10-11 05:11:05 +08:00
/************************************************************************/
```
</details>
``` js
// This entry needs to be wrapped in an IIFE because it needs to be isolated against other modules in the chunk.
2020-05-21 05:26:51 +08:00
(() => {
2019-10-11 05:11:05 +08:00
/*!********************!*\
!*** ./example.js ***!
\********************/
2020-05-21 05:26:51 +08:00
/*! unknown exports (runtime-defined) */
2019-10-11 05:11:05 +08:00
/*! 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 */ "node_modules_c_js-node_modules_d_js").then((function(require) {
2023-04-08 06:23:22 +08:00
(__webpack_require__(/*! b */ 2).xyz)();
2019-10-11 05:11:05 +08:00
var d = __webpack_require__(/*! d */ 4);
2023-04-08 06:23:22 +08:00
}).bind(null, __webpack_require__))['catch'](__webpack_require__.oe);
2020-05-21 05:26:51 +08:00
})();
2019-10-11 05:11:05 +08:00
/******/ })()
;
2012-03-10 20:11:23 +08:00
```
# dist/node_modules_c_js-node_modules_d_js.output.js
2012-03-10 20:11:23 +08:00
2019-04-09 02:29:40 +08:00
```javascript
(self["webpackChunk"] = self["webpackChunk"] || []).push([["node_modules_c_js-node_modules_d_js"],[
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
\***************************/
2020-05-21 05:26:51 +08:00
/*! unknown exports (runtime-defined) */
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
\***************************/
2020-05-21 05:26:51 +08:00
/*! unknown exports (runtime-defined) */
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
(self.webpackChunk=self.webpackChunk||[]).push([["node_modules_c_js-node_modules_d_js"],{576:()=>{},605:()=>{}}]);
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
```
asset output.js 9.46 KiB [emitted] (name: main)
asset node_modules_c_js-node_modules_d_js.output.js 562 bytes [emitted]
chunk (runtime: main) output.js (main) 161 bytes (javascript) 4.94 KiB (runtime) [entry] [rendered]
2020-09-21 04:39:12 +08:00
> ./example.js main
runtime modules 4.94 KiB 6 modules
2020-09-21 04:39:12 +08:00
dependent modules 22 bytes [dependent] 2 modules
./example.js 139 bytes [built] [code generated]
[used exports unknown]
entry ./example.js main
chunk (runtime: main) node_modules_c_js-node_modules_d_js.output.js 22 bytes [rendered]
2020-09-21 04:39:12 +08:00
> ./example.js 3:0-6:2
./node_modules/c.js 11 bytes [built] [code generated]
[used exports unknown]
require.ensure item c ./example.js 3:0-6:2
./node_modules/d.js 11 bytes [built] [code generated]
[used exports unknown]
cjs require d ./example.js 5:12-24
webpack X.X.X compiled successfully
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
```
asset output.js 1.77 KiB [emitted] [minimized] (name: main)
asset node_modules_c_js-node_modules_d_js.output.js 114 bytes [emitted] [minimized]
chunk (runtime: main) output.js (main) 161 bytes (javascript) 4.94 KiB (runtime) [entry] [rendered]
2020-09-21 04:39:12 +08:00
> ./example.js main
runtime modules 4.94 KiB 6 modules
2020-09-21 04:39:12 +08:00
dependent modules 22 bytes [dependent] 2 modules
./example.js 139 bytes [built] [code generated]
[no exports used]
entry ./example.js main
chunk (runtime: main) node_modules_c_js-node_modules_d_js.output.js 22 bytes [rendered]
2020-09-21 04:39:12 +08:00
> ./example.js 3:0-6:2
./node_modules/c.js 11 bytes [built] [code generated]
[used exports unknown]
require.ensure item c ./example.js 3:0-6:2
./node_modules/d.js 11 bytes [built] [code generated]
[used exports unknown]
cjs require d ./example.js 5:12-24
webpack X.X.X compiled successfully
2012-03-10 20:11:23 +08:00
```