RequireJs 源码解读及思考

写在前面：

最近做的一个项目，用的require和backbone，对两者的使用已经很熟悉了，但是一直都有好奇他们怎么实现的，一直寻思着读读源码。现在项目结束，终于有机会好好研究一下。

本文重要解读requirejs的源码，backbone源码分析将会随后给出。

行文思路：

requirejs 基本介绍
requirejs使用后的几个好奇
requirejs源码解读

requirejs基本介绍

由于篇幅有限，这里不会详解requirejs的使用和api，建议读者朋友自己去用几次，再详读api.

简介

简单来说，requirejs是一个遵循 AMD(Asynchronous Module Definition)规范的模块载入框架。

使用requirejs的好处是：异步加载、模块化、依赖管理

使用

引入：

这里的data-main是整个项目的入口.

定义模块：

define();
} : function (fn) { fn(); };

req.onError = defaultOnError;
        req.createNode = function (config, moduleName, url) {};
        req.load = function (context, moduleName, url) {};
        define = function (name, deps, callback) {};
        req.exec = function (text) {};
        req(cfg);
         ? [) &&
                    !isOpera) {
                useInteractive = true;
                node.attachEvent('onreadystatechange', context.onScriptLoad);
            } else {
                node.addEventListener('load', context.onScriptLoad, false);
                node.addEventListener('error', context.onScriptError, false);
            }
            node.src = url;

// 兼容IE6-8, script可能在append之前执行, 所有把noe绑定在currentAddingScript中，防止其他地方改变这个值
            currentlyAddingScript = node;
            if (baseElement) {
                // 这里baseElement是getElementsByName('base'); 现在一般都执行else了。
                head.insertBefore(node, baseElement);
            } else {
                head.appendChild(node);
            }
            currentlyAddingScript = null;
            return node;
        } else if (isWebWorker) {
            // 如果是web worker。。不懂
            try {
                importScripts(url);
                context.completeLoad(moduleName);
            } catch (e) {
                context.onError(makeError('importscripts',
                                'importScripts failed for ' +
                                    moduleName + ' at ' + url,
                                e,
                                [moduleName]));
            }
        }

};

这里可以看出第一个问题的原因了.引入data-*的作用是用来移除匹配用的.或则IE低版本中修正contextName和moduleName. 这里req.createNode和context.onScriptLoad是其他地方定义的，接下来看req.createNope:

  req.createNode = function (config, moduleName, url) {
        var node = config.xhtml ?
                document.createElementNS('http://www.w3.org/1999/xhtml', 'html:script') :
                document.createElement('script');
        node.type = config.scriptType || 'text/javascript';
        node.charset = 'utf-8';
        node.async = true; // 异步
        return node;

};

这里可以解决最后一个问题，通过appendChild, node.async实现异步加载的。

当node加载完毕后会调用context.onScriptLoad, 看看做了什么:

  onScriptLoad: function (evt) {
        if (evt.type === 'load' ||
                (readyRegExp.test((evt.currentTarget || evt.srcElement).readyState))) {
            interactiveScript = null;
            // getScriptData()找evet对应的script, 提取data-requiremodule就知道mod的name了。
            var data = getScriptData(evt);
            context.completeLoad(data.id);
        }

}

再看context.completeLoad:

completeLoad: function (moduleName) {

var found, args, mod,
            shim = getOwn(config.shim, moduleName) || {},
            shExports = shim.exports;
        // 把globalQueue 转换到 context.defQueue(define收集到的mod集合)
        takeGlobalQueue();
        while (defQueue.length) {
            args = defQueue.shift();
            if (args[0] === null) {
                args[0] = moduleName;
                // 如果当前的defModule是匿名define的(arg[0]=null), 把当前moduleName给他，并标记找到
                if (found) {
                    break;
                }
                found = true;
            } else if (args[0] === moduleName) {
                //  非匿名define
                found = true;
            }
            // callGetModule较长, 作用是实例化一个context.Module对象并初始化, 放入registry数组中表示可用.
            callGetModule(args);
        }

// 获取刚才实例化的Module对象
mod = getOwn(registry, moduleName);

if (!found && !hasProp(defined, moduleName) && mod && !mod.inited) {
            if (config.enforceDefine && (!shExports || !getGlobal(shExports))) {
                if (hasPathFallback(moduleName)) {
                    return;
                } else {
                    return onError(makeError('nodefine',
                                     'No define call for ' + moduleName,
                                     null,
                                     [moduleName]));
                }
            } else {
                callGetModule([moduleName, (shim.deps || []), shim.exportsFn]);
            }
        }
        // 检查loaded情况，超过时间的就remove掉，并加入noLoads数组
        checkLoaded();

}

可以看到，当script加载完毕后，只做了一件事：实例化context.Module对象，并暴露给registry供调用.

require 实现

req = requirejs = function (deps, callback, errback, optional) {

var context, config,
            contextName = defContextName;
        // 第一个参数不是模块依赖表达
        if (!isArray(deps) && typeof deps !== 'string') {
            // deps is a config object
            config = deps;
            if (isArray(callback)) {
                // 如果有依赖模块则调整参数, 第二个参数是deps
                deps = callback;
                callback = errback;
                errback = optional;
            } else {
                deps = [];
            }
        }
        if (config && config.context) {
            contextName = config.context;
        }
        context = getOwn(contexts, contextName);
        if (!context) {
            context = contexts[contextName] = req.s.newContext(contextName);
        }
        if (config) {
            context.configure(config);
        }
        // 以上获取正确的context，contextName
        return context.require(deps, callback, errback);
};

一看，结果什么都没做，做的事还在context.require()里面。在context对象中：

context.require = context.makeRequire();

我们需要的require结果是context.makeRequire这个函数返回的闭包：

  makeRequire: function (relMap, options) {
        options = options || {};
        function localRequire(deps, callback, errback) {
            var id, map, requireMod;
            if (options.enableBuildCallback && callback && isFunction(callback)) {
                callback.__requireJsBuild = true;
            }
            if (typeof deps === 'string') {
                if (isFunction(callback)) {
                    // 非法调用
                    return onError(makeError('requireargs', 'Invalid require call'), errback);
                }
                // 如果require的是require|exports|module 则直接调用handlers定义的
                if (relMap && hasProp(handlers, deps)) {
                    return handlers[deps](registry[relMap.id]);
                }
                if (req.get) {
                    return req.get(context, deps, relMap, localRequire);
                }
                // 通过require的模块名Normalize成需要的moduleMap对象
                map = makeModuleMap(deps, relMap, false, true);
                id = map.id;

if (!hasProp(defined, id)) {
                    return onError(makeError('notloaded', 'Module name "' +
                                id +
                                '" has not been loaded yet for context: ' +
                                contextName +
                                (relMap ? '' : '. Use require([])')));
                }
                // 返回require的模块的返回值。
                return defined[id];
            }

// 把globalQueue 转换到 context.defQueue，并把defQueue的每一个都实例化一个context.Module对象并初始化, 放入registry数组中表示可用.
intakeDefines();

// nextTick 使用的是setTimeOut.如果没有则是回调函数
            // 本次require结束后把所有deps标记为needing to be loaded.
            context.nextTick(function () {
                intakeDefines();
                requireMod = getModule(makeModuleMap(null, relMap));
                requireMod.skipMap = options.skipMap;
                requireMod.init(deps, callback, errback, {
                    enabled: true
                });
                checkLoaded();
            });
            return localRequire;
        }
        ..
        return localRequire;

}

如果直接require模块, 会返回此模块的返回值;否则会把他加入到context.defQueue, 初始化后等待调用; 比如直接:

var util = require('./path/to/util');

会直接返回util模块返回值; 而如果：

require(['jquery', 'backbone'], function($, Backbone){});

就会执行intakeDefines()和nextTick();

总结

花时间读读源码，对以前使用require时的那些做法想通了，知道那样做的原因和结果，以后用着肯定也会顺手多了。

学习框架源码可以让自己用的有谱、大胆, 更多的时候是学习高手的代码组织, 编码风格，设计思想，对自己提升帮助很大~

总结下自己研读源码方式，希望对读者有所帮助：项目中用熟 -> 源码如何布局组织-> demo进入源码,log验证猜想-> 看别人分析 -> 总结

玉伯说 RequireJS 是没有明显的 bug，SeaJS 是明显没有 bug, 以后一定研究下seajs，看看如何明显没有bug.