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 OOP类与继承
Nov 15 Javascript
百度地图api应用标注地理位置信息(js版)
Feb 01 Javascript
jQuery实现鼠标滑过Div层背景变颜色的方法
Feb 17 Javascript
AngularJS身份验证的方法
Feb 17 Javascript
jQuery实现为LI列表前3行设置样式的方法【2种方法】
Sep 04 Javascript
微信小程序富文本渲染引擎的详解
Sep 30 Javascript
vue.js实现简单轮播图效果
Oct 10 Javascript
vue中rem的配置的方法示例
Aug 30 Javascript
详解vue文件中使用echarts.js的两种方式
Oct 18 Javascript
vue项目移动端实现ip输入框问题
Mar 19 Javascript
小程序双头slider选择器的实现示例
Mar 31 Javascript
vue-cli3中配置alias和打包加hash值操作
Sep 04 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中ob(Output Buffer 输出缓冲)函数使用方法
2007/07/21 PHP
PHP使用Curl实现模拟登录及抓取数据功能示例
2018/04/27 PHP
php curl简单采集图片生成base64编码(并附curl函数参数说明)
2019/02/15 PHP
如何在Laravel5.8中正确地应用Repository设计模式
2019/11/26 PHP
google地图的路线实现代码
2009/08/20 Javascript
jquery 插件开发 extjs中的extend用法小结
2013/01/04 Javascript
js中方法重载如何实现?以及函数的参数问题
2013/08/01 Javascript
jquery清空表单数据示例分享
2014/02/13 Javascript
JavaScript模拟push
2016/03/06 Javascript
JavaScript中setTimeout和setInterval函数的传参及调用
2016/03/11 Javascript
js实现一个猜数字游戏
2017/03/31 Javascript
React Native 集成jpush-react-native的示例代码
2017/08/16 Javascript
js指定日期增加指定月份的实现方法
2018/12/19 Javascript
flexible.js实现移动端rem适配方案
2020/04/07 Javascript
ant-design-vue中tree增删改的操作方法
2020/11/03 Javascript
Python编程之微信推送模板消息功能示例
2017/08/21 Python
Python中执行存储过程及获取存储过程返回值的方法
2017/10/07 Python
django项目搭建与Session使用详解
2018/10/10 Python
浅谈Python 列表字典赋值的陷阱
2019/01/20 Python
PyQt4编程之让状态栏显示信息的方法
2019/06/18 Python
Django 缓存配置Redis使用详解
2019/07/23 Python
Python使用selenium + headless chrome获取网页内容的方法示例
2019/10/16 Python
Python箱型图处理离群点的例子
2019/12/09 Python
django使用JWT保存用户登录信息
2020/04/22 Python
PyQt5实现登录页面
2020/05/30 Python
CSS3属性background-size使用指南
2014/12/09 HTML / CSS
杭州SQL浙江浙大网新恩普软件有限公司
2013/07/27 面试题
三维科技面试题
2013/07/27 面试题
幼儿园庆六一游园活动方案
2014/01/29 职场文书
质量月口号
2014/06/20 职场文书
领导干部个人整改措施落实情况汇报
2014/10/29 职场文书
十二生肖观后感
2015/06/12 职场文书
2016元旦文艺汇演主持词
2015/07/06 职场文书
2016年端午节红领巾广播稿
2015/12/18 职场文书
《初涉尘世》读后感3篇
2020/01/10 职场文书
详解Python描述符的工作原理
2021/06/11 Python