seajs 3.0.0 源码阅读笔记

写笔记的时候才注意到我看的源代码是 3.0.0 的，但是官方发布的最新版本是 2.3.0。相信大部分是相同的，所以先把这个记完，再看一次 2.3.0 的代码。

整个seajs采用的是2空格缩进，避免分号的写法，我不是很习惯，但不影响阅读。

文档中各个源文件所包含的内容大致如下：

<code>intro.js</code> 文件头 <code>sea.js</code> 定义全局 <code>global.seajs</code> 对象和 <code>seajs.data</code> 对象 <code>util-lang.js</code>，语言相关工具定义用于判断对象类型的 <code>isXxxxx()</code> 函数，以及一个与语言无关的 <code>cid()</code>。 <code>util-events.js</code> 定义 seajs 的事件处理相关函数，包括 <code>on()</code>、<code>off()</code>、<code>emit()</code> <code>util-path.js</code> 定义用于路径处理的工具函数 <code>util-request.js</code> 定义请求文件的工具函数 <code>seajs.request()</code> 等 <code>util-deps.js</code> 定义用于分析依赖关系的 <code>parseDependencies()</code> <code>module.js</code> seajs 的核心，模块类。也包含部分 seajs 的方法 <code>config.js</code> 定义 <code>seajs.config()</code>，以及 <code>data</code> 部分属性的默认值

所以合并之后的整个 seajs 代码看起来就像这样

<code>(</code><code>function</code><code>(global, undefiend) {</code>

<code> </code><code>global.seajs = {</code>

<code> </code><code>var</code> <code>isObject = </code><code>function</code><code>() {}</code>

<code> </code><code>var</code> <code>isString = </code><code>function</code><code>() {}</code>

<code> </code><code>var</code> <code>isArray = </code><code>function</code><code>() {}</code>

<code> </code><code>var</code> <code>isFunction = </code><code>function</code><code>() {}</code>

<code> </code><code>var</code> <code>cid = </code><code>function</code><code>() {}</code>

<code> </code><code>data.events = {}</code>

<code> </code><code>seajs.on = </code><code>function</code><code>() {}</code>

<code> </code><code>seajs.off = </code><code>function</code><code>() {}</code>

<code> </code><code>seajs.emit = </code><code>function</code><code>() {}</code>

<code> </code><code>// path utils, and</code>

<code> </code><code>seajs.resolve = </code><code>function</code><code>() {}</code>

<code> </code><code>var</code> <code>loaderDir</code>

<code> </code><code>var</code> <code>parseDependencies = </code><code>function</code><code>() {}</code>

<code> </code><code>function</code> <code>Module() {}</code>

<code> </code><code>seajs.config = </code><code>function</code><code>() {}</code>

首先是定义了一个产生 isXxxx 的函数工厂 <code>isType()</code>

<code>function</code> <code>isType(type) {</code>

<code> </code><code>return</code> <code>function</code><code>(obj) {</code>

<code> </code><code>return</code> <code>{}.toString.call(obj) == </code><code>"[object "</code> <code>+ type + </code><code>"]"</code>

从这个工厂的代码可以看出来，<code>isXxxx()</code> 主要是通过 <code>Object.prototype.toString</code> 的值来判断对象类型的。

当然也有例外：

<code>// 毕竟 Array.isArray() 是 [native code]，效果会高得多</code>

<code>var</code> <code>isArray = Array.isArray || isType(</code><code>"Array"</code><code>)</code>

这里有几件事情我不是很明白：就是为什么不使用 <code>typeof</code> 运算符来判断类型，一般语言中运算符实现会比比较字符串快得多。 <code>{}.toString.call(obj)</code> 和 <code>Object.prototype.toString.call(obj)</code> 的作用是一样的，但是在运行时，每执行一次 <code>isXxxx</code> 就会产生一个新的 <code>{}</code> 对象；而 <code>Object.prototype</code> 始终都是同一个对象，似乎可以减少不少开销 jQuery 的 <code>isFunction()</code> 等方法都是通过 <code>jQuery.type()</code> 来实现的，而 <code>jQuery.type</code> 中则是通过定义了一个 <code>class2type</code> 字典对象来做类型映射，

2014-09-09 补充我在 seajs 的 issue 上问了这个问题，于是上面的几个问题就都找到答案了： <a href="https://github.com/seajs/seajs/issues/1314" target="_blank">https://github.com/seajs/seajs/issues/1314</a> 参考玉伯的博客 <a href="https://github.com/lifesinger/lifesinger.github.com/issues/175" target="_blank">https://github.com/lifesinger/lifesinger.github.com/issues/175</a>

<code>jQuery.each(</code><code>"Boolean Number String Function Array Date RegExp Object Error"</code><code>.split(</code><code>" "</code><code>), </code><code>function</code><code>(i, name) {</code>

<code> </code><code>class2type[ </code><code>"[object "</code> <code>+ name + </code><code>"]"</code> <code>] = name.toLowerCase();</code>

这种作法也会比每次都拼字符串（<code>"[object " + type + "]"</code>）来比较要效率高一些吧。不过 seajs 和 jquery 都没有直接依赖 <code>typeof</code> 运算符来实现 <code>isXxxx</code>，我相信绝对不是偶然，一定有啥原因，不过这个原因我目前就不清楚了，希望玉伯能看到这个博客，稍作解释

seajs 只为全局对象 <code>seajs</code> 添加了事件处理。事件的回调函数链保存在 <code>seajs.data.events</code> 中，以事件名称为 key，<code>Array</code> 对象保存的回调函数链为 value。

因为 seajs 的事件主要为了插件而定义，所以对参数并没有严格的校验。比如

<code>// 自定义一个比较奇葩的事件，这不会报错</code>

<code>seajs.on(</code><code>null</code><code>, </code><code>"fake callback"</code><code>);</code>

<code>// 但是执行就会出错了</code>

<code>seajs.emit(</code><code>"null"</code><code>)</code>

<code>// 输出：TypeError: string is not a function</code>

看样子，插件开发者得自己注意下这个问题了。

看完 seajs 的源码，大概定义了这么一些事件

<code>error</code>，貌似跟 NodeJS 有点关系，没仔细看

<code>load</code>，在模块对象状态变成 <code>LOADING</code> 后触发，参数是所有依赖模块的 URI。

<code> </code><code>// Emit `load` event for plugins such as combo plugin</code>

<code> </code><code>var</code> <code>uris = mod.resolve()</code>

<code>exec</code>，在模块对象状态变成 <code>EXECUTED</code> 后触发，参数就是模块对象本身

<code>fetch</code>，在模块对象状态刚变成 <code>FETECHING</code> 时触发，参数是一个临时对象<code>emitData</code>，事件结果保存在 <code>emitData.requestUri</code>，用于后面的 <code>request</code> 请求数据。

<code> </code><code>// Emit `fetch` event for plugins such as combo plugin</code>

<code> </code><code>var</code> <code>emitData = { uri: uri }</code>

<code> </code><code>emit(</code><code>"fetch"</code><code>, emitData)</code>

<code> </code><code>var</code> <code>requestUri = emitData.requestUri || uri</code>

<code>request</code>，在 <code>fetch</code> 事件后对 <code>emitData.requestUri || uri</code> 进行了处理之后，通过 <code>seajs.request()</code> 请求数据之前触发，参数是一个临时对象，变量名复用的 <code>emitData</code>。事件处理完成后根据 <code>emitData.requested</code> 的值来判断是否需要调用 <code>seajs.request</code> 请求数据。

<code> </code><code>// Emit `request` event for plugins such as text plugin</code>

<code> </code><code>emit(</code><code>"request"</code><code>, emitData = {</code>

<code> </code><code>requestUri: requestUri,</code>

<code> </code><code>onRequest: onRequest,</code>

<code> </code><code>charset: isFunction(data.charset)</code>

<code> </code><code>? data.charset(requestUri) || </code><code>'utf-8'</code>

<code> </code><code>: data.charset</code>

<code> </code><code>if</code> <code>(!emitData.requested) {</code>

<code>resolve</code>，在 <code>Module.resolve</code> 中调用 <code>seajs.resolve()</code> 之前触发，参数是一个临时对象 <code>emitData</code>。事件中如果产生了有效的 <code>emitData.uri</code>，则不再调用<code>seajs.resolve()</code>

<code> </code><code>// Emit `resolve` event for plugins such as text plugin</code>

<code> </code><code>var</code> <code>emitData = { id: id, refUri: refUri }</code>

<code> </code><code>emit(</code><code>"resolve"</code><code>, emitData)</code>

<code> </code><code>return</code> <code>emitData.uri || seajs.resolve(emitData.id, refUri)</code>

<code>config</code>，在 <code>seajs.config()</code> 中，完成对 config 对象的处理之后触发，参数就是 config 对象。

<code>seajs.config = </code><code>function</code><code>(configData) {</code>

<code> </code><code>emit(</code><code>"config"</code><code>, configData)</code>

<code> </code><code>return</code> <code>seajs</code>

<code>Module</code> 类才是 seajs 的重头戏，核心的核心。seajs 作为一个模块加载器，所以模块都是以一个 <code>Module</code> 对象保存在 <code>cachedMods</code> 中的。

<code>var</code> <code>cachedMods = seajs.cache = {}</code>

每个模块都有 8 种状态，它一定是在这 8 种状态之一，而且貌似状态改变还是不可逆的。

<code>var</code> <code>STATUS = Module.STATUS = {</code>

<code> </code><code>// 没定义状态值为 0 的状态常量，这是初始状态</code>

<code> </code><code>// 1 - The `module.uri` is being fetched</code>

<code> </code><code>FETCHING: 1,</code>

<code> </code><code>// 2 - The meta data has been saved to cachedMods</code>

<code> </code><code>SAVED: 2,</code>

<code> </code><code>// 3 - The `module.dependencies` are being loaded</code>

<code> </code><code>LOADING: 3,</code>

<code> </code><code>// 4 - The module are ready to execute</code>

<code> </code><code>LOADED: 4,</code>

<code> </code><code>// 5 - The module is being executed</code>

<code> </code><code>EXECUTING: 5,</code>

<code> </code><code>// 6 - The `module.exports` is available</code>

<code> </code><code>EXECUTED: 6,</code>

<code> </code><code>ERROR: 7</code>

其中 <code>SAVED</code> 状态可以理解为 <code>FETCHED</code> 状态。除了初始状态 <code>0</code> 和错误状态 <code>ERROR: 7</code> 之外，其它 6 个状态都是成对出现的，即 <code>ING</code> 状态和 <code>ED</code> 状态，这三对状态清晰的划分出来三个处理过程：fetch、load、exec，对应于模块对象的 3 个方法：<code>fetch()</code>, <code>load()</code>, <code>exec()</code>。

从代码内容来看，这三个主要过程方法主要功能分别可以用一句话说明：

<code>fetch</code>，从 URL 加载模块定义，得到 factory 函数，并将 factory 函数赋值给对应的模块对象（通过 <code>Module.get()</code> 创建或获取）；

<code>load</code>，fetch 并 load 所有依赖模块，并在保证所有依赖模块都是 LOADED 状态之后，调用入口模块（<code>_entry</code>）的 <code>callback</code>（貌似只有通过 <code>seajs.use()</code> 创建的匿名模块才有 <code>callback</code>）

<code>exec</code>，在调用这个方法的时候，可以保证所有依赖模块都已经是 LOADED 状态了，所以 <code>exec</code>就只是简单的执行 factory 函数，并返回 <code>exports</code>。factory 只执行一次，然后将 <code>exports</code> 缓存下来。

现在来看看入口函数 <code>seajs.use()</code>、模块定义函数 <code>define()</code>、模块关系过程处理方法 <code>fetch()</code>,<code>load()</code>, <code>exec()</code> 的主要调用关系：

<code>// seajs.use 只调用了 Module.use，所以它们的调用关系可以看作等同</code>

<code>seajs.use = Module.use = </code><code>function</code><code>() {</code>

<code> </code><code>Module.get()</code>

<code> </code><code>exec() </code><code>// 通过 _entry.callback 调用</code>

<code>define = Module.define = </code><code>function</code><code>() {</code>

<code> </code><code>Module.save(id, factory)</code>

<code>Module.prototype.fetch = </code><code>function</code><code>() {</code>

<code> </code><code>define() </code><code>// 通过 seajs.request() 调用</code>

<code>Module.prototype.load = </code><code>function</code><code>() {</code>

<code> </code><code>fetch()</code>

<code> </code><code>// 结束的条件是 _entry.remain === 1，</code>

<code> </code><code>// 即当前是最后一个依赖模块</code>

<code> </code><code>// 递归结束时调用 _entry.callback，即调用了 exec</code>

<code>Module.prototype.exec = </code><code>function</code><code>() {</code>

<code> </code><code>exec() </code><code>// 通过 define 中定义的 factory 函数调用</code>

<code>Module.prototype.pass = </code><code>function</code><code>() {</code>

<code> </code><code>// 结束条件是把 _entry 传递到最末一层依赖</code>

<code> </code><code>// 递归过程通过 _entry.remain 进行了引用记数</code>

各函数和方法具体处理过程看代码就明白了，因为递归关系有点复杂，还有一些回调关系在里面，所以看起来有点绕，不过还算是看得明白。

本文转自边城__ 51CTO博客，原文链接：http://blog.51cto.com/jamesfancy/1549706，如需转载请自行联系原作者

seajs 3.0.0 源码阅读笔记

继续阅读

主流浏览器四大综合性能测试

JavaScript自学笔记【4】函数的声明与调用目录二、函数的声明三、函数的调用

请求超时VUE axios重新再次请求

nodejs微信开发---授权登录+获取用户信息微信网页授权

debian9升级4.9.0内核到4.19.2内核过程

Javascript构建Bingo卡片游戏

JavaScript的那些坑之事件代理事件代理事件阶段

javascript的for (var i in data)慎用javascript中的for (var i in data)谨慎用

tab鼠标经过菜单切换

vue （vue2.0）使用总结(从大体结构总结)

vue搭建过程及出现问题

/\B(?=(?:\d{3})+$)/g 一条令人费解的正则表达式

适用于JavaScript的ECMAScript 2020规范向前发展

JS生成uuid的四种方法

layui多任务上传添加进度条