文档章节

RequireJs 2.0 API 中四种定义模块的方式。

龙马行空
 龙马行空
发布于 2014/06/27 20:51
字数 1705
阅读 162
收藏 0

      模块不同于传统意义上的脚本文件,因为它定义了一个良好作用域的对象,能够避免污 染全局的命名空间。它能够明确地列出其依赖,和全局对象无关地操作这些依赖,相反的, 接收这些依赖作为定义模块函数的参数。RequireJS 中的模块是模块模式的一个扩展,具有 不需要参考其他模块的全局设置的优势。  
      对于模块的 RequireJS 语法允许它们尽可能快的被加载,甚至是无序的,但是能够以正 确的依赖顺序执行,由于没有创建全局变量,所以说在一个页面中加载多个版本的模块成为 了可能。  
     (如果你熟悉或正在使用 CommonJS 模块,那么你也可以参考下在 CommonJS 注解中的 关于如何将 RequireJS 模块映射到 CommonJS 模块中的相关资料)  
       磁盘上的每个文件应当只有一个模块定义。各个模块可以通过优化工具划分为优化的包。 


1、简单键值对
如果模块不依赖于任何模块,同时只是传递一些 name/value 对,那么只是传递了一个 原始的对象给 define():  
//Inside file my/shirt.js:
define({     color: "black",     size: "unisize" }); 

2、定义函数

如果模块不依赖于任何模块,但是需要使用函数做一些设置工作,那么定义它自己,传 递一个函数给 define():  
//my/shirt.js now does setup work //before returning its module definition. define(function () {     //Do setup work here  
    return {         color: "black",         size: "unisize"     } });


3、定义依赖的函数

如果模块有依赖,那么第一个参数应该是依赖名称的数组集合,第二个参数应该是一个 定义的函数。一旦所有依赖都已加载,那么将调用这个函数来定义模块。这个函数应该返回 一个定义模块的对象。这些依赖将作为参数传递给定义的参数,同时按照依赖顺序在参数中 列出来。  
//my/shirt.js now has some dependencies, a cart and inventory //module in the same directory as shirt.js define(["./cart", "./inventory"], function(cart, inventory) {         //return an object to define the "my/shirt" module.         return {             color: "blue",             size: "large",             addToCart: function() {                 inventory.decrement(this);                 cart.add(this);             }         }     }
);  
 在上述案例中,my/shirt 模块已经创建。它依赖于 my/cart 和 my/inventory。磁盘上文 件结构是这样的:  
 my/cart.js  my/inventory.js  my/shirt.js  
上述函数调用中指定了两个参数,’cart’ ’inventory’.这些代表了’./car’ ‘./inventory’模块。 上述函数直到 my/cart,my/inventory 模块加载完成后才被调用,它接收模块作为 cart 和 inventory 参数  定义全局的模块是明确不鼓励使用的,以便一个模块的多个版本能够在一个页面上同时 存在(参考高级用法)。同时函数的参数顺序应该和依赖的顺序相匹配。  函数调用的返回值定义了’my/shirt’模块。通过这种方式定义模块, ’my/shirt’并不是作为 一个全局对象而存在的  


4、定义一个模块作为一个函数 

模块没有必要一定返回对象。函数中的任何合法返回值都是允许的。下面是一个返回一个函 数作为它的模块定义的模块示例:  
//A module definition inside foo/title.js. It uses //my/cart and my/inventory modules from before, //but since foo/bar.js is in a different directory than //the "my" modules, it uses the "my" in the module dependency //name to find them. The "my" part of the name can be mapped //to any directory, but by default, it is assumed to be a //sibling to the "foo" directory. define(["my/cart", "my/inventory"],     function(cart, inventory) {         //return a function to define "foo/title".         //It gets or sets the window title.         return function(title) {             return title ? (window.title = title) :                    inventory.storeName + ' ' + cart.name;         }     } );

5、自定义模块

您可能会遇到的一些 define()函数调用,函数的第一个参数是模块名称:  
//Explicitly defines the "foo/title" module:     define("foo/title",         ["my/cart", "my/inventory"],         function(cart, inventory) {             //Define foo/title object in here.        }     ); 这些通常是由优化工具生成的。你可以明确地命名模块名称,但是这样会导致模块的可 移植性很差。假如你把文件移到另外一个目录,这时你需要修改名称。最好的实践是避免编 码模块名称,让优化工具自行优化模块名。优化工具需要添加模块名,以便在一个文件中可 以绑定多个模块,这样在浏览器中能够加载的更快。

6、其他模块说明

 一个文件一个模块: 按照模块到文件路径查找算法,每个 JavaScript 文件应该只定义一个模块。优化工具会 将多个模块分组到优化的文件中,但是你只能通过优化工具将多个模块放到一个文件中。  Define()相对模块命名: 在 define()函数内部调用 require(‘./relative/name’)之前,确保’require’已经作为一个依赖, 只有这样相对名称才能被正确的解析:  
define(["require", "./relative/name"], function(require) {     var mod = require("./relative/name"); });  
或更好的,对于解析 CommonJS 模块使用简洁的语法是可行的。  
define(function(require) {     var mod = require("./relative/name"); });  
这种形式,将使用 Function.prototype.toStrin()找到 require()调用,并把它们添加依赖 数组中,由于“require”已加载 ,因此这样的代码会正常解析相对路径。 相对路径真的非常有用,如果你在一个目录下创建了一些模块,那么你可以好其他人或 其他工程共享这些目录,同时你能够在那个目录下的兄弟模块获取到一个句柄,而不需要知 道目录的名称。  
 生成相对路径模块的 URL  你可能需要生成相对于模块的 URL。要做到这一点,将’require’作为依赖,使用 require.toUrl()生成 URL:  
define(["require"], function(require) {     var cssUrl = require.toUrl("./style.css"); });   
 控制台代码调试  如果你需要在 JavaScript 控制台和一个已经通过 require(["module/name"], function(){})加 载好的模块进行调试,那么你需要使用 require()函数通过模块名查询它  
require("module/name").callSomeFunction()  
注意:这个只有先通过 require 异步加载模块 require([‘module/name’])才有效。如果使用的 相对路径,比如‘./module/name’,这类的只有在 define 内部有效。 

 

© 著作权归作者所有

共有 人打赏支持
龙马行空
粉丝 388
博文 127
码字总数 119251
作品 0
房山
前端工程师
RequireJS极简入门教程

RequireJS is a JavaScript file and module loader. It is optimized for in-browser use, but it can be used in other JavaScript environments, like Rhino and Node. Using a modular s......

程序员诗人
2017/03/30
0
0
JavaSript模块规范 - AMD规范与CMD规范介绍

JavaSript模块化 在了解AMD,CMD规范前,还是需要先来简单地了解下什么是模块化,模块化开发? 模块化是指在解决某一个复杂问题或者一系列的杂糅问题时,依照一种分类的思维把问题进行系统性...

大糊涂
2015/06/09
0
0
RequireJS与SeaJS模块化加载示例

web应用越变的庞大,模块化越显得重要,尤其Nodejs的流行,Javascript不限用于浏览器,还用于后台或其他场景时,没有Class,没有Package的Javascript语言变得难以管理,于是出现CommonJS项目...

nosand
2014/05/04
0
10
关于 CommonJS AMD CMD UMD

一、CommonJS CommonJs 是服务器端模块的规范,Node.js采用了这个规范。 根据CommonJS规范,一个单独的文件就是一个模块。加载模块使用require方法,该方法读取一个文件并执行,最后返回文件...

雪飘七月
06/26
0
0
关于 CommonJS AMD CMD UMD

CommonJS CommonJs 是服务器端模块的规范,Node.js采用了这个规范。 根据CommonJS规范,一个单独的文件就是一个模块。加载模块使用require方法,该方法读取一个文件并执行,最后返回文件内部...

奥巴码侬
2014/05/11
0
8

没有更多内容

加载失败,请刷新页面

加载更多

造谣造到t-io老巢了

只发当事人的截图,不发表评论,以免有引导嫌疑 PS1:截图是由不同的人发过来的 PS2:本人已经不在此微信群 PS3:图3是2018-09-23的t-io官方群的一个发言小统计,有助于让人认识到他们的其中...

talent-tan
40分钟前
56
0
heartbeat 资源

drbd+apache+heartbeat : http://blog.51cto.com/11838039/1827901 heartbeat双机热备的架设 : http://blog.51cto.com/11838039/1827560 对heaetbeat的深一步认识 : http://blog.51cto.co......

寰宇01
今天
4
0
Spring 转换 model 为 json 时增加属性

缘起 目前的项目中有个需求是在附件对象转换成 json 时增加个 url 属性,以前的方式是在返回附件对象或列表时候做一次统一处理,这次想看看 spring 或者 jackson fasterxml 是否自带类似功能...

郁也风
今天
3
0
10大PHP比特币开源项目

如果你是一个Phper,如果你希望学习区块链,那么本文列出的 10个开源的Php比特币项目,将有助于你了解在自己的应用中 如何加入对比特币的支持。 如果你希望快速掌握使用Php对接比特币钱包的方...

汇智网教程
今天
4
0
springclould feign客户端添加全局参数

用springclould feign作为调用服务的客户端,一般来说参数可以写在feignclient的方法参数里 有时需要所有feign请求都统一添加一些参数,例如token用于鉴权等,可以这样做: 添加一个配置类,...

canneljls
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部