Javascript的一种模块模式


Posted in Javascript onMarch 22, 2008

Douglas Crockford已经传授了一个有用的单例模式(singleton pattern)实现此规则,我认为他的模式有益于你基于YUI的那些应用。Douglas叫它模块模式(module pattern)。它是如下工作的:

创建一个命名空间对象:如果你使用YUI,可以用YAHOO.namespace()方法: YAHOO.namespace("myProject");这分配了一个空的myProject对象,是YAHOO的一个成员(如 果myProject已存在的话,则不会被覆盖)。现在我们可以开始添加YAHOO.myProject的成员。 
对你的命名空间对象分配一个匿名函数返回值: 
YAHOO.myProject.myModule = function () {
return  {
  myPublicProperty: "我作为YAHOO.myProject.myModule.myPublicProperty被访问。";
  myPublicMethod: function () {
    YAHOO.log("我作为YAHOO.myProject.myModule.myPublicMethod被访问。");
  }
};
}(); // 这个括号导致匿名函数被执行且返回
注意有闭合大括号和紧接着的括号()的最后一行—这种符号导致了匿名函数的立即执行,返回包含myPublicProperty和myPublicMethod的对象。只要这个匿名函数一返回,返回对象就作为YAHOO.myProject.myModule被访问。 

在匿名函数中,在返回语句前加入“私有”方法和变量。到目前为止,我们只是将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需要它们,我们的两个私有变量就不会被销毁。 

实践这个模式。让我们来看看这个模式的一个常见应用案例。假设你有一个列表,列表上的一些项可以被拖拽。应用拖拽的项上有拖拽的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的模块模式都基于此。

Javascript 相关文章推荐
js两行代码按指定格式输出日期时间
Oct 21 Javascript
Lazy Load 延迟加载图片的jQuery插件中文使用文档
Oct 18 Javascript
JS获取图片实际宽高及根据图片大小进行自适应
Aug 11 Javascript
JS获得QQ号码的昵称,头像,生日的简单实例
Dec 04 Javascript
javascript每日必学之循环
Feb 19 Javascript
Javascript中关于Array.filter()的妙用详解
Dec 04 Javascript
React组件生命周期详解
Jul 03 Javascript
Angular指令之restict匹配模式的详解
Jul 27 Javascript
JS中offset和匀速动画详解
Feb 06 Javascript
node实现基于token的身份验证
Apr 09 Javascript
JS面向对象的程序设计相关知识小结
May 26 Javascript
用vue写一个日历
Nov 02 Javascript
javascript cookie解码函数(兼容ff)
Mar 17 #Javascript
简单的JS多重继承示例
Mar 13 #Javascript
JMenuTab简单使用说明
Mar 13 #Javascript
JObj预览一个JS的框架
Mar 13 #Javascript
DHTML Slide Show script图片轮换
Mar 03 #Javascript
JavaScript面向对象编程
Mar 02 #Javascript
一个javascript参数的小问题
Mar 02 #Javascript
You might like
php pki加密技术(openssl)详解
2013/07/01 PHP
跟我学Laravel之安装Laravel
2014/10/15 PHP
PHP PDOStatement对象bindpram()、bindvalue()和bindcolumn之间的区别
2014/11/20 PHP
YII Framework框架教程之安全方案详解
2016/03/14 PHP
Yii CDBCriteria常用方法实例小结
2017/01/19 PHP
javascript getElementsByTagName
2011/01/31 Javascript
js验证整数加保留小数点的简单实例
2013/12/02 Javascript
javascript常见用法总结
2014/05/22 Javascript
让浏览器DOM元素最后加载的js方法
2014/07/29 Javascript
详解JavaScript的策略模式编程
2015/06/24 Javascript
JavaScript运动减速效果实例分析
2015/08/04 Javascript
jquery实现在网页指定区域显示自定义右键菜单效果
2015/08/25 Javascript
微信支付 JS API支付接口详解
2016/07/11 Javascript
js实现下拉菜单效果
2017/03/01 Javascript
nodejs动态创建二维码的方法
2017/08/12 NodeJs
Node.js学习教程之HTTP/2服务器推送【译】
2017/10/31 Javascript
解决VUE中document.body.scrollTop为0的问题
2018/09/15 Javascript
vue中引入mxGraph的步骤详解
2019/05/17 Javascript
laravel-admin 与 vue 结合使用实例代码详解
2019/06/04 Javascript
基于JavaScript实现单例模式
2019/10/30 Javascript
在Vue mounted方法中使用data变量详解
2019/11/05 Javascript
mysql 之通过配置文件链接数据库
2017/08/12 Python
python解析html提取数据,并生成word文档实例解析
2018/01/22 Python
Django MEDIA的配置及用法详解
2019/07/25 Python
使用python实现飞机大战游戏
2020/03/23 Python
Python基于argparse与ConfigParser库进行入参解析与ini parser
2021/02/02 Python
浅谈css3中calc在less编译时被计算的解决办法
2017/12/04 HTML / CSS
美国销售第一的智能手机和平板电脑保护壳:OtterBox
2017/12/21 全球购物
英国时尚和家居用品零售商:Matalan
2021/02/28 全球购物
采购经理岗位职责
2014/02/16 职场文书
城市精细化管理实施方案
2014/03/04 职场文书
一份文言文检讨书
2014/09/13 职场文书
优秀班主任先进事迹材料
2014/12/16 职场文书
感恩的心主题班会
2015/08/12 职场文书
《水上飞机》教学反思
2016/02/20 职场文书
《仙剑客栈2》第一弹正式宣传片公开 年内发售
2022/04/07 其他游戏