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 相关文章推荐
JavaScript 继承详解 第一篇
Aug 30 Javascript
jQuery Ajax之$.get()方法和$.post()方法
Oct 12 Javascript
利用原生JavaScript获取元素样式只是获取而已
Oct 08 Javascript
Perl Substr()函数及函数的应用
Dec 16 Javascript
JS根据浏览器窗口大小实时动态改变网页文字大小的方法
Feb 25 Javascript
bootstrap datetimepicker日期插件超详细使用方法介绍
Feb 23 Javascript
老生常谈js中0到底是 true 还是 false
Mar 08 Javascript
Vue2.0用户权限控制解决方案
Nov 29 Javascript
JS中使用textPath实现线条上的文字
Dec 25 Javascript
微信小程序wx.uploadfile 本地文件转base64的实现代码
Jun 28 Javascript
Windows上node.js的多版本管理工具用法实例分析
Nov 06 Javascript
Vue2.x和Vue3.x的双向绑定原理详解
Nov 05 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
PHP 自定义错误处理函数的使用详解
2013/05/10 PHP
PHP URL路由类实例
2013/11/12 PHP
php去除字符串中空字符的常用方法小结
2015/03/17 PHP
laravel框架select2多选插件初始化默认选中项操作示例
2020/02/18 PHP
通过javascript的匿名函数来分析几段简单有趣的代码
2010/06/29 Javascript
JavaScript flash复制库类 Zero Clipboard
2011/01/17 Javascript
THREE.JS入门教程(3)着色器-下
2013/01/24 Javascript
判断一个对象是否为jquery对象的方法
2014/03/12 Javascript
JQuery简单实现锚点链接的平滑滚动
2015/05/03 Javascript
jQuery ui autocomplete选择列表被Bootstrap模态窗遮挡的完美解决方法
2016/09/23 Javascript
微信小程序 使用腾讯地图SDK详解及实现步骤
2017/02/28 Javascript
jQuery插件zTree实现删除树节点的方法示例
2017/03/08 Javascript
JS实现静态页面搜索并高亮显示功能完整示例
2017/09/19 Javascript
JavaScript数据结构之双向链表定义与使用方法示例
2017/10/27 Javascript
JS简单生成由字母数字组合随机字符串示例
2018/05/25 Javascript
node.js自动上传ftp的脚本分享
2018/06/16 Javascript
JavaScript实现好看的跟随彩色气泡效果
2020/02/06 Javascript
JS实现电脑虚拟键盘的操作
2020/06/24 Javascript
详解微信小程序(Taro)手动埋点和自动埋点的实现
2021/03/02 Javascript
[03:00]2018完美盛典_最佳英雄奖
2018/12/17 DOTA
python保存字符串到文件的方法
2015/07/01 Python
Python+selenium实现截图图片并保存截取的图片
2018/01/05 Python
Python通过Tesseract库实现文字识别
2020/03/05 Python
python3.7 openpyxl 在excel单元格中写入数据实例
2020/09/01 Python
重构Python代码的六个实例
2020/11/25 Python
纯css实现照片墙3D效果的示例代码
2017/11/13 HTML / CSS
Giglio美国站:意大利奢侈品购物网
2018/02/10 全球购物
英国健身仓库:Bodybuilding Warehouse
2019/03/06 全球购物
馥蕾诗美国官网:Fresh美国
2019/10/09 全球购物
颁奖典礼主持词
2014/03/25 职场文书
《与朱元思书》的教学反思
2014/04/17 职场文书
优秀教师推荐材料
2014/12/16 职场文书
公务员考察材料范文
2014/12/23 职场文书
导游词之清晏园
2019/11/22 职场文书
MySQL kill不掉线程的原因
2021/05/07 MySQL
nginx负载功能+nfs服务器功能解析
2022/02/28 Servers