Javascript的一种模块模式


Posted in Javascript onSeptember 08, 2010

Douglas Crockford已经传授了一个有用的单例模式(singleton pattern)实现此规则,我认为他的模式有益于你基于YUI的那些应用。Douglas叫它模块模式(module pattern)。它是如下工作的:
1、创建一个命名空间对象:如果你使用YUI,可以用YAHOO.namespace()方法: YAHOO.namespace("myProject");这分配了一个空的myProject对象,是YAHOO的一个成员(如 果myProject已存在的话,则不会被覆盖)。现在我们可以开始添加YAHOO.myProject的成员。
2、对你的命名空间对象分配一个匿名函数返回值:

YAHOO.myProject.myModule = function () { 
return { 
myPublicProperty: "我作为YAHOO.myProject.myModule.myPublicProperty被访问。"; 
myPublicMethod: function () { 
YAHOO.log("我作为YAHOO.myProject.myModule.myPublicMethod被访问。"); 
} 
}; 
}(); // 这个括号导致匿名函数被执行且返回

注意有闭合大括号和紧接着的括号()的最后一行—这种符号导致了匿名函数的立即执行,返回包含myPublicProperty和myPublicMethod的对象。只要这个匿名函数一返回,返回对象就作为YAHOO.myProject.myModule被访问。
3、在匿名函数中,在返回语句前加入“私有”方法和变量。到目前为止,我们只是将myPublicProperty和myPublicMethod直接分配到YAHOO.myProject.myModule中。此外,当我们在返回语句之前放置一些代码时,这个模式还支持被增加的效用。
YAHOO.myProject.myModule = function () { 
//“私有”变量: 
var myPrivateVar = "我仅能在YAHOO.myProject.myModule内被访问。"; 
//私有方法: 
var myPrivateMethod = function () { 
YAHOO.log("我仅能在YAHOO.myProject.myModule内被访问。"); 
} return { 
myPublicProperty: "我作为YAHOO.myProject.myModule.myPublicProperty能被访问。" 
myPublicMethod: function () { 
YAHOO.log("我作为YAHOO.myProject.myModule.myPublicMethod能被访问。"); 
//在myProject,我能访问私有的变量和方法 
YAHOO.log(myPrivateVar); 
YAHOO.log(myPrivateMethod()); 
//myPublicMethod的原生作用域是myProject,我们可以用“this”来访问公共成员。 
YAHOO.log(this.myPublicProperty); 
} 
}; 
}();

在上面的代码中,我们从一个匿名函数返回有两个成员的一个对象。在YAHOO.myProject.myModule内部,可以分别用this.myPublicProperty和this.myPublicMethod来访问。在YAHOO.myProject.myModule外部,公共成员可以用YAHOO.myProject.myModule.myPublicProperty和YAHOO.myProject.myModule.myPublicMethod来访问。
私有变量myPrivateProperty和myPrivateMethod只能被匿名函数本身或返回对象的成员访问。尽管匿名函数会立即执行和终止,但它们依然是保留着,凭借闭包(closure)的力量——通过一个函数的局部变量在这个函数返回后是保留的规则。只要 YAHOO.myProject.myModule需要它们,我们的两个私有变量就不会被销毁。
4、实践这个模式。让我们来看看这个模式的一个常见应用案例。假设你有一个列表,列表上的一些项可以被拖拽。应用拖拽的项上有拖拽的CSS类。
<!--这个脚本文件包含所有的YUI实用程序--> 
<script type="text/javascript" 
src="http://yui.yahooapis.com/2.2.2/build/utilities/utilities.js"></script> 
<ul id="myList"> 
<li class="draggable">一项</li> 
<li>二项</li> <!--二项将不能被拖拽--> 
<li class="draggable">三项</li> 
</ul> 
<script> 
YAHOO.namespace("myProject"); 
YAHOO.myProject.myModule = function () { 
//YUI实用程序的私有简写引用: 
var yue = YAHOO.util.Event, 
yud = YAHOO.util.Dom; 
//私有方法 
var getListItems = function () { 
// 注意这个地方使用其他的私有变量,包括"yud"YAHOO.util.Dom的简写: 
var elList = yud.get("myList"); 
var aListItems = yud.getElementsByClassName( 
"draggable", //得到仅有CSS类"draggable"的项 
"li", //仅返回列表项 
elList //限定搜索改元素的子 
); 
return aListItems; 
}; 
//这个放回的对象将变成YAHOO.myProject.myModule: 
return { 
aDragObjects: [], //可对外访问的,存储DD对象 
init: function () { 
//直到DOM完全加载好,才实现列表项可拖拽: 
yue.onDOMReady(this.makeLIsDraggable, this, true); 
}, 
makeLIsDraggable: function () { 
var aListItems = getListItems(); //我们可以拖拽的那些元素 
for (var i=0, j=aListItems.length; i<j; i++) { 
this.aDragObjects.push(new YAHOO.util.DD(aListItems[i])); 
} 
} 
}; 
}(); 
//上面的代码已经执行,所以我们能立即访问init方法: 
YAHOO.myProject.myModule.init(); 
</script>

这是一个简单的例子,特意写的详细一些——如果按照这种方式做,我们无疑能把它写的更紧凑。当项目变得更加复杂和它的API增加,这个模式缩放的很好。通过这种方式,它避免了全局命名空间,提供了对外的可以访问的API方法,支持受保护或“私有”的数据和方法。
  • [1]原文:《a javascript module pattern》。这是在YUI blog上的,有的地方可能打不开,可以搜一下英文的转载或者利用搜索引擎的缓存也能看。
  • [2]《A JavaScript Module Pattern ? JavaScript的一种模组模式》这是别人的翻译,参考了不少,不过感觉挺不方便看的,这是我翻译的这篇文章的一个原因,当然最主要的原因是这篇文章算是学习YUI的最基础的文章了,整个YUI的模块模式都基于此。
原文地址:http://dancewithnet.com/2007/12/04/a-javascript-module-pattern/
Javascript 相关文章推荐
Extjs4 关于Store的一些操作(加载/回调/添加)
Apr 18 Javascript
Javascript执行效率全面总结
Nov 04 Javascript
解决用jquery load加载页面到div时,不执行页面js的问题
Feb 22 Javascript
js打开windows上的可执行文件示例
May 27 Javascript
js数组的基本操作(很全自己整理的)
Oct 16 Javascript
node.js中的fs.symlinkSync方法使用说明
Dec 15 Javascript
js 连续赋值的简单实现
Jun 13 Javascript
前端html中jQuery实现对文本的搜索功能并把搜索相关内容显示出来
Nov 14 jQuery
Vue 莹石摄像头直播视频实例代码
Aug 31 Javascript
js canvas实现星空连线背景特效
Nov 01 Javascript
JS Generator 函数的含义与用法实例总结
Apr 08 Javascript
jQuery实现开关灯效果
Aug 02 jQuery
jQeury淡入淡出需要注意的问题
Sep 08 #Javascript
jQuery之浮动窗口实现代码(两种方法)
Sep 08 #Javascript
Jquery ThickBox插件使用心得(不建议使用)
Sep 08 #Javascript
jquery的Tooltip插件 qtip使用详细说明
Sep 08 #Javascript
jquery的Theme和Theme Switcher使用小结
Sep 08 #Javascript
复制小说文本时出现的随机乱码的去除方法
Sep 07 #Javascript
extjs grid设置某列背景颜色和字体颜色的实现方法
Sep 06 #Javascript
You might like
用函数读出数据表内容放入二维数组
2006/10/09 PHP
ThinkPHP利用PHPMailer实现邮件发送实现代码
2013/09/26 PHP
PHP遍历数组的三种方法及效率对比分析
2015/02/12 PHP
PHP的文件操作与算法实现的面试题示例
2015/08/10 PHP
PHP文件及文件夹操作之创建、删除、移动、复制
2016/07/13 PHP
TNC vs RR BO3 第一场 2.14
2021/03/10 DOTA
不一样的文字闪烁 轮番闪烁
2009/11/11 Javascript
ExtJs3.0中Store添加 baseParams 的Bug
2010/03/10 Javascript
jquery学习笔记二 实现可编辑的表格
2010/04/09 Javascript
原生js拖拽(第一课 未兼容)拖拽思路
2013/03/29 Javascript
JavaScript执行顺序详细介绍
2013/12/04 Javascript
JavaScript获取并更改input标签name属性的方法
2015/07/02 Javascript
javascript实现手机震动API代码
2015/08/05 Javascript
Nodejs中的this详解
2016/03/26 NodeJs
javascript如何定义对象数组
2016/06/07 Javascript
浅谈gulp创建完整的项目流程
2017/12/20 Javascript
JS实现字符串翻转的方法分析
2018/08/31 Javascript
vue中多个倒计时实现代码实例
2019/03/27 Javascript
简单使用webpack打包文件的实现
2019/10/29 Javascript
javascript数组元素删除方法delete和splice解析
2019/12/09 Javascript
Vue文本模糊匹配功能如何实现
2020/07/30 Javascript
[00:36]TI7不朽珍藏III——斯温不朽展示
2017/07/15 DOTA
[00:26]TI7不朽珍藏III——冥界亚龙不朽展示
2017/07/15 DOTA
5个很好的Python面试题问题答案及分析
2018/01/19 Python
python统计字母、空格、数字等字符个数的实例
2018/06/29 Python
JSON文件及Python对JSON文件的读写操作
2018/10/07 Python
Flask框架模板渲染操作简单示例
2019/07/31 Python
如何解决pycharm调试报错的问题
2020/08/06 Python
Stylenanda中文站:韩国一线网络服装品牌
2016/12/22 全球购物
神路信息Java面试题目
2013/03/31 面试题
消防安全责任书
2014/04/14 职场文书
高职教师先进事迹材料
2014/08/24 职场文书
美术教师个人总结
2015/02/06 职场文书
小班下学期个人总结
2015/02/12 职场文书
学籍证明模板
2015/06/18 职场文书
使用CSS3实现按钮悬停闪烁动态特效代码
2021/08/30 HTML / CSS