seajs的使用

最近花了一点时间对seajs进行了了解。

一、seajs

seajs是cmd(Common Module Definition)的模块加载框架,说白了就是在前端开发中

如何定义一个js文件,如何在项目中引入这个js文件。

二、基于cmd就对cmd进行了解

1、cmd是一种模块定义的规范

常使用的 API 只有 define, require, require.async, exports,module.exports 这五个

2、这个规范的内容是什么?参考:https://github.com/seajs/seajs/issues/242

在 CMD 规范中,一个模块就是一个文件。代码的书写格式如下:

define(factory);

define Function

define 是一个全局函数,用来定义模块。

define define(factory)

define 接受 factory 参数,factory 可以是一个函数,也可以是一个对象或字符串。

factory 为对象、字符串时,表示模块的接口就是该对象、字符串。比如可以如下定义一个 JSON 数据模块:

define({"foo":"bar"});

也可以通过字符串定义模板模块:

define('I am a template. My name is {{name}}.');

factory 为函数时,表示是模块的构造方法。执行该构造方法,可以得到模块向外提供的接口。factory 方法在执行时,默认会传入三个参数:require、exports 和 module:

define(function(require,exports,module) {//模块代码});

define define(id?, deps?, factory)

define 也可以接受两个以上参数。字符串 id 表示模块标识,数组 deps 是模块依赖。比如:

define('hello', ['jquery'],function(require,exports,module) {//模块代码});

id 和 deps 参数可以省略。省略时,可以通过构建工具自动生成。

注意:带 id 和 deps 参数的 define 用法不属于 CMD 规范,而属于 Modules/Transport 规范。

define.cmd Object

一个空对象,可用来判定当前页面是否有 CMD 模块加载器:

if(typeofdefine==="function"&&define.cmd) {//有 Sea.js 等 CMD 模块加载器存在}

require Function

require 是 factory 函数的第一个参数。

require require(id)

require 是一个方法,接受 模块标识 作为唯一参数,用来获取其他模块提供的接口。

define(function(require,exports) {//获取模块 a 的接口vara=require('./a');//调用模块 a 的方法a.doSomething();});

注意:在开发时,require 的书写需要遵循一些 简单约定

require.async require.async(id, callback?)

require.async 方法用来在模块内部异步加载模块,并在加载完成后执行指定回调。callback 参数可选。

define(function(require,exports,module) {//异步加载一个模块,在加载完成时,执行回调require.async('./b',function(b) {b.doSomething();  });//异步加载多个模块,在加载完成时,执行回调require.async(['./c','./d'],function(c,d) {c.doSomething();d.doSomething();  });});

注意:require 是同步往下执行,require.async 则是异步回调执行。require.async 一般用来加载可延迟异步加载的模块。

require.resolve require.resolve(id)

使用模块系统内部的路径解析机制来解析并返回模块路径。该函数不会加载模块,只返回解析后的绝对路径。

define(function(require,exports) {console.log(require.resolve('./b'));//==> http://example.com/path/to/b.js});

这可以用来获取模块路径,一般用在插件环境或需动态拼接模块路径的场景下。

exports Object

exports 是一个对象,用来向外提供模块接口。

define(function(require,exports) {//对外提供 foo 属性exports.foo='bar';//对外提供 doSomething 方法exports.doSomething=function() {};});

除了给 exports 对象增加成员,还可以使用 return 直接向外提供接口。

define(function(require) {//通过 return 直接提供接口return{    foo:'bar',doSomething:function() {}  };});

如果 return 语句是模块中的唯一代码,还可简化为:

define({  foo:'bar',doSomething:function() {}});

上面这种格式特别适合定义 JSONP 模块。

特别注意:下面这种写法是错误的!

define(function(require,exports) {//错误用法!!!exports={    foo:'bar',doSomething:function() {}  };});

正确的写法是用 return 或者给 module.exports 赋值:

define(function(require,exports,module) {//正确写法module.exports={    foo:'bar',doSomething:function() {}  };});

提示:exports 仅仅是 module.exports 的一个引用。在 factory 内部给 exports 重新赋值时,并不会改变 module.exports 的值。因此给 exports 赋值是无效的,不能用来更改模块接口。

module Object

module 是一个对象,上面存储了与当前模块相关联的一些属性和方法。

module.id String

模块的唯一标识。

define('id', [],function(require,exports,module) {//模块代码});

上面代码中,define 的第一个参数就是模块标识。

module.uri String

根据模块系统的路径解析规则得到的模块绝对路径。

define(function(require,exports,module) {console.log(module.uri);//==> http://example.com/path/to/this/file.js});

一般情况下(没有在 define 中手写 id 参数时),module.id 的值就是 module.uri,两者完全相同。

module.dependencies Array

dependencies 是一个数组,表示当前模块的依赖。

module.exports Object

当前模块对外提供的接口。

传给 factory 构造方法的 exports 参数是 module.exports 对象的一个引用。只通过 exports 参数来提供接口,有时无法满足开发者的所有需求。 比如当模块的接口是某个类的实例时,需要通过 module.exports来实现:

define(function(require,exports,module) {//exports 是 module.exports 的一个引用console.log(module.exports===exports);//true//重新给 module.exports 赋值module.exports=newSomeClass();//exports 不再等于 module.exportsconsole.log(module.exports===exports);//false});

注意:对 module.exports 的赋值需要同步执行,不能放在回调函数里。下面这样是不行的:

//x.jsdefine(function(require,exports,module) {//错误用法setTimeout(function() {module.exports={ a:"hello"};  },0);});

在 y.js 里有调用到上面的 x.js:

//y.jsdefine(function(require,exports,module) {varx=require('./x');//无法立刻得到模块 x 的属性 aconsole.log(x.a);//undefined});

三、seajs使用定义好的模块

1、引入seajs

在文件夹中放入seajs,相关的html页面引入

<script type="text/javascript" src="yourfile/js/sea.js" ></script>

2、seajs经常使用的api有use,config

seajs.use

seajs.use主要用于载入入口模块。入口模块相当于C语言的main函数,同时也是整个模块依赖树的根。seajs.use

的用法如下:

//第一模式

seajs.use('./a');

//回调模式

seajs.use('./a',function(a){    a.run();})

//多模块模式

seajs.use(['./a','./b'],function(a,b){  

  a.run();   

  b.run();

})

seajs.config({

    base:'path',

alias:{

    'app':'path/app/'

},

charset:'utf-8',

timeout:20000,

debug:false})

base表示基址路径

alias可以对较长的常用路径设置缩写

charset表示下载js时script标签的charset属性。

timeout表示下载文件的最大时长,以毫秒为单位。


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

推荐阅读更多精彩内容

  • 为什么要使用模块化? 最主要的目的: 解决命名冲突 依赖管理 其他价值 提高代码可读性 代码解耦,提高复用性 CM...
    JamHsiao_aaa4阅读 353评论 0 1
  • 前端JS模块化开发有两大规范AMD合CMD,下面以我的理解来简单总结一下模块化开发的思想 ,以及js前端常用的AM...
    三寸日光_阅读 391评论 0 0
  • 随着前端业务复杂度的增加,模块化成为一个大的趋势。而在ES6还未被浏览器所支持的情况下,commonjs作为ES6...
    吴高亮阅读 1,038评论 0 3
  • 模块通常是指编程语言所提供的代码组织机制,利用此机制可将程序拆解为独立且通用的代码单元。所谓模块化主要是解决代码分...
    MapleLeafFall阅读 1,148评论 0 0
  • 为什么使用 Sea.js ? Sea.js 追求简单、自然的代码书写和组织方式,具有以下核心特性: 简单友好的模块...
    yangjiahao阅读 901评论 0 1