Sea.js 是一个成熟的开源项目,核心目标是给前端开发提供简单、极致的模块化开发体验。使用 Sea.js,在书写文件时,需要遵守 CMD (Common Module Definition)模块定义规范。一个文件就是一个模块。以下面的例子简单对Sea.js的使用做一个描述:
注意:在页面中想要使用某个组件时,只要通过seajs.use()方法调用。
使用Sea.js进行模块化开发的优点主要是以下几点:
1.解决了命名冲突和依赖管理;
2.模块的版本管理(通过别名的配置,加上构建工具,实现模块的版本管理);
3.提高可维护性(模块化使得Sea.js职责单一,利于代码维护,此外还拥有代码调试和一些方便高效的nocache、debug插件);
4.前端性能优化(异步加载模块,优化页面性能);
5.跨环境共享模块(通过 Sea.js 的 Node.js 版本,可以很方便实现模块的跨服务器和浏览器共享)
Sea.js的一些常用API:
seajs.config 用来配置Sea.js
seajs.use 用来加载一个或多个模块
// 加载一个模块
seajs.use('./a');
// 加载一个模块,在加载完成时,执行回调
seajs.use('./a', function(a) {
a.doSomething();
});
// 加载多个模块,在加载完成时,执行回调
seajs.use(['./a', './b'], function(a, b) {
a.doSomething();
b.doSomething();
});
define 用来定义模块
define(function(require, exports, module) { // 模块代码});
注意:require , export, module三个参数可以不全存在。
require 用来获取模块
require.async 用来在模块内部异步加载一个或多个模块
exports 用来在模块内部对外提供接口
module.exports 与exports类似,用来在模块内部对外提供接口
CMD 模块定义规范
define Function 是一个全局函数,用来定义模块
define define(factory)
define 接受 factory 参数,factory 可以是一个函数,也可以是一个对象或字符串。如果是一个函数的话,表示是模块的构造方法,执行该构造方法可以得到模块向外提供的接口。factory 方法在执行时,默认会传入三个参数:require、exports 和 module:
define(function(require, exports, module) { // 模块代码});
define.cmd Object
一个空对象,可用来判定当前页面是否有 CMD 模块加载器:
if (typeof define === "function" && define.cmd) { // 有 Sea.js 等 CMD 模块加载器存在}
模块标识
模块标识是一个字符串,用来标识模块。在 require、 require.async 等加载函数中,第一个参数都是模块标识。
Sea.js 中的模块标识是 CommonJS 模块标识 的超集:
1.一个模块标识由斜线(/)分隔的多项组成。
2.每一项必须是小驼峰字符串、 . 或 .. 。
3.模块标识可以不包含文件后缀名,比如 .js 。
4.模块标识可以是 相对 或 顶级 标识。如果第一项是 . 或 ..,则该模块标识是相对标识。
5.顶级标识根据模块系统的基础路径来解析,相对标识相对 require 所在模块的路径来解析。
注意,符合上述规范的标识肯定是 Sea.js 的模块标识,但 Sea.js 能识别的模块标识不需要完全符合以上规范。 比如,除了大小写字母组成的小驼峰字符串,Sea.js 的模块标识字符串还可以包含下划线(_)和连字符(-), 甚至可以是 http://、https://、file:/// 等协议开头的绝对路径。