Dojo中AMD模块化和本地变量的命名规范

        客户端Web应用开发的健壮性已经变得越来越强，有很多工具可以用来增强终端客户的沉浸感和交互性的用户体验。随着用户数量的激增，高效编写代码的重要性尤为突出。采用dojo以及其他AMD兼容的工具，使编写良好模块化的前端代码变得简单容易。当采用AMD的开发模式，开发人员可以容易的编写出模块化的前端代码，但是需要面临两方面的问题，如：一、合理命名模块；二、对引用某模块的本地变量确定相应的命名规范。

        首先，复习一下AMD技术的一些专业术语：

包

        简单地说，包的概念就是模块的集合，例如：dojo, dijit和gridx。然而，不同于模块目录中的各个简单集合，包本质上还包括一些额外的特性，能够显著增强模块的可移植性和易用性。

        包主要有三个配置选项，包括：name，包的名称；location，包的位置，可以是对baseUrl的相对路径，也可以是绝对路径；main，它是一个可选参数默认值为”main”，用于发现和正确的加载模块用户尝试引用的包。例如：代码中写到require “dojo”, 实际上会加载的文件是”dojo/main.js”。

         管理模块是至关重要的，因为每个包的依赖数量必须限制在一定范围内。如果有一个包依赖于其他所有的包，那么这个包将很难被拿出来单独使用。模块也需要通过一种有意义的方式进行打包，例如：对于同一个包，不要即包含数学符号PI的运算模块，也包含表单控件的显示模块。

模块

        一个模块可以使一个类、一个函数、一个包含属性和方法的对象，也可以仅仅是一段可运行的代码。模块的功能是强大的，可以使程序的低耦合度降低，并且易于重用。

模块的名称是自动从它的文件路径名中提取出来的，例如：一个模块的文件路径为art/shapes.js，那么它将通过名称”art/shapes”被模块引用。更多关于模块命名、定义和引用的详细信息请参见AMD API specification一文。

        Dojo的加载器使得模块的重定向过程变得简单，模块的重用工作只需要复制模块的文件到目标路径即可。例如：将模块文件art/shapes.js移动到模块geometry中变成geometry/shapes.js，引用该模块只需要调用新的模块标示”geometry/shapes”。如上所示，将模块在不同的包之间移动变得容易，也使得解耦合和代码重用变得简单易行。

        Dojo加载器允许模块与本地变量名之间建立映射关系，选择变量名称和打包代码对于开发人员来说是极其重要的决定。以下将通过两三分钟的介绍，探索这个领域的更多细节，使dojo开发者从中受益。

应该如何命名模块？

        进行模块开发时，采用合适的命名规范会提高开发的效率，能够保证模块的API直观清晰，同时也能减少模块名称的额外记忆负担。此外，它还能够使开发人员的时间花在更有意义的工作上，例如：项目优化和缺陷修复。当决定如何命名模块的时候，开发人员需要考虑诸如“是否为类构造函数类型”，“是否为一个混入类型(mixin)”，这些东西可以改变模块推荐的命名规范。

        如果一个模块为类的构造函数类型，如：widget，它应该按照大写开头驼峰式命名格式(UpperCamelCase)来命名；如果是一个混入类型(mixin)，应该依照下划线(_UnderscoreMixin)格式；如果都不是，应依照小写开头的驼峰(lowerCamelCase)命名格式，典型的例子为单体。

        除了模块的合理命名外，利用require的回调函数引用模块时，对该模块映射的变量进行标准的命名方式也是一个好的习惯。在dojo开发中，这项工作被称为”首选参数别名(Preferred Arg Alias)”,其中一部分被推荐在 dojo.XX AMD modules spreadsheet文中。这篇文章强调绝大部分模块的命名必须准确和有意义，模块的首选参数别名与模块名称相似，即使无法准确描述，也必须将模块用一个有意义的方式打包。我们正努力改善这一点，关于这一点的工作可以在” 1.x to 2.0 migration document”一文中找到。选择一致的本地变量名称的好处如下：

•  对构造函数(constructions)、混入(mixin)和单体(Singletone)维持推荐的命名规范
•  为源模块提供一个很容易相关的名称
•  选择一致的本地变量名可以更容易地复用dojo的例子和教程
  

        模块的本地变量名可以很直接地引用到包含的模块。有时候一个模块标示无法通过一个理想的本地变量来命名。例如，如果这个名称是一个javascript中的保留字array，推荐做法是增加一个后缀名变成arrayUtil。或者，如果模块名包含连字符，例如”dojo/domo-construct”，推荐的做法是命名为正确的javascript变量domConstruct。这些本地变量仅在局部引用这些返回的模块依赖项，因此可以被任意命名，但是按照一致性格式可以有效地简化AMD方法。

结论

        采用适当方式命名模块并将其映射到调用函数的传入参数上，以及采用有意义的方式进行打包，能够使代码更有可移植性并且易于维护和理解。想更深入了解AMD技术，可在SitePen组织的Dojo workshop中找到帮助。对于已有的一些旧代码，需要迁移到新版本的dojo中，或重新编写，或调试，都可以在SitePen的网站中找到支持和帮助。

        附上原文链接: [http://www.sitepen.com/blog/2012/12/07/amd-module-and-local-variable-naming-conventions/]