seaJs的模块定义和模块加载浅析


Posted in Javascript onJune 06, 2014

SeaJS 是由玉伯开发的一个遵循 CommonJS 规范的模块加载框架,可用来轻松愉悦地加载任意 JavaScript 模块和css模块样式。SeaJS非常小巧,小巧在于压缩和gzip后体积只有4K,而且接口和方法也非常少,SeaJS 就两个核心:模块定义和 模块的加载及依赖关系。SeaJS非常强大,SeaJS可以加载任意 JavaScript 模块和css模块样式,SeaJS会保证你在使用一个模块时,已经将所依赖的其他模块载入到脚本运行环境中。玉伯的说法,SeaJS可以让你享受写代码的乐趣,不用去管那些加载的问题。你是否厌倦了如此多的js和css引用,我数了一下我们公司网站的个人主页首页上有39个css和js引用,带来的影响可想而知:

1.不利于维护,前端后端都一样
2.http请求过多,当然这个可以通过合并解决,但是如果没有后端直接合并,人工成本非常大,就算后端合并,维护的时候,这么长的一个字符串,眼睛肯定看花

用SeaJS就能非常好的解决这些问题。

模块的定义define

定义一个模块比较简单,例如定义一个sayHello模块,建一个sayHello.js文档:

define(function(require,exports,module){
 exports.sayHello = function(eleID,text) {
  document.getElementById(eleID).innerHTML=text;
 };
});

这里先看一下exports参数,exports参数是用来向外提供模块的 API.也就是通过这个exports其他的模块就能访问sayHello方法。

模块的加载use

例如我们页面上有一个id为“out”的元素,要输出“Hello SeaJS!”,
那么我们可以先引入sea.js
然后使用sayHello模块:

seajs.use("sayHello/sayHello",function(say){
 say.sayHello("out","Hello SeaJS!");
});

这里的use就是使用模块的方法:

第一个参数就是模块表示,他是相对于sea.js的相对路径来表示,sayHello.js后面的“.js”后缀可以省略,当然这个模块标识还有很多方法,具体查看官方说明:http://seajs.com/docs/zh-cn/module-identifier.html
第一个参数是一个callback函数。say.sayHello()就是调用sayHello模块的exports.sayHello方法,当然这callback函数中有个say参数。

模块的依赖关系

模块的依赖其实在模块定义的时候就应该存在了。比如说把上面的sayHello模块改写一下,假设我们已经有了一个通用的DOM模块,比如一些获取元素,设置样式等方法,例如这么一个DOM模块,如下编写DOM.js

define(function(require, exports, module) {
    var DOM = {
        /**
* 通过元素的id属性获取DOM对象,参数为字符串,或多个字符串
* @id getById
* @method getById
* @param {String} id the id attribute
* @return {HTMLElement | Object} The HTMLElement with the id, or null if none found.
*/
        getById: function() {
            var els = [];
            for (var i = 0; i < arguments.length; i++) {
                var el = arguments[i];
                if (typeof el == "string") {
                    el = document.getElementById(el);
                }
                if (arguments.length == 1) {
                    return el;
                }
                els.push(el);
            }
            return els;
        },
        /**
* get 获取对象,可以传入对象或字符串,如果传入字符串者以document.getElementById()的方式获取对象
* @id get
* @param {String} el html element
* @return {Object} HTMLElement object.
*/
        get: function(el) {
            if (el & amp; amp; amp; & amp; amp; amp; (el.tagName || el.item)) {
                return el;
            }
            return this.getById(el);
        }
    };
    return DOM;
});

那么sayHello模块可以这样编写,为了不影响原来的demo页面,所以我定一个新的sayHelloA模块,我们可以这样编写sayHelloA.js:
define(function(require, exports, module) {
    var DOM = require("DOM/DOM");
    require("sayHelloA/sayHello.css");
    exports.sayHello = function(eleID, text) {
        DOM.get(eleID).innerHTML = text;
    };
});

require 函数就是用来建立模块的依赖关系,比如上面sayHelloA模块,就是依赖于DOM模块,因为用到了DOM模块的get方法。
注意这里的var DOM=require("DOM/DOM"),这句是将应用进来的DOM模块赋值给DOM;require("sayHelloA/sayHello.css")是直接应用sayHello.css css模块或者说文件。这样页面上会引用这个css文件。

最近这几天一直捣腾SeaJS,越捣腾越喜欢,感谢玉伯!感谢SeaJS!当然你可能觉得这么简单的几个实例没必要这么做。确实如果js文件少的小项目感觉不错模块化的优势,但是,更多的在js文件多或着中型以上项目这个模块化的优势就体现出来了。

Javascript 相关文章推荐
兼容Mozilla必须知道的知识。
Jan 09 Javascript
fix-ie5.js扩展在IE5下不能使用的几个方法
Aug 20 Javascript
asp.net下使用jquery 的ajax+WebService+json 实现无刷新取后台值的实现代码
Sep 19 Javascript
根据经纬度计算地球上两点之间的距离js实现代码
Mar 05 Javascript
浅谈Javascript中的函数、this以及原型
Oct 09 Javascript
jquery.masonry瀑布流效果
May 25 jQuery
Angular中响应式表单的三种更新值方法详析
Aug 22 Javascript
利用纯js + transition动画实现移动端web轮播图详解
Sep 10 Javascript
浅谈JavaScript find 方法不支持IE的问题
Sep 28 Javascript
JS实现的透明度渐变动画效果示例
Apr 28 Javascript
浅谈redux, koa, express 中间件实现对比解析
May 23 Javascript
Vue.js标签页组件使用方法详解
Oct 19 Javascript
使用GruntJS构建Web程序之Tasks(任务)篇
Jun 06 #Javascript
javascript中加号(+)操作符的一些神奇作用
Jun 06 #Javascript
使用GruntJS构建Web程序之合并压缩篇
Jun 06 #Javascript
Javascript动态引用CSS文件的2种方法介绍
Jun 06 #Javascript
jquery 隐藏与显示tr标签示例代码
Jun 06 #Javascript
Node.js中对通用模块的封装方法
Jun 06 #Javascript
JavaScript中对循环语句的优化技巧深入探讨
Jun 06 #Javascript
You might like
在WordPress中实现评论头像的自定义默认和延迟加载
2015/11/24 PHP
Docker 如何布置PHP开发环境
2016/06/21 PHP
yii2.0框架使用 beforeAction 防非法登陆的方法分析
2019/09/11 PHP
检测是否已安装 .NET Framework 3.5的js脚本
2009/02/14 Javascript
javscript对象原型的一些看法
2010/09/19 Javascript
载入jQuery库的最佳方法详细说明及实现代码
2012/12/28 Javascript
JS中for循序中延迟加载动态效果的具体实现
2013/08/18 Javascript
js的正则test,match,exec详细解析
2014/01/29 Javascript
js判断undefined类型示例代码
2014/02/10 Javascript
Vue.js实战之组件的进阶
2017/04/04 Javascript
nodejs爬虫遇到的乱码问题汇总
2017/04/07 NodeJs
使用jQuery ajaxupload插件实现无刷新上传文件
2017/04/23 jQuery
react native带索引的城市列表组件的实例代码
2017/08/08 Javascript
Bootstrap Table快速完美搭建后台管理系统
2017/09/20 Javascript
Angular弹出模态框的两种方式
2017/10/19 Javascript
新年快乐! javascript实现超级炫酷的3D烟花特效
2019/01/30 Javascript
Vue2.0实现简单分页及跳转效果
2019/07/29 Javascript
JS简单表单验证功能完整示例
2020/01/26 Javascript
Vue在H5 项目中使用融云进行实时个人单聊通讯
2020/12/14 Vue.js
python实现多线程网页下载器
2018/04/15 Python
Python 控制终端输出文字的实例
2019/07/12 Python
Python统计分析模块statistics用法示例
2019/09/06 Python
numpy 返回函数的上三角矩阵实例
2019/11/25 Python
Pytorch实现LSTM和GRU示例
2020/01/14 Python
基于python3生成标签云代码解析
2020/02/18 Python
解决python父线程关闭后子线程不关闭问题
2020/04/25 Python
Pycharm 解决自动格式化冲突的设置操作
2021/01/15 Python
The Hut德国站点:时装、家居用品、美容等
2016/09/23 全球购物
英国最大的宠物商店:Pets at Home
2019/04/17 全球购物
工程部主管岗位职责
2013/11/17 职场文书
垃圾桶标语
2014/06/24 职场文书
环境卫生倡议书
2014/08/29 职场文书
领导干部“四风”查摆问题个人整改措施
2014/10/28 职场文书
教学质量月活动总结
2015/05/11 职场文书
2015年副班长工作总结
2015/05/15 职场文书
2016关于预防职务犯罪的心得体会
2016/01/21 职场文书