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 相关文章推荐
复制本贴标题和地址的js代码
Jul 01 Javascript
一个报数游戏js版(约瑟夫环问题)
Aug 05 Javascript
关于 文本框默认值 的操作js代码
Jan 12 Javascript
json格式的时间显示为正常年月日的方法
Sep 08 Javascript
javascript模拟枚举的简单实例
Mar 06 Javascript
浅析javascript中的DOM
Mar 01 Javascript
js仿iphone秒表功能 计算平均数
Jan 11 Javascript
在vue2.0中引用element-ui组件库的方法
Jun 21 Javascript
vue两个组件间值的传递或修改方式
Jul 04 Javascript
js实现指定时间倒计时效果
Aug 26 Javascript
JavaScript实现文件下载并重命名代码实例
Dec 12 Javascript
Angular单元测试之事件触发的实现
Jan 20 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用正则表达式匹配URL的简单方法
2013/11/12 PHP
异步加载技术实现当滚动条到最底部的瀑布流效果
2014/09/16 PHP
19个Android常用工具类汇总
2014/12/30 PHP
PHP 并发场景的几种解决方案
2019/06/14 PHP
让whoops帮我们告别ThinkPHP6的异常页面
2020/03/02 PHP
laravel入门知识点整理
2020/09/15 PHP
jquery tab标签页的制作
2010/05/10 Javascript
仿猪八戒网左下角的文字滚动效果
2011/10/28 Javascript
纯javascript移动优先的幻灯片效果
2015/11/02 Javascript
微信小程序 Audio API详解及实例代码
2016/09/30 Javascript
js字符串操作总结(必看篇)
2016/11/22 Javascript
js基于FileSaver.js 浏览器导出Excel文件的示例
2017/08/15 Javascript
jQuery中内容过滤器简单用法示例
2018/03/31 jQuery
React SSR样式及SEO的实践
2018/10/22 Javascript
微信小程序中遇到的iOS兼容性问题小结
2018/11/14 Javascript
bootstrap table实现合并单元格效果
2018/12/24 Javascript
基于node简单实现RSA加解密的方法步骤
2019/03/21 Javascript
ZK中使用JS读取客户端txt文件内容问题
2019/11/07 Javascript
js实现带有动画的返回顶部
2020/08/09 Javascript
python 生成不重复的随机数的代码
2011/05/15 Python
windows 下python+numpy安装实用教程
2017/12/23 Python
Python 记录日志的灵活性和可配置性介绍
2018/02/27 Python
Python使用numpy实现BP神经网络
2018/03/10 Python
Python2.7.10以上pip更新及其他包的安装教程
2018/06/12 Python
Python同步遍历多个列表的示例
2019/02/19 Python
Python Tornado之跨域请求与Options请求方式
2020/03/28 Python
Python能做什么
2020/06/02 Python
吃透移动端 1px的具体用法
2019/12/16 HTML / CSS
Photobook澳大利亚:制作相片书,婚礼卡,旅行相簿
2017/01/12 全球购物
如果让你测试一台高速激光打印机,你都会进行哪些测试
2012/12/04 面试题
机关门卫制度
2014/02/01 职场文书
文艺晚会策划方案
2014/06/11 职场文书
公司委托书怎么写
2014/08/02 职场文书
抗洪救灾感谢信
2015/01/22 职场文书
再也不用花钱买漫画!Python爬取某漫画的脚本及源码
2021/06/09 Python
了解MySQL查询语句执行过程(5大组件)
2022/08/14 MySQL