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 相关文章推荐
jquery 常用操作整理 基础入门篇
Oct 14 Javascript
javascript DOM编程实例(智播客学习)
Nov 23 Javascript
javascript JSON操作入门实例
Apr 16 Javascript
script标签的 charset 属性使用说明
Dec 04 Javascript
jquery中获取元素的几种方式小结
Jul 05 Javascript
js四舍五入数学函数round使用实例
May 09 Javascript
jQuery简单实现QQ空间点赞已经取消点赞
Apr 02 Javascript
jQuery简单实现提交数据出现loading进度条的方法
Mar 29 Javascript
微信小程序 页面滑动事件的实例详解
Oct 12 Javascript
详解最新vue-cli 2.9.1的webpack存在问题
Dec 16 Javascript
详解vue中组件参数
Jul 09 Javascript
微信小程序 行的删除和增加操作实现详解
Sep 29 Javascript
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
PHP中两个float(浮点数)比较实例分析
2015/09/27 PHP
PHP处理CSV表格文件的常用操作方法总结
2016/07/01 PHP
CI框架使用composer安装的依赖包步骤与方法分析
2016/11/21 PHP
Laravel框架实现多个视图共享相同数据的方法详解
2019/07/09 PHP
jquery.boxy插件的iframe扩展代码
2010/07/02 Javascript
疯狂Jquery第一天(Jquery学习笔记)
2012/05/11 Javascript
Underscore.js常用方法总结
2015/02/28 Javascript
初步认识JavaScript函数库jQuery
2015/06/18 Javascript
超赞的jQuery图片滑块动画特效代码汇总
2016/01/25 Javascript
jQuery实现的倒计时效果实例小结
2016/04/16 Javascript
jQuery CSS3自定义美化Checkbox实现代码
2016/05/12 Javascript
JQuery 在文档中查找指定name的元素并移除的实现方法
2016/05/19 Javascript
JS简单生成两个数字之间随机数的方法
2016/08/03 Javascript
浅谈JS之iframe中的窗口
2016/09/13 Javascript
js实现滑动到页面底部自动加载更多功能
2017/02/15 Javascript
vue实现nav导航栏的方法
2017/12/13 Javascript
JS实现的小火箭发射动画效果示例
2018/12/08 Javascript
详解vue项目打包步骤
2019/03/29 Javascript
[01:14:34]DOTA2上海特级锦标赛C组资格赛#2 LGD VS Newbee第一局
2016/02/28 DOTA
Python数组条件过滤filter函数使用示例
2014/07/22 Python
python正则中最短匹配实现代码
2018/01/16 Python
Python读写/追加excel文件Demo分享
2018/05/03 Python
Python设计密码强度校验程序
2020/07/30 Python
详解如何使用rem或viewport进行移动端适配
2020/08/14 HTML / CSS
俄罗斯购买自行车网站:Vamvelosiped
2021/01/29 全球购物
New delete 与malloc free 的联系与区别
2013/02/04 面试题
建筑毕业生自我鉴定
2013/10/18 职场文书
申报职称专业技术个人的自我评价
2013/12/12 职场文书
党员学习十八大感想
2014/01/17 职场文书
2015年元宵节活动总结
2015/02/06 职场文书
学校社团活动总结
2015/05/07 职场文书
2016年重阳节慰问信
2015/12/01 职场文书
个人售房合同协议书
2016/03/21 职场文书
PyTorch 如何检查模型梯度是否可导
2021/06/05 Python
微信小程序中wxs文件的一些妙用分享
2022/02/18 Javascript
Redis 报错 error:NOAUTH Authentication required
2022/05/15 Redis