Fekit基于CommonJs规范进行的JS模块包装

利用fekit前端自动化构建工具进行前端工程化开发工程中,我们知道fekit使用CommonJS规范进行JS模块化的实现。其中scripts文件夹(JS文件目录)下的每个文件(大多为js文件)都是一个模块,然后我们利用module对象、exports对象和require()方法进行模块的定义和模块引用。

在fekit中利用CommonJS实现的JS文件中包含module对象、exports对象和require()方法,但是浏览器宿主环境中的JS并没有相对的module对象、exports对象和require()方法,那么浏览器是怎样运行我们的JS文件的呢?还是fekit做了哪些工作使我们的JS文件(大多数)既可以模块化,又可以使其在浏览器中运行的呢?

fekit中的模块

下面是一个利用fekit自动构建工具模块化的一个基于CommonJS规范的index.js文件:

    var $ = require('../libs/jquery.js')
    exports.ajax = function(){
        $.ajax({
            url: '/web/getJSON',
            method: 'GET',
            data: {},
            success: function(res){
                var str = "";
                $.each(res.data,function(index,value){
                    str+="<li>"+value+"</li>";
                });
                $('.ul').html(str);
            }
        })
    }
    exports.count = 1;

首先我们利用require()方法引用了一个jquery.js模块,然后在index.js中利用module对象中的exports对象定义了一个包含ajax()方法和count变量(测试而已)的模块(不用着急看不懂,往下继续看),其中在ajax方法中我们使用了引入的jquery.js。

当我们书写完这个index.js模块后,利用fekit构建工具运行该项目,然后在chorme浏览器的source面板中,我们可以看到index.js变成了如下内容:

;(function(__context){
    var module = {
        id : "118cd57f279558dffcbae8096c7cf113" ,
        filename : "index.js" ,
        exports : {}
    };
    if( !__context.____MODULES ) { __context.____MODULES = {}; }
    var r = (function( exports , module , global ){
        var $ =__context.____MODULES['8777f761b8463a858236c246bedbce92'];
        exports.ajax = function(){
            $.ajax({
                url: '/web/getJSON',
                method: 'GET',
                data: {},
                success: function(res){
                    var str = "";
                    $.each(res.data,function(index,value){
                        str+="<li>"+value+"</li>";
                    });
                    $('.ul').html(str);
                }
            })
        }
        exports.count = 1;
    })( module.exports , module , __context );
    __context.____MODULES[ "118cd57f279558dffcbae8096c7cf113" ] = module.exports;
})(this);

对比我们自己在项目中的index.js,我们发现,浏览器中展示的index.js对我们的index.js进行了包装,外层包了两层IIFE,这就是fekit帮我们做得事。

fekit做了什么?

我们知道了fekit对我们的JS文件外层包了两层IIFE,那么这两层IIFE干了什么呢?

同时我们好像也明白了为什么模块之前的作用域实现了隔离,避免了相互污染。就是这两层IIFE的引起的。

第一层IIFE

通过浏览器中的index.js,我们可以看出此层包装的目的:

  1. 传入宿主对象。通过传入this实参给__context形参来实现宿主对象的传递,我们还可以看出宿主对象中有一个____MODULES数组,其储存着通过CommonJS规范定义的每一个模块的映射。这就是第一层IIFE为什么要传入宿主对象的原因,就是为了通过这个——MODULES数组中储存的映射去引用其他模块;同时将当前模块的映射保存进这个数组,以便其他模块引用。
  2. 创建当前模块的module对象。该对象中包括当前模块的id、filename、exports属性。

第二层IIFE

此层包装的目的:

  1. 将上一层IIFE中创建的module对象和宿主对象传入。传入module对象是为了包装当前模块,传入宿主对象是为了将当前模块的映射保存进——MODULES数组。
  2. 引用其他模块。我们可以看出第二层IIFE的第一句就是去宿主对象的——MODULES数组中查找一个ID,这个ID就是jquery.js模块的moudule对象中的id属性。
  3. 将模块中的方法或变量赋值给exports对象。将该模块需要暴露出去给其他模块使用的方法或变量赋值给上一层传入的module对象的exports对象。
  4. 将当前模块储存进宿主对象的“____MODULES”数组。将该模块的id储存到宿主对象的“____MODULES”数组后,其他模块就可以引用当前模块了。

注:在CommonJS中,每个模块都有一个module对象代表当前模块对象,其exports对象中储存了暴露给其他模块的变量和方法。

结束语

这就是fekit对CommonJS规范的实现,使开发者可以方便的对JS进行模块化开发,而不用担心浏览器不支持CommonJS规范编写的JS模块化的文件。

前端自动化构建工具对于JS模块化的包装的方式也各有不同,但是目的是一样的,比如Gulp利用webpack的imports-loader插件进行的包装如下,有兴趣的小伙伴可以研究一下。

gulp(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] = {
    /******/            exports: {},
    /******/            id: moduleId,
    /******/            loaded: false
    /******/        };

    /******/        // Execute the module function
    /******/        modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);

    /******/        // Flag the module as loaded
    /******/        module.loaded = 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;

    /******/    // __webpack_public_path__
    /******/    __webpack_require__.p = "";

    /******/    // Load entry module and return exports
    /******/    return __webpack_require__(0);
    /******/ })
    /************************************************************************/
    /******/ ([
    /* 0 */
    /***/ function(module, exports, __webpack_require__) {

        module.exports = __webpack_require__(1);


    /***/ },
    /* 1 */
    /***/ function(module, exports) {

        /*** IMPORTS FROM imports-loader ***/
        var define = false;

        var common = {
          render: function ($el, str) {
            if($el.get(0).tagName.toLowerCase() == 'body') {
              $el.prepend(str);
            } else {
              $el.html(str);
            }
          }
        };

        module.exports = common;

    /***/ }
    /******/ ]);

gulp(webpack)包装前

    var common = {
      render: function ($el, str) {
        if($el.get(0).tagName.toLowerCase() == 'body') {
          $el.prepend(str);
        } else {
          $el.html(str);
        }
      }
    };

    module.exports = common;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容