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 相关文章推荐
封装好的省市地区联动控件附下载
Aug 13 Javascript
用dom+xhtml+css制作的一个相册效果代码打包下载
Jan 24 Javascript
JS location几个方法小姐
Jul 09 Javascript
jQuery autocomplete插件修改
Apr 17 Javascript
jquery如何扑捉回车键触发的事件
Apr 24 Javascript
JavaScript Array对象详解
Mar 01 Javascript
如何用js实现鼠标向上滚动时浮动导航
Jul 18 Javascript
Echarts基本用法_动力节点Java学院整理
Aug 11 Javascript
详解angularJS+Ionic移动端图片上传的解决办法
Sep 13 Javascript
推荐10款扩展Web表单的JS插件
Dec 25 Javascript
jquery使用FormData实现异步上传文件
Oct 25 jQuery
爬虫利器Puppeteer实战
Jan 09 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实现Mysql读写分离
2013/06/28 PHP
用PHP代码给图片加水印
2015/07/01 PHP
php实现压缩合并js的方法【附demo源码下载】
2016/09/22 PHP
通过 Dom 方法提高 innerHTML 性能
2008/03/26 Javascript
javascript iframe中打开文件,并检测iframe存在否
2008/12/28 Javascript
jquery插件制作简单示例说明
2012/02/03 Javascript
jQuery之$(document).ready()使用介绍
2012/04/05 Javascript
javascript for循环从入门到偏门(效率优化+奇特用法)
2012/08/01 Javascript
javascript判断移动端访问设备并解析对应CSS的方法
2015/02/05 Javascript
jQuery实现文本展开收缩特效
2015/06/03 Javascript
jQuery的Ajax用户认证和注册技术实例教程(附demo源码)
2015/12/08 Javascript
jQuery基础知识点总结(必看)
2016/05/31 Javascript
超全面的vue.js使用总结
2017/02/12 Javascript
微信小程序 setData的使用方法详解
2017/04/20 Javascript
Vue.js与 ASP.NET Core 服务端渲染功能整合
2017/11/16 Javascript
微信小程序使用video组件播放视频功能示例【附源码下载】
2017/12/08 Javascript
vuex 使用文档小结篇
2018/01/11 Javascript
Vue2.5 结合 Element UI 之 Table 和 Pagination 组件实现分页功能
2018/01/26 Javascript
countUp.js实现数字滚动效果
2019/10/18 Javascript
在pycharm中开发vue的方法步骤
2020/03/04 Javascript
vue路由跳转传递参数的方式总结
2020/05/10 Javascript
vue同个按钮控制展开和折叠同个事件操作
2020/07/29 Javascript
分享15个最受欢迎的Python开源框架
2014/07/13 Python
python实现多线程网页下载器
2018/04/15 Python
python将.ppm格式图片转换成.jpg格式文件的方法
2018/10/27 Python
Python数据预处理之数据规范化(归一化)示例
2019/01/08 Python
python支持多线程的爬虫实例
2019/12/21 Python
HTML5单页面手势滑屏切换原理
2016/03/21 HTML / CSS
同事打架检讨书
2014/02/04 职场文书
学生会感恩节活动方案
2014/10/11 职场文书
2014幼儿园班主任工作总结
2014/12/04 职场文书
试用期辞职信范文
2015/03/02 职场文书
感恩节寄语2015
2015/03/24 职场文书
社区文明倡议书
2015/04/28 职场文书
谢师宴家长答谢词
2015/09/30 职场文书
laravel添加角色和模糊搜索功能的实现代码
2021/06/22 PHP