学渣的模块化之路——50行代码带你手写一个common.js规范

简介:

一、简述

  • 一个js文件就是一个模块
  • 会自动把写的代码块套一层闭包
  • 浏览器不兼容CommonJS的根本原因,在于缺少四个Node.js环境的变量.(module,export,require,global)

既然没有,我们就手写一个吧,这里先普及下备用的基础知识,请往下看

二、源码中用到的备用知识

fs.accessSync方法

  • 判断文件是否存在,不存在则报错

  • let fs = require("fs");
    fs.accessSync("./x.js") //当前目录中没有该文件则会报错
    


  • path.extname方法
  • 判断文件的扩展名

  • let path = require("path");
    console.log(path.extname("./c.js"))
    


  • vm.runInThisContext()方法

    • 会创建一个独立的沙箱环境,以执行对参数code的编译,运行并返回结果。vm.runInThisContext()方法运行的代码没有权限访问本地作用域,但是可以访问Global全局对象。


var vm = require('vm');
var localVar = 'initial value';

//在runInThisContext创建的沙箱环境中执行
var vmResult = vm.runInThisContext('localVar = "vm";');
console.log('vmResult: ', vmResult);    //vmResult:  vm
console.log('localVar: ', localVar);    //localVar:  initial value

//在eval中执行
var evalResult = eval('localVar = "eval";');
console.log('evalResult: ', evalResult);	//evalResult:  eval
console.log('localVar: ', localVar);	//localVar:  eval

  • 在上面示例中,分在vm.runInThisContext()方法创建的沙箱环境中和eval()中执行了一段JavaScript代码。 vm.runInThisContext创建的沙箱环境无法访问本地作用域,因此localVar没有被改变。而eval可以访问本地作用域,因此localVar被改变。
  • 有了这些基础知识的储备,已经迫不及待的开始手写源代码了

三、模块化实现

  • 我们想的是构建一个module实例,类似这样{ loaded: false,filename: 绝对路径, exports: 引入模块的结果}
  • loaded检测如果require多次,会进行缓存,
  • filename我们需要把输入的路径变成绝对路径
  • export存放我们加载模块后的结果,至于怎么实现,我们会对应load方法就行实现
  • 最后把export返回,就实现了加载模块
  • 有了这么点想法,我们就一步一步开始实现吧

1、准备工作做好,声明构造函数Module


let path = require('path');
let fs = require('fs');
let vm = require('vm');
// 声明构造函数Module
function Module(filename){
    this.loaded = false; //用于检测是否被缓存过
    this.filename = filename; //文件的绝对路径
    this.exports = {} //模块对应的导出结果
}
//存放模块的扩展名
Module._extensions = ['.js','.json'];
//检测是否有缓存
Module._cache = {};
//拼凑成闭包的数组
Module.wrapper = ['(function(exports,require,module){','\r\n})'];


已经把准备声明的变量和模块声明好,没有使用的先不用理会,下面用到的时候就明白了

2、实现一个require方法,实现加载模块


function req(path) { //自己实现require方法,实现加载模块
    // 根据输入的路径 变出一个绝对路径
    let filename = Module._resolveFilename(path);
    // 通过这个文件名创建一个模块
    let module = new Module(filename);
    module.load(); //让这个模块进行加载 根据不同的后缀加载不同的内容
    return module.exports
}


3、有了这个架构想法,先实现 Module._resolveFilename方法


//如果没写扩展名,我们给它默认添加扩展名
Module._resolveFilename = function (p) {
    p = path.join(__dirname,p);
    if(!/\.\w+$/.test(p)){
        //如果没写扩展名,尝试添加扩展名
        for(let i=0;i

4、此时的filename是存在这个文件的绝对路径,接下来对不同后缀名加载不同的内容


Module.prototype.load = function () {
  // 加载模块本身 js按照js加载 json按照json加载
  let extname = path.extname(this.filename); //判断后缀名
  Module._extensions[extname](this); //把module实例传过去
}

5、先实现加载.json后缀的方法,直接文件读取,并赋值给module.export


Module._extensions['.json'] = function (module) {
    let content = fs.readFileSync(module.filename,'utf8');
    module.exports = JSON.parse(content);
};


写了这么多,我们先来测试下.json结尾的文件,有没有被写入到module.exports中


6、实现以.js结尾的后缀名的方法


// 后缀名为js的加载方法
Module._extensions['.js'] = function (module) {
    //取出加载模块的内容
    let content = fs.readFileSync(module.filename,'utf8');
    // 形成闭包
    let script = Module.wrap(content);
    //让js代码执行
    let fn = vm.runInThisContext(script);
    fn.call(module,module.exports,req,module)
};


7、我们来看下Module.wrap(content)如何进行代码解析的


Module.wrap = function(content){
    return Module.wrapper[0] + content +Module.wrapper[1];
};


是不是很简单,只是简单的js字符串拼接成闭包的函数,然后让其进行执行。到目前为止,基本的功能已经实现了,我们先来测试下。但是我们还没实现缓存,接下来继续


8、最后我们在处理下缓存,就完美结束啦


//检测是否有缓存
Module._cache = {};
//改造下req方法
function req(path) { //自己实现require方法,实现加载模块
    // 根据输入的路径 变出一个绝对路径
    let filename = Module._resolveFilename(path);
    if(Module._cache[filename]){ //有缓存直接取缓存中的
        return Module._cache[filename].exports;
    }
    // 通过这个文件名创建一个模块
    let module = new Module(filename);
    module.load(); //让这个模块进行加载 根据不同的后缀加载不同的内容
    Module._cache[filename] = module; //第一次加载先缓存
    return module.exports
}

这样一来就完美实现了,共不到50行代码,开不开心,愉不愉快。最后贴上源码供大家参考,别忘记喜欢哦

9、源码贴上(仅供参考)

let path = require('path');
let fs = require('fs');
let vm = require('vm');
// 声明构造函数Module
function Module(filename){
    this.loaded = false; //用于检测是否被缓存过
    this.filename = filename; //文件的绝对路径
    this.exports = {} //模块对应的导出结果
}
//存放模块的扩展名
Module._extensions = ['.js','.json'];
//检测是否有缓存
Module._cache = {};
//拼凑成闭包的数组
Module.wrapper = ['(function(exports,require,module){','\r\n})'];
//如果没写扩展名,我们给它默认添加扩展名
Module._resolveFilename = function (p) {
    p = path.join(__dirname,p);
    if(!/\.\w+$/.test(p)){
        //如果没写扩展名,尝试添加扩展名
        for(let i=0;i



原文发布时间为:2018年06月25日

原文作者:言sir

本文来源:掘金  如需转载请联系原作者

相关文章
|
3月前
|
JavaScript UED
js之模块化(2)
js之模块化(2)
|
4月前
|
JavaScript 前端开发 编译器
解锁JavaScript模块化编程新纪元:从CommonJS的基石到ES Modules的飞跃,探索代码组织的艺术与科学
【8月更文挑战第27天】随着Web应用复杂度的提升,JavaScript模块化编程变得至关重要,它能有效降低代码耦合度并提高项目可维护性及扩展性。从CommonJS到ES Modules,模块化标准经历了显著的发展。CommonJS最初专为服务器端设计,通过`require()`同步加载模块。而ES Modules作为官方标准,支持异步加载,更适合浏览器环境,并且能够进行静态分析以优化性能。这两种标准各有特色,但ES Modules凭借其更广泛的跨平台兼容性和现代语法逐渐成为主流。这一演进不仅标志着JavaScript模块化的成熟,也反映了整个JavaScript生态系统的不断完善。
53 3
|
3月前
|
JavaScript 前端开发 开发者
js之模块化(1)
js之模块化(1)
|
2月前
|
缓存 JavaScript 前端开发
Node.js模块化的基本概念和分类及使用方法
Node.js模块化的基本概念和分类及使用方法
38 0
|
3月前
|
JavaScript
js之模块化(3)
js之模块化(3)
|
4月前
|
JavaScript 前端开发 程序员
JS小白请看!一招让你的面试成功率大大提高——规范代码
JS小白请看!一招让你的面试成功率大大提高——规范代码
|
4月前
|
前端开发 JavaScript
前端必会的JavaScript模块化
【8月更文挑战第3天】JavaScript模块化
32 1
|
4月前
|
存储 缓存 JavaScript
JavaScript——请列出目前主流的 JavaScript 模块化实现的技术有哪些?说出它们的区别?
JavaScript——请列出目前主流的 JavaScript 模块化实现的技术有哪些?说出它们的区别?
34 0
|
5月前
|
JavaScript 前端开发
node.js 导入导出模块(CommonJS模块化规范,ES6模块化规范)
node.js 导入导出模块(CommonJS模块化规范,ES6模块化规范)
61 1
|
6月前
|
JavaScript 前端开发
JavaScript进阶-Class与模块化编程
【6月更文挑战第21天】**ES6引入Class和模块化,提升JavaScript的代码组织和复用。Class是原型机制的语法糖,简化面向对象编程。模块化通过`import/export`管理代码,支持默认和命名导出。常见问题包括`this`指向和循环依赖。理解这些问题及避免策略,能助你写出更高效、可维护的代码。**
66 5