浏览器加载服务器端JavaScript的CommonJS模块的原理与实现

npm 的模块都是 JavaScript 语言写的,但浏览器用不了,因为不支持 CommonJS 格式。要想让浏览器用上这些模块,必须转换格式。

本文介绍浏览器加载 CommonJS 的原理,并且给出一种非常简单的实现。

一、原理

浏览器不兼容CommonJS的根本原因,在于缺少四个Node.js环境的变量。

        module
        exports
        require
        global

只要能够提供这四个变量,浏览器就能加载 CommonJS 模块。

下面是一个简单的示例。

    var module = {
      exports: {}
    };

    (function(module, exports) {
      exports.multiply = function (n) { return n * 1000 };
    }(module, module.exports))

    var f = module.exports.multiply;
    f(5) // 5000

上面代码向一个立即执行函数提供 module 和 exports 两个外部变量,模块就放在这个立即执行函数里面。模块的输出值放在 module.exports 之中,这样就实现了模块的加载。

二、Browserify 的实现

知道了原理,就能做出工具了。Browserify 是目前最常用的 CommonJS 格式转换的工具。

请看一个例子,main.js 模块加载 foo.js 模块。

    // foo.js
    module.exports = function(x) {
      console.log(x);
    };

    // main.js
    var foo = require("./foo");
    foo("Hi");

使用下面的命令,就能将main.js转为浏览器可用的格式。

    $ browserify main.js > compiled.js

Browserify到底做了什么?安装一下browser-unpack,就能看清楚了。

    $ npm install browser-unpack -g

然后,将前面生成的compile.js解包。

    $ browser-unpack < compiled.js

    [
      {
        "id":1,
        "source":"module.exports = function(x) {\n  console.log(x);\n};",
        "deps":{}
      },
      {
        "id":2,
        "source":"var foo = require(\"./foo\");\nfoo(\"Hi\");",
        "deps":{"./foo":1},
        "entry":true
      }
    ]

可以看到,browerify 将所有模块放入一个数组,id 属性是模块的编号,source 属性是模块的源码,deps 属性是模块的依赖。

因为 main.js 里面加载了 foo.js,所以 deps 属性就指定 ./foo 对应1号模块。执行的时候,浏览器遇到 require('./foo') 语句,就自动执行1号模块的 source 属性,并将执行后的 module.exports 属性值输出。

三、Tiny Browser Require

虽然 Browserify 很强大,但不能在浏览器里操作,有时就很不方便。

我根据 mocha 的内部实现,做了一个纯浏览器的 CommonJS 模块加载器 tiny-browser-require 。完全不需要命令行,直接放进浏览器即可,所有代码只有30多行。


它的逻辑非常简单,就是把模块读入数组,加载路径就是模块的id。

    function require(p){
      var path = require.resolve(p);
      var mod = require.modules[path];
      if (!mod) throw new Error('failed to require "' + p + '"');
      if (!mod.exports) {
        mod.exports = {};
        mod.call(mod.exports, mod, mod.exports, require.relative(path));
      }
      return mod.exports;
    }

    require.modules = {};

    require.resolve = function (path){
      var orig = path;
      var reg = path + '.js';
      var index = path + '/index.js';
      return require.modules[reg] && reg
        || require.modules[index] && index
        || orig;
    };

    require.register = function (path, fn){
      require.modules[path] = fn;
    };

    require.relative = function (parent) {
      return function(p){
        if ('.' != p.charAt(0)) return require(p);
        var path = parent.split('/');
        var segs = p.split('/');
        path.pop();

        for (var i = 0; i < segs.length; i++) {
          var seg = segs[i];
          if ('..' == seg) path.pop();
          else if ('.' != seg) path.push(seg);
        }

        return require(path.join('/'));
      };
    };

使用的时候,先将上面的代码放入页面。然后,将模块放在如下的立即执行函数里面,就可以调用了。

   

还是以前面的 main.js 加载 foo.js 为例。

    require.register("./foo.js", function(module, exports, require){
      module.exports = function(x) {
        console.log(x);
      };
    });

    var foo = require("./foo.js");
    foo("Hi");

注意,这个库只模拟了 require 、module 、exports 三个变量,如果模块还用到了 global 或者其他 Node 专有变量(比如 process),就通过立即执行函数提供即可。

时间: 2024-10-13 23:02:06

浏览器加载服务器端JavaScript的CommonJS模块的原理与实现的相关文章

浏览器加载 CommonJS 模块的原理与实现

就在这个周末,npm 超过了 cpan ,成为地球上最大的软件模块仓库. npm 的模块都是 JavaScript 语言写的,但浏览器用不了,因为不支持 CommonJS 格式.要想让浏览器用上这些模块,必须转换格式. 本文介绍浏览器加载 CommonJS 的原理,并且给出一种非常简单的实现. 一.原理 浏览器不兼容CommonJS的根本原因,在于缺少四个Node.js环境的变量. module exports require global 只要能够提供这四个变量,浏览器就能加载 CommonJ

异步加载:ControlJS让脚本加载更快的一个模块

文章简介:关于ControlJs的使用和基础讲解. 关于ControlJs一共有三篇文章,这是第一部分.ControlJS是让脚本加载更快的一个模块(a javascript module for making scripts load faster). 三篇文章的结构分别为: 1. async loading2. delayed execution3.overriding document.write关于第一部分的异步加载,这个的关键在于尽快将页面作为html绘制出来,然后再用javascri

【转】浏览器加载渲染网页过程解析--总结(三)

1.浏览器加载和渲染html的顺序 1.IE下载的顺序是从上到下,渲染的顺序也是从上到下,下载和渲染是同时进行的. 2.在渲染到页面的某一部分时,其上面的所有部分都已经下载完成(并不是说所有相关联的元素都已经下载完) 3.如果遇到语义解释性的标签嵌入文件(JS脚本,CSS样式),那么此时IE的下载过程会启用单独连接进行下载. 4.并且在下载后进行解析,解析过程中,停止页面所有往下元素的下载.阻塞加载 5.样式表在下载完成后,将和以前下载的所有样式表一起进行解析,解析完成后,将对此前所有元素(含以

html5封装的app怎么隐藏浏览器加载进度条和浏览器下底框

问题描述 html5封装的app怎么隐藏浏览器加载进度条和浏览器下底框 用html5写的网页,直接封装的: public class MainActivity extends Activity { private WebView webview; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //实例化WebView对象 webview = new W

如何动态加载外部Javascript文件_javascript技巧

最近在网上找到了一个可以动态加载js文件的js加载器,具体代码如下:JsLoader.js var MiniSite=new Object(); /** * 判断浏览器 */ MiniSite.Browser={ ie:/msie/.test(window.navigator.userAgent.toLowerCase()), moz:/gecko/.test(window.navigator.userAgent.toLowerCase()), opera:/opera/.test(window

浏览器加载、渲染和解析过程黑箱简析_javascript技巧

用 Fiddler 监控,在 IE6 下,资源下载顺序为: 很明显,下载顺序从上到下,文档流中先出现的资源先下载.在 IE8, Safari, Chrome 等浏览器下也类似. Firefox 对下载顺序做了优化:Firefox 会将 js, css 提前下载,而将图片等资源延迟到后面下载. 对于渲染,利用 Fiddler 将网速调慢,可以看到 css 下载后会马上渲染到页面,渲染和下载同步进行.js 的解析和运行,也类似. 对于 js 运行,以及页面加载相关事件的触发,特别做了测试.在 Fir

Win8如何管理和禁用IE10浏览器加载项

  Win8管理和禁用IE10浏览器加载项的方法如下: 1.在IE命令栏或右上角点击"工具"按钮,点击打开"管理加载项". 2.选中需要禁用或启用的选项,点击"禁用"或"启用"即可. 3.也可打开Internet选项,选择"程序"选项卡,点击"管理加载项"进行操作.

如何最快的加载外部JavaScript文件

    当<script>标签位于html文档流中的时候,位于<script>后面的html会被阻止渲染,必须等到该script加载完以后才会后面的html才会渲染,通过JavaScript动态的生成一个script标签,可以避免上面你的这个问题,因为这个会是外部加载的script的文件位于html文档流以外.因此动态的加载外部的JavaScript文件可以提高页面的渲染速度,提高用户体验.   最佳实践 Steve Souders关于外部的JavaScript文件不阻碍html文

jquery-IE浏览器加载多个easyui-combotree的问题

问题描述 IE浏览器加载多个easyui-combotree的问题 页面上有多个easyui-combotree文本框,IE加载进来只显示一个. 页面body中: JS中: $(".ccombotree").combotree({ method: "Get", url: contextPath + '/fa/getTreeData.do', multiple: false, required: false }).removeClass('ccombotree');