Dojo1.11官方教程文档翻译(1.2)Hello Dojo!
2016-11-05 19:10
405 查看
Dojo1.11官方教程文档翻译(1.2)Hello Dojo!
啰嗦两句:15年初学的Dojo没用多久就放下了,最近打算重新捡起来,就把文档翻翻顺便学习,不打算逐句翻译,随缘翻译法权当做个参考,请以官方文档为准。如有错误欢迎指正,转载请注明出处http://blog.csdn.net/taijiedi13/。–碎梦道简介
本篇入门,主要是关于Dojo的加载和一些核心功能,另外还有基于AMD的模块加载,还有如何在出现错误时寻求帮助。入门
开始用Dojo只需要把dojo.js文件包含在web页面里,方式和其他javascript文件一样。Dojo在主流CDN上也有,先来把下面的代码放在一个文件里,以hellodojo.html命名该文件,然后在浏览器里打开。
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutorial: Hello Dojo!</title> </head> <body> <h1 id="greeting">Hello</h1> <!-- load Dojo --> <script src="//ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js" data-dojo-config="async: true"></script> </body> </html>
通常,当你了加载一个库的js文件就可以使用它的所有方法了。Dojo以前也是这样的,但1.7版后源码采取异步模块定义(AMD),可以实现完全模块化的web应用开发。选择AMD是因为它使用纯javascript,使源文件在浏览器中正常工作的同时支持生产资源优化的build过程来提高部署时的应用性能。
那么在
dojo.js加载之后提供什么功能呢?那就是Dojo的AMD加载器,它定义了两个全局函数
require和
define。AMD细节见Introduction to AMD tutorial。在入门阶段你只需要知道require用来加载并使用模块、define用来自定义模块。一个模块就是一个单独的javascript源文件。
还有几个HTML DOM 操作的Dojo基本模块是dojo/dom 和 dojo/dom-construct。下面我们来看看如何加载和使用这几个模块:
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutorial: Hello Dojo!</title> </head> <body> <h1 id="greeting">Hello</h1> <!-- load Dojo --> <script src="//ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js" data-dojo-config="async: true"></script> <script> require([ 'dojo/dom', 'dojo/dom-construct' ], function (dom, domConstruct) { var greetingNode = dom.byId('greeting'); domConstruct.place('<em> Dojo!</em>', greetingNode); }); </script> </body> </html>
require的第一个参数(14-17行)是一个你需要加载的模块id组成的数组。通常,它们直接对应文件名,如果你下载了Dojo源代码,就能在Dojo目录里找到定义了这些模块的
dom.js和
dom-constuct.js。
AMD加载器进行异步操作,并且用以回调的方式实现了JavaScript中的异步操作,
require(17行)的第二个参数就是一个回调函数。回调函数中,就是你提供的使用那些模块的代码。AMD加载器将模块作为参数传递给你的回调函数(它们和模块id数组中的顺序一致)。你可以随意命名这些参数,但为了保障代码一致性和可读性,我们推荐你基于模块id来命名。
在第18-19行可以看到,我们运用了
dom和
dom-construct模块,它通过id获取一个DOM节点并操作其内容。
对于你请求的模块,AMD加载器会自动加载它的所有依赖模块,所以要只需要列出你直接用到的模块即可。
定义AMD模块
下面有一个加载和使用模块的示例。要定义和加载你自己的模块,先要确认你是从HTTP服务器加载HTML文件的(本地也可以,但是由于有一些安全敏感设置会阻止许多使用“file:///”协议的内容,所以你需要一个HTTP服务器)。对于这些例子,你的web服务器只需要提供文件的能力,不需要其他任何花哨的功能。在你的目录下添加一个demo目录,它包含你的
hellodojo.html文件,并在
demo目录下创建一个
myModule.js文件。
demo/ myModule.js hellodojo.html
现在在myModule.js中输入:
define([ // 这个模块需要用到dojo/dom模块,所以要把它放进依赖模块列表中。 'dojo/dom' ], function(dom){ // 一旦依赖模块列表中的模块全都加载完成,就会调用这个函数来定义demo/myModule模块。 // // dojo/dom 作为第一个参数传递给这个函数,依赖列表中的其他模块会作为随后的参数传入。 var oldText = {}; // 这个返回的对象成为该模块定义的值 return { setText: function (id, text) { var node = dom.byId(id); oldText[id] = node.innerHTML; node.innerHTML = text; }, restoreText: function (id) { var node = dom.byId(id); node.innerHTML = oldText[id]; delete oldText[id]; } }; });
ADM
define函数的参数和
require函数相似,一个模块id数组和一个回调函数。AMD加载器将回调函数的返回值存储为该模块的值,然后当其他代码通过require(或者define)加载该模块时,会接收到该模块定义的返回值。
CDN的使用
通过CDN来使用Dojo时,加载本地模块需用一些额外配置(关于配置Dojo的AMD加载器和通过CDN使用Dojo的更多信息请参考AMD进阶和在CDN下使用模块的教程)。像下面这样更新hellodojo.html的代码:
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutorial: Hello Dojo!</title> </head> <body> <h1 id="greeting">Hello</h1> <!-- 配置 Dojo --> <script> // 为了代替data-dojo-config,我们在加载dojo.js之前创建一个dojoConfig对象; //它们在功能上完全相同,只是这种方法对于大型配置来说更容易读懂。 var dojoConfig = { async: true, // 这个代码注册“demo”包的正确位置,这样我们就能够在从CDN加载Dojo的同时加载本地模块了 packages: [{ name: "demo", location: location.pathname.replace(/\/[^/]*$/, '') + '/demo' }] }; </script> <!-- 加载 Dojo --> <script src="//ajax.googleapis.com/ajax/libs/dojo/1.10.4/dojo/dojo.js"></script> <script> require([ 'demo/myModule' ], function (myModule) { myModule.setText('greeting', 'Hello Dojo!'); setTimeout(function () { myModule.restoreText('greeting'); }, 3000); }); </script> </body> </html>
除了添加Dojo配置之外,我们还重新定义了主要JS代码,现在它只加载
demo/myModule,并利用该模块完成页面上的文本操作。由此可见,定义和加载模块其实很简单。我们也修改了指向
dojo.js的URL,省略了协议(26行),它创建一个跟页面使用相同协议(http或https)的链接,这样可以防止会让一些浏览器发出安全警报的混合内容。
在AMD模块中组织代码,可让你创建模块化的JavaScript资源,它们可以立即在浏览器中执行,并且易于调试。AMD模块中变量使用局部作用域,避免搅乱全局命名空间的同时,还提供了更快的名称解析。AMD是一个有着多重实现的标准规范,所以你不会被局限在单一实现方式上 —— 任何AMD加载器都可以使用AMD模块。
等待DOM
有一件事通常是web应用必须要实现的,那就是确保浏览器在执行代码前DOM是可用的。我们通过一个特殊的AMD模块—— plugin(插件)实现这个功能。插件可以像其他模块一样require,但是要在模块标识符后加个感叹号(!)来激活他们的特殊功能。对于DOM ready事件,Dojo提供dojo/domReady插件。只要在任何
require或
define调用时,将这个插件包含在依赖列表里,那么对应的回调在DOM准备好之前就不会触发:
require([ 'dojo/dom', 'dojo/domReady!' ], function (dom) { var greeting = dom.byId('greeting'); greeting.innerHTML += ' from Dojo!'; });
上面的例子简单地在
greeting元素中添加一些文本,这件事只能在DOM加载后进行(先前不用这个是由于
script元素放在
body元素的底部,这样会将脚本的处理延迟到DOM加载之后)。注意,模块标识符以“!”结尾,否则
dojo/domReady模块会变得和普通模块一样。
有时候,比如dojo/domReady,我们加载一个模块只是为了利用它的副作用,并不需要引用它。但是AMD加载器并不知道这个,它总是会将依赖数组里的每一个模块都引用给回调函数,所以任何你不需要返回值的模块都应该放在依赖数组的末尾,并且在回调函数的参数列表中忽略它们。
DOM操作函数的更多信息参见 Dojo DOM Functions。
添加视觉特效
现在我们可以给页面添加一些动画来让它更生动。我们可以加载模块dojo/fx来进行。下面使用
dojo/fx的
slideTo方法给欢迎辞添加一个滑动动画。
require([ 'dojo/dom', 'dojo/fx', 'dojo/domReady!' ], function (dom, fx) { // 我们之前有的 var greeting = dom.byId('greeting'); greeting.innerHTML += ' from Dojo!'; // 现在,有了动画 fx.slideTo({ node: greeting, top: 100, left: 200 }).play(); });
如你所见,我们已经添加了一个
dojo/fx依赖,然后使用这个模块在
greeting元素上播放动画。
特效和动画的更多信息请参考 Dojo Effects 和 Animations教程。
使用Dojo资源
CDN很方便,我们在教程的例子中使用它是因为你直接复制代码就可以运行了,不需要做任何修改。不过它有一些劣势:为了保证性能,它们是一个Dojo的“build”版本,就是说每个模块都进行了压缩和优化以便于在网上高效传输。那么也就是说当出现问题时,调试会很困难。
它要求你必须连接互联网来使用你的应用,很多情况下这不太现实。
当你要包含自定义模块时就需要更多的努力。
如果你想要将你的应用产品化,定制化build版本的Dojo能够针对你特定的应用和浏览器提高性能,但使用一刀切的CDN build你实现不了。
按照以下步骤使用Dojo资源,它们是你使用Dojo开发项目的通用方式:
1.下载Dojo——查看本文结尾部分并下载发布源代码。
如果你熟悉git和GitHub,你可以从GitHub克隆Dojo。你至少要下载dojo,某种程度上你可能还会想要dijit、dojox和util(这些都包含在源码下载中)。
2.把Dojo放到你的项目文件中,例如:
demo/ myModule.js dojo/ dijit/ dojox/ util/ hellodojo.html
3.本地加载dojo.js,比CDN更好。
<script src="dojo/dojo.js"></script>
4.更新你的配置文件包
var dojoConfig = { async: true, baseUrl: '.', packages: [ 'dojo', 'dijit', 'dojox', 'demo' ] };
获取帮助
任何时候当你困惑或遇到棘手问题时,你都不是一个人在战斗!志愿者们随时准备着通过dojo-interest mailing list 的邮件和通过 #dojo on irc.freenode.net的IRC来提供帮助。如果你在我们的文档中发现了问题,或者觉得哪里有所误导或混淆,可以用文档底部的反馈页面来告知我们。如果你需要紧急或者秘密的帮助,或者有志愿者团队解决不了的问题,可以通过SitePen找到 commercial Dojo support和training workshops。
下一步做什么?
Dojo Toolkit的入门只要简单的添加一个脚本标签和require一些模块就可以,但是Dojo巨大的领域和力量意味着我们这才刚刚接触到了皮毛。根据你的需求,本系列教程提供几个不同的学习路径:如果你之前用过Dojo,并且想要更好地理解AMD的世界及旧Dojo,理解其他已经改变的概念,你应该看一看“新一代Dojo”教程。
如果你想要在已有的静态页面或服务器驱动的网站上添加一些特性和特效,接下来你可以看看使用dojo/query、Dojo事件、特效和动画教程。
如果你想要在你的站点添加一些Ajax,Ajax 与 Dojo是你的菜。
如果你想要在你的Web站点或应用上整合丰富的widget库,看一看创建基于模板的Widget教程以及Dijit widgets系列教程。
如果你试图更多地了解关于构建复杂Web应用和利用Dojo实用功能的力量,请看核心概念部分。
如果你的目标是一个移动应用,快去看dojox/mobile入门。
无论你想要什么结果,Dojo都提供行业领先的开源工具来帮助你让你的应用在更少的时间里取得惊人的结果。我们期待看到你提出的想法。
相关文章推荐
- Dojo1.11官方教程文档翻译(5.9)创建自定义widget
- Dojo1.11官方教程文档翻译(3.3)Dojo 事件
- Dojo1.11官方教程文档翻译(3.1)Dojo DOM函数
- Dojo1.11官方教程文档翻译(5.8)创建基于模板的widget
- Dojo1.11官方教程文档翻译(3.4)Dojo特效
- Dojo1.11官方教程文档翻译(6.4)实时Store
- Dojo1.11官方教程文档翻译(1.3)使用dojoConfig配置Dojo
- Dojo1.11官方教程文档翻译(2.4)Dojo和Node.js
- Dojo1.11官方教程文档翻译(1.1)开启Dojo之旅
- Dojo1.11官方教程文档翻译(2.1)CND
- Dojo1.11官方教程文档翻译(5.2)图表
- Dojo1.11官方教程文档翻译(1.4)新一代Dojo
- Dojo1.11官方教程文档翻译(3.6)键盘事件
- Dojo1.11官方教程文档翻译(5.3)图表进阶
- Dojo1.11官方教程文档翻译(6.3)MVC应用的数据模型
- Dojo1.11官方教程文档翻译(4.6)创建类
- Dojo1.11官方教程文档翻译(5.5)对话框和工具提示
- Dojo1.11官方教程文档翻译(4.4)创建Build
- Dojo1.11官方教程文档翻译(4.11)JSONP和dojo/request
- Dojo1.11官方教程文档翻译(4.3)对象扩张