webpack之commonjs模块化原理

2,501 阅读3分钟

分析webpack是如何实现模块化的

准备

首先创建一个简单入口模块index.js和一个依赖模块bar.js

//index.js
'use strict';
var bar = require('./bar');

function foo() {
    bar();
}
//bar.js
'use strict';
exports.bar = function(){
    return 'bar';
}

webpack的配置如下

var path = require("path");
module.exports = {
    mode: 'development',
    entry: path.join(__dirname, './src/index.js'),
    output: {
        path: path.join(__dirname, 'dist'),
        filename: 'index.js?v=[hash:8]',
    },
};

打包后得到的代码

(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 = "./src/index.js");
})({

    "./src/bar.js":
    (function(module, exports, __webpack_require__) {
        "use strict";
        eval("\nexports.bar = function(){\n    return 'bar';\n}\n\n//# sourceURL=webpack:///./src/bar.js?");
    }),
    "./src/index.js":
    (function(module, exports, __webpack_require__) {
        "use strict";
        eval("\nvar bar = __webpack_require__(/*! ./bar */ \"./src/bar.js\");\n\nfunction foo() {\n    bar();\n}\n\n//# sourceURL=webpack:///./src/index.js?");
    })
});

分析

简化打包后的文件

(function(modules) { 
    //模块代码
})({
    "./src/bar.js":
    (function(module, exports, __webpack_require__) {
        //bar.js代码
    }),
    "./src/index.js":
    (function(module, exports, __webpack_require__) {
        //index.js代码
    })
});
function(modules){
    //1、定义模块缓存
    var installedModules = {};
    //2、webpack实现的require
    function __webpack_require__(moduleId) {
        //3、判断是否已缓存模块
        if(installedModules[moduleId]) {
            return installedModules[moduleId].exports;
        }
        //4、缓存模块
        var module = installedModules[moduleId] = {
            i: moduleId,
            l: false,
            exports: {}
        };
        //5、调用模块函数
        modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
        //6、标记模块为已加载
        module.l = true;
        // 7、返回module.exports
        return module.exports;
    }
    __webpack_require__.m = modules;// 暴露模块对象(__webpack_modules__)
    __webpack_require__.c = installedModules;//暴露模块缓存
    __webpack_require__.d = function(exports, name, getter) {// 为标准exports定义getter方法
        if(!__webpack_require__.o(exports, name)) {
            Object.defineProperty(exports, name, { enumerable: true, get: getter });
        }
    };
    __webpack_require__.r = function(exports) {// 在exports中定义__esModule
        if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
            Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
        }
        Object.defineProperty(exports, '__esModule', { value: true });
    };
    __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;
    };
    __webpack_require__.n = function(module) {//getDefaultExport函数,用于与非标准模块兼容
        var getter = module && module.__esModule ?
        function getDefault() { return module['default']; } :
        function getModuleExports() { return module; };
        __webpack_require__.d(getter, 'a', getter);
        return getter;
    };
    __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
    __webpack_require__.p = "";//公共路径
    
    return __webpack_require__(__webpack_require__.s = "./src/index.js"); //加载入口模块,并返回exports
}
  • 1、模块对象作为参数传入IIFE函数
  • 2、IIFE首先定义了installedModules ,这个变量被用来缓存已加载的模块
  • 3、定义了__webpack_require__ 这个函数,函数参数为模块的id。这个函数用来实现模块的require
  • 4、如果没有缓存,也就是第一次加载,则首先初始化模块,并将模块进行缓存
  • 5、然后调用模块函数,也就是前面webpack对我们的模块的包装函数,将module、module.exports和__webpack_require__作为参数传入。注意这里做了一个动态绑定,将模块函数的调用对象绑定为module.exports,这是为了保证在模块中的this指向当前模块
  • 6、调用完成后,模块标记为已加载
  • 7、返回模块exports的内容

总结

实现exports和require,然后自动加载入口模块,控制缓存模块

参考文档

webpack模块化原理-commonjs