dojo学习笔记.doc

Dojo学习笔记(1. 模块与包)Intro:Dojo是一个非常强大的面向对象的JavaScript的工具箱,建议读者能够去补充一下JavaScript下如何使用OO进行编程的, 这对于你以后阅读Dojo Source有很大的用处请大家下载dojo 0.3.1, 以下的说明均针对此版本翻译自/WikiHome/DojoDotBook/BookUsingDojoGetting Started1: 把Dojo加入到我们的Web程序中1. 标志djConfig=isDebug:false;djConfig是Dojo里的一个全局对象, 其作用就是为Dojo提供各种选项, isDebug是最常用的属性之一, 设置为True以便能够在页面上直接看到调试输出, 当然其中还有些属性与调试有关, 这里就不罗索了2. 引用 dojo 的启动代码这样你就引用了dojo的代码, 并可以直接使用其中部分常用的对象, 下载下来的dojo.js是压缩(remove comments and space)后的代码, 要阅读的话,建议阅读dojo.js.uncompressed.js, dojo.js大概有127K, 而未压缩前有211K, ok, 为什么会这么大呢, 原来其已经把部分常用的模块整合进dojo.js里, 因此显得大了一点, build.txt里就说明了默认的dojo.js包含了哪些模块3. 声明你所要用到的包dojo.require(dojo.math);dojo.require(dojo.io.*);dojo.require(dojo.widget.*);你就把这些代码当成是java的import语句或C#中的using语句一样, 如果你不require的话, 而模块本身又没有整合在dojo.js中, 是会出现脚本错误的喔2. 针对不同需求提供的预整合包Dojo本身是由许多模块所组合而成的, 但是由于用户需求的多样性, dojo针对不同的需求而提供了不同的版本, 用户在下载dojo的时候就看见可以选择很多的版本, 比如Ajax版和Widget版, 每个版本最重要的区别就在于dojo.js文件, 但是除此之外, 每一个版本都是全功能的, dojo.js根据版本的不同而整合进了不同的模块3. 直接获取Dojo的最新源代码首先你必须安装 Subversion, 当Subversion在你的电脑上能够正常工作后,你就可以通过如下命令下载dojo的源代码:svnco/dojo/trunk/这会在你的当前目录下创建一个 trunk 的目录; 如果你希望直接Get到当前目录, 用这个命令:svnco/dojo/trunk/.或者你希望Get到当前目录下的 MyDir 目录, 用这个命令:svnco/dojo/trunk/MyDir模块与包模块Dojo的代码被划分为逻辑单元称之为模块, 这有点类似于Java中的package,除了dojo的模块能够包含类 (类似于java中的classes)和简单函数比如: 模块dojo.html包含了一系列的函数, 比如dojo.html.getContentBox(), 模块dojo.dnd包含了一系列的HtmlDragObject的类注意名称约定, 函数的首字母为小写字母,类的首字母为大写模块也可以称之为命名空间包在多数情况下, dojo的模块只需要定义在一个文件就可以了, 但有时, 一个模块可能划分到多个文件, 比如: 模块dojo.html, 本来是定义在一个文件中, 可是由于功能的增强, 文件逐渐变大, 我们不得不将其拆分为多个文件, 这主要是为性能考虑, 以便浏览器可以只下载其需要用到的代码, 不幸的是其实现细节对于dojo的用户看起来不那么透明, 你必须知道你想要用到的功能到底是包含在哪个文件, 然后才能require并使用它这样的每一个文件都称之为一个包dojo.require(dojo.html.extras)将引用文件 src/html/extras.js, 这将定义模块 dojo.html 的若干(并非所有)函数据我所知, 尽管单个文件可以定义包里的多个类, 单个脚本文件不能定义多个模块 (在Java可以等效于在一个文件中定义2个类), 并且, 包的名称和模块的名称可以不同, 比如: 包dojo.widget.Button定义了dojo.widget.html.Button基本上你应该这样认为, 包和模块尽管密切相关, 但是是两个完全不同的实体为什么会有模块和包这样的概念?为什么会有模块和包这样的概念? 为了满足你的应用程序只需要加载其所用到的东西的需求, 充分利用模块化设计的优点, dojo维护了最小的足印以便仍能提供你所需要的功能, 为什么要你的用户浪费时间去下载用不到的JavaScript, 当一个包就是一个js文件时, 一个模块本质上就是一个命名空间, 比如: dojo.style 或 dojo.html.extras多数简单情况下, 一个包包含了一个模块, 但更常见的是, 一个模块可能被拆分为几个包文件利用包和模块, 将能确保你能够交付最相关的功能代码, 最小程度的减少代码的膨胀和消除由此带来的不好的用户体验,这就是模块设计的主要目标, 通过模块化, 你能够引入自定义模块(你自己拥有的 JavaScript 工具), 并且维护模块对于核心代码库基本不会产生什么影响另外, Dojo的模块系统也提供了内建的机制来使用代码提供命名空间, 比如, 通过模块dojo.event定义的Dojo的事件系统怎样引用设置引用语句你怎样才能知道该引用哪个包到dojo.require()?1. 模块首先, 确定你要使用什么模块, 这个例子我们假定你要使用 dojo.lfx.html2. 包搜索代码后你发现dojo.lfx.html定义在2个文件: src/lfx/html.js src/lfx/extras.js 根据你要用到的功能, 你可以dojo.require(dojo.lfx.html);或dojo.require(dojo.lfx.html);dojo.require(dojo.lfx.extras);通配符新用户可能会对dojo.lfx.*这样就可以替代上面2句而感到诧异, 实际上, _package_.js 中已经定义了通配符可以代替的语句, 并且这样可以让dojo根据当时的环境而决定加载具体的模块Dojo学习笔记(2. djConfig解说)djConfig是dojo内置的一个全局设置对象，其作用是可以通过其控制dojo的行为首先我们需要在引用dojo.js前声明djConfig对象，以便在加载dojo.js的时候才能够取得所设置的值，虽然在0.3版本以后dojo支持在加载后设置，但是强烈建议你把声明djConfig的代码作为第一段script一个完整的djConfig对象定义如下（值均为dojo的默认值）vardjConfig=isDebug:false,debugContainerId:, bindEncoding: ,allowQueryConfig:false,baseScriptUri:,parseWidgets:truesearchIds:,baseRelativePath:,libraryScriptUri:,iePreventClobber:false,ieClobberMinimal:true,preventBackButtonFix:true,;isDebug是一个很有用的属性，顾名思义，如果设置为真，则所有dojo.Debug的输出有效，开发时应该设置为true，发布时应该设置为falsedebugContainerId同样也是与调试有关的，如果不指定的话，调试信息将会直接利用 document.write输出，这样可能会破坏页面的整体布局，所以你可以指定任何一个可以作为容器的html元素的id作为调试信息输出容器allowQueryConfig，这个属性指明 dojo是否允许从页面url的参数中读取djConfig中的相关属性，当值为true时，dojo会优先从url参数中读取djConfig的其他属性，比如: http:/server/dojoDemo.htm?djConfig.debugContainerId=divDebugbaseScriptUri，一般不需要设置，dojo会自动根据你引用dojo.js的路径设置这个值，比如，自动获取的值便是 ./dojo/ps: 如果你有多个工程需要同时引用dojo.js的话，建议也把dojo当作一个独立的工程，引用的时候采用绝对路径就可以了parseWidgets，这个是可以控制dojo是否自动解析具有dojoType的html元素为对应的widget，如果你没有使用任何Widget，建议设置为false以加快dojo的加载速度searchIds，这是一个字符串数组，定义了所有需要解析为widget的html元素的ID，如果ID不在其中的html元素是不会被解析的，当数组为空数组时，则所有具有dojoType的元素都会被解析还有一个bindEncoding，是用来设置默认的bind请求的编码方式至于其它的属性，不是用处不大，就是不知道有什么作用在实际开发中，可以把djConfig的定义放在一个js文件里，并将其作为第一个引用的js文件，这样应该是最方便的。Dojo学习笔记(3. Dojo的基础对象和方法)这里所说的基础对象和方法是指的不Require任何包就能够调用的对象和方法匿名函数在开始前，我想介绍一下js里的匿名函数，这个在阅读dojo的源代码的时候，会发现到处都有匿名函数;(function()alert(123);)();/前面的分号是一个空语句，是可以不要的匿名函数。一个匿名函数就是一个没有名字的函数。你可以认为他们是一次性函数。当你只需要用一次某个函数时，他们就特别有用。通过使用匿名函数，没有必要把函数一直放在内存中，所以使用匿名函数更加有效率。当然你也可以根本不定义函数，但是使用匿名函数可以把你的代码分段，就像C#中的#region一样dojo.byId非常有用的一个方法，与prototype.js的著名的$一样似乎以前的版本还有dojo.byIdArray, 不过最新的版本已经找不到这个函数了(除了srccompat0.2.2.js)如果有多个元素具有指定的id，则返回的是一个集合Usage Example:dojo.byId(divTest);dojo.byId(divTest,document);dojo.byId(document.getElementById(divTest);dojo.versiondojo的版本，可以取得major, minor, patch, flag和revision这个对象没什么太大用处，除非你要根据dojo的版本选择执行你的代码dojo.raise抛出一个异常dojo.errorToString将异常转换为字符串Usage Example:trydojo.raise(打印失败,newError(文件不存在);catch(e)alert(dojo.errorToString(e);dojo.render系统环境对象返回browser，说明是工作在浏览器下dojo.render.ver返回4，似乎没什么用dojo.os.win返回true说明操作系统是Windowsdojo.os.linux返回true说明操作系统是Linuxdojo.os.osx返回true说明操作系统是MacOSdojo.html.ie返回true说明浏览器是InternetExplorerdojo.html.opera返回true说明浏览器是Operadojo.html.khtml返回true说明浏览器是Konquerordojo.html.safari返回true说明浏览器是Safaridojo.html.moz返回true说明浏览器是MozillaFireFoxdojo.svg.capable 返回true说明浏览器支持svgdojo.vml.capable 返回true说明浏览器支持vmldojo.swf.capable 返回true说明浏览器支持swfdojo.swt.capable 返回true说明浏览器支持swt (IBM开发的Standard Widget Toolkit)如果dojo.html.ie为true的话dojo.html.ie50返回true说明浏览器是IE5.0dojo.html.ie55返回true说明浏览器是IE5.5dojo.html.ie60返回true说明浏览器是IE6.0dojo.html.ie70返回true说明浏览器是IE7.0dojo.addOnLoad可以加载指定函数到window.load时执行，好处就是可以很方便的在window.load时执行多个函数Usage Example:dojo.addOnLoad(init);/init是一个函数dojo.addOnLoad(myObject,init);/init是myObject对象的一个方法dojo.require如果你想调用一个模块的对象的时候，你应该首先用dojo.require来请求这个模块，dojo会根据你的请求自动取得相应的js文件，并加载到内存中，这样你才能调用或创建其中的对象dojo会自动维护已加载的模块列表，所以是不会重复加载模块的Usage Example:dojo.require(dojo.event);dojo.requireIf=dojo.requireAfterIf可以根据指定的条件来决定是否加载指定的模块Usage Example:dojo.requireIf(dojo.html.ie,dojo.html);/如果dojo.html.ie为true，才会加载dojo.html模块vide除非你要开发自己的模块，不然是用不到这个方法的，你可以这句看成是向系统注册这个模块名称Usage Example:vide(dojo.custom);dojo.exists判断指定对象是否具有指定名称的方法Usage Example:dojo.exists(dojo,exists);/willreturntruedojo.hostenv.getText返回指定url的内容PS: 由于浏览器的安全限制，因此只能用于取得同域名的url的内容，否则会报告权限不够Usage Example:aSync=false;/同步，确保返回内容不为nullsilent=true;/不抛出错误s=dojo.hostenv.getText(/,aSync,silent);/返回Google的首页的HTMLalert(s);dojo.debug输出调试信息，如果在djConfig中指定了debugContainerId，则输出到指定的console容器中，否则直接document.write所有的调试信息均以 DEBUG: 开头Usage Example:dojo.debug(这是调试信息);dojo.hostenv.println与dojo.debug类似，不同的是，输出内容没有 DEBUG:Usage Example:dojo.hostenv.println(这是一般的输出信息);dojo.debugShallow输出指定对象的全部信息(Shallow说明并不会遍历到下一级别的对象属性)以供调试Usage Example:dojo.debugShallow(dojo.render.html);Dojo学习笔记(4. dojo.string & dojo.lang) 模块：mon / mon 和 dojo.string 是一样的，只要require其中一个就可以使用以下方法dojo.string.trim去掉字符串的空白Usage Example:s=abc;dojo.string.trim(s);/willreturnabcdojo.string.trim(s,0);/willreturnabcdojo.string.trim(s,1);/willreturnabcdojo.string.trim(s,-1);/willreturnabcdojo.string.trimStart去掉字符串开头的空白Usage Example:s=abc;dojo.string.trimStart(s);/willreturnabcdojo.string.trimEnd去掉字符串结尾的空白Usage Example:s=abc;dojo.string.trimEnd(s);/willreturnabcdojo.string.repeat生成由同一字符(串)重复组成的字符串Usage Example:dojo.string.repeat(a,4);/willreturnaaaadojo.string.repeat(1234,3,-);/willreturn1234-1234-1234dojo.string.pad使用字符补齐字符串Usage Example:dojo.string.pad(100,6);/willreturn000100dojo.string.pad(100,6,0,1);/willreturn000100dojo.string.pad(100,6,0,-1);/willreturn100000dojo.string.padLeft使用字符补齐字符串开头Usage Example:dojo.string.padLeft(100,6);/willreturn000100dojo.string.padRight使用字符补齐字符串结尾Usage Example:dojo.string.padRight(100,6);/willreturn100000模块：mon / mon 和 dojo.lang 是一样的，只要require其中一个就可以使用以下方法dojo.lang.mixin将一个对象的方法和属性增加到另一个对象上Usage Example:vars1=name:TestObj,test1:function()alert(thisistest1!);vars2=value:1000,test2:function()alert(thisistest2!);vard=;dojo.lang.mixin(d,s1,s2);/执行后d就具备了s1和s2的所有属性和方法d.test1();dojo.lang.extend为指定类的原型扩展方法与属性Usage Example:TestClass=function();dojo.lang.extend(TestClass,name:demo,test:function()alert(Test!););varo=newTestClass();/TestClass本来是没有test方法的，但是extend以后就有test方法了o.test();dojo.lang.find=dojo.lang.indexOf查找指定对象在指定数组中的位置Usage Example:vararr=1,2,3,3,2,1;dojo.lang.find(arr,2);/willreturn1dojo.lang.find(arr,2,true);/willreturn1dojo.lang.find(arr,2,true);/willreturn-1dojo.lang.find(arr,2,false);/willreturn1dojo.lang.find(arr,2,true,true);/willreturn4dojo.lang.findLast=dojo.lang.lastIndexOf查找指定对象在指定数组中的位置，从后往前查Usage Example:vararr=1,2,3,3,2,1;dojo.lang.findLast(arr,2);/willreturn4dojo.lang.findLast(arr,2,true);/willreturn4dojo.lang.findLast(arr,2,true);/willreturn-1dojo.lang.findLast(arr,2,false);/willreturn4dojo.lang.inArray查找指定对象是否在指定数组中Usage Example:vararr=1,2,3;dojo.lang.inArray(arr,1);/willreturntruedojo.lang.inArray(arr,4);/willreturnfalsedojo.lang.isObject判断输入的类型是否为对象Usage Example:dojo.lang.isObject(newString();/willreturntruedojo.lang.isObject(123);/willreturnfalsedojo.lang.isArray判断输入的类型是否为数组Usage Example:dojo.lang.isArray(a:1,b:2);/willreturnfalsedojo.lang.isArray(1,2,3);/willreturntruedojo.lang.isFunction判断输入的类型是否为函数Usage Example:dojo.lang.isFunction(function();/willreturntruedojo.lang.isString判断输入的类型是否为字符串Usage Example:dojo.lang.isString();/willreturntruedojo.lang.isString(0);/willreturnfalsedojo.lang.isAlien判断输入的类型是否为系统函数Usage Example:dojo.lang.isAlien(isNaN);/willreturntruedojo.lang.isBoolean判断输入的类型是否为布尔类型Usage Example:dojo.lang.isBoolean(21);/willreturntruedojo.lang.isNumber判断输入的类型是否为数值，根据注释所说，此函数使用不太可靠，但是可替换使用的系统函数isNaN也不太可靠dojo.lang.isUndefined判断输入是否为未定义，根据注释所说，此函数有可能会导致抛出异常，推荐使用 typeof foo = undefined 来判断模块：dojo.lang.extrasdojo.lang.setTimeout延迟指定时间后执行指定方法Usage Example:functiononTime(msg)dojo.debug(msg)dojo.lang.setTimeout(onTime,1000,test);/1秒后会输出调试信息testdojo.lang.setTimeout(dojo,debug,1000,test);/1秒后会输出调试信息testdojo.lang.getNameInObj获得指定项目在指定对象中的名称Usage Example:dojo.lang.getNameInObj(dojo,dojo.debug);/willreturndebugdojo.lang.shallowCopy返回指定对象的浅表复制副本Usage Example:dojo.lang.shallowCopy();/willreturna空对象dojo.lang.firstValued返回第一个存在定义的参数Usage Example:vara;dojo.lang.firstValued(a,2,3);/willreturn2Dojo学习笔记(5. dojo.lang.array & dojo.lang.func & dojo.string.extras)模块：dojo.lang.arraydojo.lang.has判断对象是否具有指定属性，不过这个方法有用吗，不如直接使用 if(name in obj)Usage Example:dojo.lang.has(dojo.lang, has); /will return truedojo.lang.isEmpty判断对象或数组是否为空Usage Example:dojo.lang.isEmpty(a: 1); /will return falsedojo.lang.isEmpty(); /will return truedojo.lang.map调用指定的方法处理指定的数组或字符串Usage Example:dojo.lang.map(1,2,3,4,5, function(x) return x * x;); /will return 1,4,9,16,25dojo.lang.forEach遍历指定的数组或字符串，并对其中的元素调用指定的方法Usage Example:dojo.lang.forEach(abc, function(x) alert(x); );dojo.lang.every检查指定的数组是否全部满足指定方法的条件Usage Example:dojo.lang.every(1,-2,3, function(x) return x 0; ); /指定的数组不是全大于0的，因此返回falsedojo.lang.some检查指定的数组是否部分满足指定方法的条件Usage Example:dojo.lang.some(1,-2,3, function(x) return x 0; ); /指定的数组有大于0的元素，因此返回truedojo.lang.filter根据指定的方法来过滤指定的数组Usage Example:dojo.lang.filter(1,-2,3, function(x) return x 0; ); /will return 1, 3dojo.lang.unnest把指定的参数或数组转换为一维数组Usage Example:dojo.lang.unnest(1, 2, 3);/will return 1, 2, 3dojo.lang.unnest(1, 2, 3, 4); /will return 1, 2, 3, 4dojo.lang.toArray将输入转换为数组Usage Example:function test() return dojo.lang.toArray(arguments, 1);test(1,2,3,4,5); /will return 2,3,4,5模块：dojo.lang.funcdojo.lang.hitch将指定的方法挂在指定的对象下并返回该方法Usage Example:func = test: function(s) alert(s);dojo.lang.mixin(func, demo: dojo.lang.hitch(func, test);func.demo(demo and test are same method);dojo.lang.forward返回自身对象的指定名称的方法引用Usage Example:func = test: function(s) alert(s), demo: dojo.lang.forward(test);func.demo(demo and test are same method);dojo.lang.curryWhat is curry? 请参阅这篇文章：/code/curried_javascript/Usage Example:function add(a, b) return a + b;dojo.lang.curry(null, add, 2, 3); /will return 5dojo.lang.curry(null, add, 2)(3); /will return 5dojo.lang.curry(null, add)(2)(3); /will return 5dojo.lang.curry(null, add)()(2)(3); /will return 5dojo.lang.curryArguments与dojo.lang.curry类似，但是可以选择忽略掉前n个参数Usage Example:function add(a, b) return a + b;dojo.lang.curryArguments(null, add, 1,2,3,4,5, 2); /will return 5 (= 2 + 3)dojo.lang.tryThese测试参数指定所有函数，并返回第一个返回值不为0的函数值from seno:dojo.lang.tryThese方法和prototype中的Try.these()方法是一样的， xmlNode.text在一些浏览器中好用，但是xmlNode.textContent在另一些浏览器中正常工作。 使用Try.these()方法我们可以得到正常工作的那个方法的返回值。 function getXmlNodeValue(xmlNode) return Try.these( function() return xmlNode.text;, function() return xmlNode.textContent;) ); dojo.lang.delayThese没看懂这个函数怎么用模块：dojo.string.extrasdojo.string.substituteParams类似C#中的String.Format函数%name要保证与传入的对象的名称大小写一致，否则会出异常Usage Example:dojo.string.substituteParams(%0 - %1 - %2, a, b, c); /will return a - b - cdojo.string.substituteParams(%name: %value, name:名称,value:值); /will return 名称: 值dojo.string.capitalize把每一个单词的首字母大写Usage Example:dojo.string.capitalize(show me love); /will return Show Me Lovedojo.string.isBlank判断输入字符串是否为空或全是空白字符，如果传入对象为非字符串则也会返回trueUsage Example:dojo.string.isBlank( 1 ); /will return falsedojo.string.escape参数1为type，可传值为: xml/html/xhtml, sql, regexp/regex, javascript/jscript/js, ascii将按照所传type对字符串进行编码Usage Example:dojo.string.escape(html, ); /will return <input type=text value= />dojo.string.encodeAsciidojo.string.escapeXmldojo.string.escapeSqldojo.string.escapeRegExpdojo.string.escapeJavaScriptdojo.string.escapeString这些函数也就是 dojo.string.escape 所调用的，这里无需多说dojo.string.summary取得输入字符串的缩略版本Usage Example:dojo.string.summary(1234567890, 5); /will return 12345.dojo.string.endsWith判断输入字符串是否以指定的字符串结尾Usage Example:dojo.string.endsWith(abcde, E);/will return falsedojo.string.endsWith(abcde, E, true); /will return truedojo.string.endsWithAny判断输入字符串是否以指定的任意字符串结尾Usage Example:dojo.string.endsWithAny(abcde, E, e); /will return truedojo.string.startsWith判断输入字符串是否以指定的字符串开头Usage Example:dojo.string.startsWith(abcde, A);/will return falsedojo.string.startsWith(abcde, A, true); /will return truedojo.string.startsWithAny判断输入字符串是否以指定的任意字符串开头Usage Example:dojo.string.startsWithAny(abcde, A, a); /will return truedojo.string.has判断输入字符串是否含有任意指定的字符串Usage Example:dojo.string.has(abcde, 1, 23, abc); /will return truedojo.string.normalizeNewlines按要求转换回车换行的格式Usage Example:dojo.string.normalizeNewlines(arnbrn, r); /will return arbrdojo.string.splitEscaped将字符串按分隔符转换为数组Usage Example:dojo.string.splitEscaped(a_b_c, _); /will return a_b, c Dojo学习笔记(6. dojo.io.IO & dojo.io.BrowserIO) 模块：dojo.io.IOdojo.io.bind处理请求取回需要的数据并处理这个函数是AJAX中最为重要和有用的函数，dojo.io.bind这个类是用来处理客户端与服务器间通讯的，需要通讯的参数由对象dojo.io.Request所定义，具体通讯的方法则由另外一个对象Transport所提供。因此，我们如果需要与服务器通讯，则应该定义一个Request对象，其中包括服务器地址及回调函数，例子中Requset都是以匿名对象方式定义的虽然我们可以定义一个自己的Transport，但是显然不如直接利用现成的Transport方便。Dojo里提供了一个同时兼容IE和Firefox的dojo.io.XMLHTTPTransport，但是这个对象位于dojo.io.BrowserIO，因此，一般require dojo.io.IO时，还应该require dojo.io.BrowserIOUsage Example: dojo.io.bind( url: http:/localhost/test.html, /要请求的页面地址 mimetype: text/html, /请求的页面的类型，应该设置为与你请求页面类型对应的mimetype，默认为 text/plain method：GET, /默认为GET sync: false, /默认为异步执行 useCache: false, /默认为不使用页面缓存，