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实现单击图片放大图片的方法
Feb 17 Javascript
JavaScript用select实现日期控件
Jul 17 Javascript
javascript实现自动填写表单实例简析
Dec 02 Javascript
jquery中取消和绑定hover事件的实现代码
Jun 02 Javascript
记录一篇关于redux-saga的基本使用过程
Aug 18 Javascript
jQuery超简单遮罩层实现方法示例
Sep 06 jQuery
Vue 实现html中根据类型显示内容
Oct 28 Javascript
JavaScript判断浏览器版本的方法
Nov 03 Javascript
React中使用UMEditor的方法示例
Dec 27 Javascript
vue.js实现双击放大预览功能
Jun 23 Javascript
Vue实现穿梭框效果
Sep 30 Javascript
vue项目如何打包之项目打包优化(让打包的js文件变小)
Apr 30 Vue.js
使用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中实现接收多个name相同但Value不相同表单数据实例
2015/02/03 PHP
PHP实现HTML页面静态化的方法
2015/11/04 PHP
PHP里面把16进制的图片数据显示在html的img标签上(实现方法)
2017/05/02 PHP
php面向对象程序设计入门教程
2019/06/22 PHP
Prototype使用指南之dom.js
2007/01/10 Javascript
基于jQuery的表格操作插件
2010/04/22 Javascript
理解Javascript_09_Function与Object
2010/10/16 Javascript
IE下使用jQuery重置iframe地址时内存泄露问题解决办法
2015/02/05 Javascript
Three.js学习之Lamber材质和Phong材质
2016/08/04 Javascript
IntersectionObserver API 详解篇
2016/12/11 Javascript
JS得到当前时间的方法示例
2017/03/24 Javascript
vue系列之动态路由详解【原创】
2017/09/10 Javascript
Node.js readline 逐行读取、写入文件内容的示例
2018/03/01 Javascript
javascript使用正则实现去掉字符串前面的所有0
2018/07/23 Javascript
vue调用语音播放的方法
2019/09/27 Javascript
[04:47]DOTA2-潍坊风行电子俱乐部探秘
2014/08/08 DOTA
[01:04:05]VG vs Newbee 2018国际邀请赛小组赛BO2 第一场 8.17
2018/08/20 DOTA
Python常用模块介绍
2014/11/21 Python
把项目从Python2.x移植到Python3.x的经验总结
2015/04/20 Python
python UNIX_TIMESTAMP时间处理方法分析
2016/04/18 Python
python OpenCV学习笔记实现二维直方图
2018/02/08 Python
python引入不同文件夹下的自定义模块方法
2018/10/27 Python
python实现K近邻回归,采用等权重和不等权重的方法
2019/01/23 Python
Python3.4学习笔记之常用操作符,条件分支和循环用法示例
2019/03/01 Python
python3实现猜数字游戏
2020/12/07 Python
linux下python中文乱码解决方案详解
2019/08/28 Python
tensorflow 实现数据类型转换
2020/02/17 Python
python 实用工具状态机transitions
2020/11/21 Python
如何手工释放资源
2013/12/15 面试题
优秀共产党员先进事迹材料
2014/05/06 职场文书
2014年班长个人工作总结
2014/11/14 职场文书
七年级生物教学反思
2016/02/20 职场文书
四年级语文教学反思
2016/03/03 职场文书
PHP判断是否是json字符串
2021/04/01 PHP
详解MySQL集群搭建
2021/05/26 MySQL
springboot 多数据源配置不生效遇到的坑及解决
2021/11/17 Java/Android