Webpack生成文件分析

柠檬豆腐脑
3,653 阅读8分钟

为什么要理解Webpack输出文件

比如使用一个函数，我们需要关注它的输入和输出，就可以很好的使用它。如果想更好的理解这个函数，就需要看看它内部的实现。

同样，使用Webpack，我们也需要关注它的输入和输出。

初学Webpack，我们一般都先了解输入，（源码和配置可以理解成Webpack的输入），但是不太了解输出（生成的文件）。我们只是看到页面能正常展示，就可以了。

但是想更好的使用Webpack，做打包优化，了解输出文件的内容，是第一步。

生成一个最简单的Webpack输出文件

先搞一些输入文件

我们可以把webpack理解成一个本地操作文件的程序，读取一些文件，根据我们的配置，再生成一些文件。我们的源代码，就是webpack要读取的文件。我把源代码称为输入文件。

./app/Greeter.js

module.exports = function () {
  var greet = document.createElement('div');
  greet.textContent = "Hi there and greetings!";
  return greet;
};

./app/main.js

const greeter = require('./Greeter.js');

document.querySelector("#root").appendChild(greeter());

我们搞了两个输入文件，都放在app文件夹下，Greeter.js，main.js。main.js引用了Greeter.js

再搞一个配置文件

./webpack.config.js

module.exports = {
  entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
  output: {
    path: __dirname + "/public",//打包后的文件存放的地方
    filename: "bundle.js"//打包后输出文件的文件名
  },
  mode: 'development',
  devtool: false,
}

在package.json的scripts对象下，添加"start": "webpack"。在命令行工具中运行npm start。 就运行webpack的打包过程啦。将输出文件放在public文件夹下。

分析生成文件bundle.js

通过上述步骤，我们就生成了一个最简单的bundle.js文件。也就是Webpack的输出文件，本文的目的就是搞懂它。

/******/ (function(modules) { // webpackBootstrap
/******/ 	// The module cache
/******/ 	var installedModules = {};
/******/
/******/ 	// The require function
/******/ 	function __webpack_require__(moduleId) {
/******/
/******/ 		// Check if module is in cache
/******/ 		if(installedModules[moduleId]) {
/******/ 			return installedModules[moduleId].exports;
/******/ 		}
/******/ 		// Create a new module (and put it into the cache)
/******/ 		var module = installedModules[moduleId] = {
/******/ 			i: moduleId,
/******/ 			l: false,
/******/ 			exports: {}
/******/ 		};
/******/
/******/ 		// Execute the module function
/******/ 		modules[moduleId].call(module.exports, 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 = modules;
/******/
/******/ 	// expose the module cache
/******/ 	__webpack_require__.c = installedModules;
/******/
/******/ 	// define getter function for harmony exports
/******/ 	__webpack_require__.d = function(exports, name, getter) {
/******/ 		if(!__webpack_require__.o(exports, name)) {
/******/ 			Object.defineProperty(exports, name, { enumerable: true, get: getter });
/******/ 		}
/******/ 	};
/******/
/******/ 	// define __esModule on exports
/******/ 	__webpack_require__.r = function(exports) {
/******/ 		if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
/******/ 			Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
/******/ 		}
/******/ 		Object.defineProperty(exports, '__esModule', { value: true });
/******/ 	};
/******/
/******/ 	// 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;
/******/ 	};
/******/
/******/ 	// 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); };
/******/
/******/ 	// __webpack_public_path__
/******/ 	__webpack_require__.p = "";
/******/
/******/
/******/ 	// Load entry module and return exports
/******/ 	return __webpack_require__(__webpack_require__.s = "./app/main.js");
/******/ })
/************************************************************************/
/******/ ({

/***/ "./app/Greeter.js":
/*!************************!*\
  !*** ./app/Greeter.js ***!
  \************************/
/*! no static exports found */
/***/ (function(module, exports) {

// Greeter.js
module.exports = function () {
  var greet = document.createElement('div');
  greet.textContent = "Hi there and greetings!";
  return greet;
};

/***/ }),

/***/ "./app/main.js":
/*!*********************!*\
  !*** ./app/main.js ***!
  \*********************/
/*! no static exports found */
/***/ (function(module, exports, __webpack_require__) {

//main.js 
const greeter = __webpack_require__(/*! ./Greeter.js */ "./app/Greeter.js");
document.querySelector("#root").appendChild(greeter());

/***/ })

/******/ });

生成文件中的知识点

  1. 立即执行函数
  2. 文件内容分两部分：包含运行时代码和源代码
  3. 模块加载流程
  4. webpack是如何模拟源码中require，module.export、export、import这些模块引用的

立即执行函数

从整体上看bundle.js，就是一个立即执行的函数表达式（IIFE）。

(function (modules) {
    statements
})(modules对象集合);

这是一个被称为 自执行匿名函数 的设计模式，主要包含两部分。第一部分是包围在 圆括号运算符 () 里的一个匿名函数，这个匿名函数拥有独立的词法作用域。这不仅避免了外界访问此 IIFE 中的变量，而且又不会污染全局作用域。

第二部分再一次使用 () 创建了一个立即执行函数表达式，JavaScript 引擎到此将直接执行函数。

-- 来自MDN的IIFE的解释。

文件内容分两部分：包含运行时代码和源代码

bundle.js中的内容分为两部分，运行时代码和我们的源代码。自执行函数体都是代码在浏览器端运行时所需的代码。自执行函数的参数就是我们的源代码。

模块加载流程

bundle文件中的自执行函数，还包含了参数，简化一下是这样的：

(function (modules) {
    statements
})({
    "./app/main.js": function(){ /*main.js源码*/ }
    "./app/Greeter.js": function(){ /*Greeter.js源码*/ }
})

参数就是包裹着我们源代码模块的，已路径为key的对象，传递到匿名函数里，就是modules变量。

main.js的加载执行

第一个模块的加载，肯定是在匿名函数中了。我们看到匿名函数中声明了一个__webpack_require__，它就是用来模拟浏览器端的require（模块引用方法）。然后一些列代码将__webpack_require__设置完毕后，最后一行执行了

return __webpack_require__(__webpack_require__.s = "./app/main.js");

嗯，require了"./app/main.js"。也就是加载并执行main.js中的代码。

Greeter.js的加载执行

看一眼main.js编译后代码的样子：

function(module, exports, __webpack_require__) {

//main.js 
const greeter = __webpack_require__(/*! ./Greeter.js */ "./app/Greeter.js");
document.querySelector("#root").appendChild(greeter());

/***/ }

上面说到它被执行，第一句又__webpack_require__了"./app/Greeter.js"。所以Greeter.js中的代码，被加载并执行。

至此，浏览器端，模块的加载执行流程，梳理完成。

webpack是如何模拟源码中require，module.export、export、export default、import这些模块引用的

目前可以看出，require，module.export可以被又__webpack_require__很好的模拟。我们看看将Greeter.js中的module.export改成export，会发生什么：

// Greeter.js
export const greeter = function () {
  var greet = document.createElement('div');
  greet.textContent = "Hi there and greetings!";
  return greet;
};

生成的模块，是下面这样的：

function(module, __webpack_exports__, __webpack_require__) {

"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "greeter", function() { return greeter; });
// Greeter.js
const greeter = function () {
  var greet = document.createElement('div');
  greet.textContent = "Hi there and greetings!";
  return greet;
};

/***/ }

此时，我们在main.js打印一些require('./Greeter.js')。看看能得到什么：

const Greeter = require('./Greeter.js');
console.log(Greeter);
/*
Greeter对象
{
    greeter:f(), // f()是我们写的源代码方法
    __esModule:true,
}
*/

webpack_require.d帮我们将./Greeter.js又包了一层对象，里面有我们写的greeter变量，指代我们写的函数。我们可以通过Greeter.greeter()调用Greeter.js中的greeter方法。

这样也是复合预期的，export命令可以到处多个对象，供外界使用。我们可以在Greeter.js下写多个方法，那么导出的对象，就是这样的：

{
    greeter:f(),
    chinaGreeter:f(),
    AmericaGreeter:f(),
    __esModule:true,
}

那么，我们export default会编译成什么样：

// Greeter.js
export default function () {
  var greet = document.createElement('div');
  greet.textContent = "Hi there and greetings!";
  return greet;
};

编译后：

function(module, __webpack_exports__, __webpack_require__) {

"use strict";
__webpack_require__.r(__webpack_exports__);
// Greeter.js
/* harmony default export */ __webpack_exports__["default"] = (function () {
  var greet = document.createElement('div');
  greet.textContent = "Hi there and greetings!";
  return greet;
});

/***/ }

// Greeter.js导出的对象
{
    default: f(),
    __esModule:true,
}

跟export区别不大，只是导出变量的key变成了default。在main.js中，使用require('./Greeter.js').default，既可拿到我们编写的方法。

说完了导出模块，再来看引入模块的import。

//main.js 
import greeter from './Greeter.js';
document.querySelector("#root").appendChild(greeter());

编译后

function(module, __webpack_exports__, __webpack_require__) {

"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _Greeter_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./Greeter.js */ "./app/Greeter.js");
//main.js 

document.querySelector("#root").appendChild(Object(_Greeter_js__WEBPACK_IMPORTED_MODULE_0__["default"])());

/***/ })

import关键字，被编译成了_Greeter_js__WEBPACK_IMPORTED_MODULE_0__["default"]，完美的配合了export default。

再看一下import { greeter } from './Greeter.js'; 编译后为：

function(module, __webpack_exports__, __webpack_require__) {

"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _Greeter_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./Greeter.js */ "./app/Greeter.js");
//main.js 

console.log('greeter', _Greeter_js__WEBPACK_IMPORTED_MODULE_0__["greeter"]);
document.querySelector("#root").appendChild(Object(_Greeter_js__WEBPACK_IMPORTED_MODULE_0__["greeter"])());

/***/ }

使用greeter的地方变成了_Greeter_js__WEBPACK_IMPORTED_MODULE_0__["greeter"]，完美配合export的导出。

最后再看看import * as Greeter from './Greeter.js';的编译后的形式

function(module, __webpack_exports__, __webpack_require__) {

"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _Greeter_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./Greeter.js */ "./app/Greeter.js");
//main.js 

document.querySelector("#root").appendChild(_Greeter_js__WEBPACK_IMPORTED_MODULE_0__["greeter"]());

/***/ }

就是_Greeter_js__WEBPACK_IMPORTED_MODULE_0__代表Greeter对象，里面有greeter等export的函数。

Runtime和Manifest这两个概念的理解

我理解Runtime就是打包后文件中所有非源代码的部分，都算是运行时代码，帮助代码在浏览器运行，用于连接运行时各模块。

Manifest直译过来是清单的意思，我理解Manifest并不是指某句代码，而是指运行时的数据：保留Webpack的模块信息。就是上面生成代码中，installedModules变量存储的东西。

# 拆分到不同bundle的代码如何在一起运行的

我们经常使用Webpack代码拆分功能，那拆分之后的各个bundle是如何交互的呢？

我们在这里做一个实验，拆分一下manifest。在配置文件中添加：

  optimization: {
    runtimeChunk: {
      name: 'manifest'
    }
  }

在生成文件夹中，就产生了main.js，manifest.js两个文件，我们分别看看两个文件中的代码：

// main.js
(window["webpackJsonp"] = window["webpackJsonp"] || []).push([["index"],{

/***/ "./src/index.js":
/*!**********************!*\
  !*** ./src/index.js ***!
  \**********************/
/*! no static exports found */
/***/ (function(module, exports) {


// import greeter from './greeter';

// document.querySelector("#root").appendChild(greeter());
console.log('嗯哼');

/***/ })

},[["./src/index.js","manifest"]]]);

main.js中只有包含我们源代码模块的部分了。然后将其push到一个window["webpackJsonp"]的全局变量里。

再看看manifest.js:

/******/ (function(modules) { // webpackBootstrap
/******/ 	// install a JSONP callback for chunk loading
/******/ 	function webpackJsonpCallback(data) {
/******/ 	     ...
/******/ 		// add entry modules from loaded chunk to deferred list
/******/ 		deferredModules.push.apply(deferredModules, executeModules || []);
/******/
/******/ 		// run deferred modules when all chunks ready
/******/ 		return checkDeferredModules();
/******/ 	};
/******/ 	function checkDeferredModules() {
/******/ 	    ...
/******/
/******/ 		return result;
/******/ 	}
/******/
            ...
/******/ 	// The module cache
/******/ 	var installedModules = {};
/******/
/******/ 	var deferredModules = [];
/******/
/******/ 	// The require function
/******/ 	function __webpack_require__(moduleId) {
/******/
/******/ 		return module.exports;
/******/ 	}
/******/
/******/
/******/ 	var jsonpArray = window["webpackJsonp"] = window["webpackJsonp"] || [];
/******/ 	var oldJsonpFunction = jsonpArray.push.bind(jsonpArray);
/******/ 	jsonpArray.push = webpackJsonpCallback;
/******/ 	jsonpArray = jsonpArray.slice();
/******/ 	for(var i = 0; i < jsonpArray.length; i++) webpackJsonpCallback(jsonpArray[i]);
/******/ 	var parentJsonpFunction = oldJsonpFunction;
/******/
/******/
/******/ 	// run deferred modules from other chunks
/******/ 	checkDeferredModules();
/******/ })
/************************************************************************/
/******/ ([]);

这里删除了很多代码，只留下关键的，我们只需看 window["webpackJsonp"]这个变量，它是一个数组，并且重写了push方法为webpackJsonpCallback。这样在main.js中调用push时，实则调用了webpackJsonpCallback方法。webpackJsonpCallback执行后续的加载逻辑。这样，不同文件中的代码，共同工作完成在浏览器端的运行。

结束语

以上就是wepback生成文件的基本分析了。后续我们可以为我们的wepack配置添加loader，plugin，然后看看bundle文件有哪些变化，进而更好理解loader和plugin的作用及工作原理。

另外提一句webpack的学习方法，我觉得webpack的学习，重在练习，光看文章不一定会理解的很好，wepback是一个工具，而且日常工作中，很少去改动它，所以要自己多多练习，多多实验，才能比较好的掌握它。

avatar
文章
阅读
粉丝

友情链接：