dojo.declare,dojo.define,dojo.require解释

转载自http://blog.chinaunix.net/uid-27024249-id-4023752.html

dojo.declare在dojo中被广泛使用,理解它将对弄懂dojo的代码有很大帮助。简单的说,dojo.declare提供了一种声明类的方式,通过它可以很方便的扩展其他类:

dojo.declare("com.abc.MyDataProvider"/*类名*/, dojo.widget.ComboBoxDataProvider/*基类*/,

  1.          {/*object, start*/

  2.               name: "My DataProvider",

  3.               init: function() {

  4.                  ...

  5.               }

  6.          }/*object, end*/

  7.      )

这里类名com.abc.MyDataProvider是用字符串来表示的,dojo.widget.ComboBoxDataProvider是 被扩展的基类,第三个参数是个object,用来定义该类的属性。 dojo.declare产生的类所具有的属性将是基类的属性和大括号中指定的属性的集合,如果大括号中声明了和基类同名的属性,则基类属性将被覆盖,但也有例外,下面将会说明。生成类的constructor将会调用基类的constructor,然后调用本身的initializer方法,该方法可以来自类本身,也可以来自其基类,如果都没有还可以来自dojo.declare中可选的一个参数,否则将是个空函数。

如何使用产生的类呢?可以把该名字作为function类型的变量名来使用,如

  1. dp = new com.abc.MyDataProvider()

可见dojo.declare产生了一个指定名称的变量,引用创建出的class(function) 也可以:  

  1. dpClass = dojo.evalObjPath("com.abc.MyDataProvider");

  2. dp = new dpClass()

这种方式比较适合通过类名字符串来使用该类。
1. 覆盖的问题
如果基类是这么声明的:


  1. dojo.widget.ComboxDataProvdier = function() {

  2.          this.init = function() {

  3.              ...

  4.          }

  5.      }

而我们希望com.abc.MyDataProvider里声明的init方法覆盖基类的方法,那么上面那个dojo.declare的结果是不对的,这时查看该类的一个实例,你会发现它的init属性是基类的方法。

dojo.declare先会把dojo.widget.ComboBoxDataProvider.prototype上的属性设置到 com.abc.MyDataProvider.prototype上,然后再把本身声明的属性加进去,因此 com.abc.MyDataProvider.prototype的init属性正是我们期望的init函数,但是当执行该类的constructor 方法时,它会调用基类的constructor,因此本来设置好的init函数就被基类的init函数覆盖了,于是override失败。

这里的ComboDataProvider作为一个class,不应该在constructor里赋值init属性,这样会导致每个实例都会有一个init方法的实例,而这是没有必要的。应该用prototype来定义method属性:
  com.abc.MyDataProvider.prototype.init = function() {
  ...
 }
由此可见,用dojo.declare来override还是有个前提的,那就是要override的method必须用prototype定义,而不是在constructor里。
2. 多重继承

dojo.declare是可以扩展多个类的,如: dojo.declare("dojo.widget.html.ComboBox", dojo.widget.HtmlWidget,,

   { ... } 

); 这时第一个类dojo.widget.HtmlWidget将会被作为super class,于是其prototype上的属性将会进入dojo.widget.html.ComboBox.prototype,然后其他基类 prototype上的属性也会被mixin到dojo.widget.html.ComboBox.prototype,最后是类本身声明的属性。当然 在constructor只会调用基类的construtor。

这有点类似java的单根继承、多个接口,不过要注意的是:如果dojo.widget.HtmlWidget和 dojo.widget.ComboBox同时声明了一个函数属性,那么产生的类将会具有dojo.widget.ComboBox里声明的函数,这时如 果dojo.widget.ComboBox因为是一个接口类而把该属性声明为空函数,而你希望继承的是dojo.widget.HtmlWidget上 该方法的实现,那么结果就不对了,你得到的类的该方法将是dojo.widget.ComboBox上的声明的空函数。

Dojo 学习(1):简单方法的定义和使用 

可参考官方教程:http://dojotoolkit.org/documentation/tutorials/1.7/hello_dojo/
教程里主要定义了两个方法,setText设置文本内容和restoreText重置文本内容。
这两个方法通过dojo.define这个方法来定义。

  1. // demo/myModule.js

  2. // In demo/myModule.js (which means this code defines the "demo/myModule" module):


  3. define(

  4.    // The dojo/dom module is required by this module, so it goes in this list of dependencies.

  5.    ["dojo/dom"], function(dom){


  6.    // Once all modules in the dependency list have loaded, this

  7.    // function is called to define the demo/myModule module.

  8.    //

  9.    // The dojo/dom module is passed as the first argument to this function; additional modules 

  10.    // in the dependency list would be passed in as subsequent arguments.


  11.     var oldText = {};


  12.    // This returned object becomes the defined value of this module

  13.    return {

  14.        setText: function(id, text){

  15.                    var node = dom.byId(id);

  16.                    oldText[id] = node.innerHTML;

  17.                    node.innerHTML = text;

  18.                },

  19.        restoreText: function(id){

  20.                        var node = dom.byId(id);

  21.                        node.innerHTML = oldText[id];

  22.                        delete oldText[id];

  23.                    }

  24.          };

  25. });


define 方法引用了必要的类,就像java 中的 import;并且还包含了对业务逻辑的实现,并通过return来返回,以上就是myModule.js文件的全部内容。那么在html页面里,通过dojo.require来加载上面的js代码,


  1. // Require the module we just created

  2. require(["demo/myModule"], function(myModule){

  3.    // Use our module to change the text in the greeting

  4.    myModule.setText("greeting", "Hello Dojo!");


  5.    // After a few seconds, restore the text to its original state

  6.    setTimeout(function(){

  7.        myModule.restoreText("greeting");

  8.    }, 3000);

  9. });


上面的代码通常放在内执行。
demo/myModule指的demo/myModule.js,有关路径问题参看这里:Dojo 学习(0): require的路径问题
加载成功后就可以通过 myModule.setText 这样的方式来调用了。
在这里暂且先总结为:dojo.define 方法仅用于定义和声明,dojo.require 方法仅用于异步加载js文件


dojo类机制简介

随着AJAX和RIA技术的发展,JavaScript被广泛的使用,并在开发中发挥着越来越重要的作用。JavaScript提供了特有的类机制,但是在语法习惯上与传统面向对象的语言有很大的不同,这使得不少的JavaScript开发人员感到比较迷惑,而dojo作为功能强大的JavaScript类库,有功能完整的类机制实现。本文将通过实例介绍dojo的类机制,这是dojo提供的一种强大和灵活的功能,其dijit UI组件框架也是以此为基础实现的。

1. 使用dojo定义类

声明dojo类是通过dojo.declare()方法来实现的,如我们想要定义一个名为com.levinzhang.Person的类,该类有name、age属性和getName、getAge方法:

  1. dojo.declare("com.levinzhang.Person", null,{

  2.        name:null,

  3.        age:null,

  4.        constructor: function(name,age){

  5.            this.name = name;

  6.            this.age = age;

  7.        },

  8.        getName:function(){

  9.            return this.name;

  10.        },

  11.        getAge:function(){

  12.            return this.age;

  13.        }

  14.    })

除了前面提到的属性的和方法以外,在代码中我们还定义了一个名为constructor的方法,这个方法在dojo的类机制中至关重要,当我们实例化该类得到对象的时候,该方法将会被调用,从而完成初始化的操作。


dojo的declare接受三个参数,分别为类的名称、要继承的父类以及该类的属性和方法。实例化类的语法也很简洁,与实例化普通的JavaScript类并无分别:

		
		
			var person = new com.levinzhang.Person("levinzhang",30);  	
		
			alert(person.getName());//将会提示出levinzhang		

	

2. 实现静态变量

在常见的面向对象语言中,经常会使用到类层次的静态变量,而通过dojo定义的类也能实现静态变量的需求,不过态变量仅限于数组和对象类型。

		
		
			staticInfo:{count:0},  
		
			constructor: function(name,age){ 
		
			    this.name = name; 
		
			    this.age = age; 
		
			    ++this.staticInfo.count; 
		
			} 		

	

如上所示,如果定义了数组和对象,而没有在构造方法中进行修改的话,这个对象将会成为该类的静态属性,测试代码如下:

		
		
			var person = new com.levinzhang.Person("levinzhang",30);  
		
			alert(person.staticInfo.count);//此时将会提示出1
		
			var person2 = new com.levinzhang.Person("levin",30); 
		
			alert(person2.staticInfo.count);//此时将会提示出2		

	

需要注意的两点是:1)对于原始类型的变量如数字、布尔值和字符串,dojo的类机制并没有提供实现静态属性的功能;2)如果定义的数组或对象属性在constructor方法中被重新赋值,那么该属性将不再是静态属性,而是每个实例化对象都持有一份属于自己的备份了。

3. 使用dojo实现继承

在JavaScript中没有直接实现继承的关键字,因此关于继承有多种的实现方式,代表性的是类式继承原型式继承,但是不管哪种继承方式都需要开发人员对JavaScript语言本身有着很深厚的了解。dojo对JavaScript的继承机制进行了很好的封装,可以实现功能强大的类定义,我们将对一些常见的功能进行介绍。

dojo.declare方法中的第二个参数,是指明要继承的父类的,该参数可以为null(要定义的类没有父类)、单个类(要定义的类继承自一个父类)或数组(要定义的类继承自多个父类)。

1) 单继承

我们要定义一个名为com.levinzhang.Employee 的类,继承自com.levinzhang.Person,并要添加名为workExperience的属性、重写getName方法等功能:

  1. dojo.declare("com.levinzhang.Employee", com.levinzhang.Person,{

  2.         workExperience:null,

  3.         constructor: function(name,age,workExperience){

  4.             this.workExperience = workExperience;

  5.         },

  6.         getWorkExperience:function(){

  7.             return this.workExperience;

  8.         },

  9.         getName:function(){

  10.             return "Employee:"+this.name;

  11.         },

  12.         getInput:function(){

  13.             return 5000;

  14.         }

  15.     })


在以上的代码中,我们定义的com.levinzhang.Employee继承了com.levinzhang.Person并添加了自定义的方法。测试代码如下:
		
			var employee = new com.levinzhang.Employee("levin",30,4); 
		
			    alert(employee.getName());//将提示出Employee:levin	
		
			    alert(employee.getWorkExperience());//将提示出4	
		
			    alert(employee.getAge());//将提示出30		

	

可以看到在Employee的实例中,我们能够调用父类中定义的方法。而在类的constructor初始化方法中,我们并没有调用父类相关的方法,但是我们成功初始化了name和age两个属性,这是因为dojo会自动调用父类的初始化方法,完成继承要求的相关初始化工作。

2) 多继承

dojo支持多继承的功能, dojo实现了被Python和很多支持多继承语言使用的C3算法。使用dojo的多继承功能时,需要注意的是:只有数组中的第一个元素会作为真正的父类,而其它的元素则是通过mixin的方式进行属性添加以构建原型链的。

如我们需要定义一个类来表示公司中的股票持有者(com.levinzhang.Shareholder),而公司中的员工可能也会持有股票,于是我们定义一个名为com.levinzhang.ShareholderEmployee的类继承自com.levinzhang.Shareholder和com.levinzhang.Employee。

dojo.declare("com.levinzhang.Shareholder", com.levinzhang.Person,{ 
    share:null, 
    constructor: function(args){ 
        this.share = args.share; 
    }, 
    getShare:function(){ 
        return this.share; 
    } 
}); dojo.declare("com.levinzhang.ShareholderEmployee", [com.levinzhang.Employee,com.levinzhang.Shareholder],{ 
    getInfo:function(){ 
        alert("I'm an Employee with stock.My share is "+this.getShare()+"."+"My name is "+this.getName()+"."); 
    } 
});

在以上的代码中,我们调整了原有的初始化传入参数的格式,由传入多个参数改为传入一个简单JavaScript字面量对象的方式(原有的代码也要稍作调整),并通过多继承的方式实现了一个类用来描述持有股票的员工。测试代码如下:

var shareholderEmployee = new com.levinzhang.ShareholderEmployee({name:"levin",age:30,workExperience:4,share:300}); 
shareholderEmployee.getInfo(); 
//将会提示出“I'm an Employee with stock.My share is 300. My name is Employee:levin.”

关于dojo多继承的更多话题,请参考dojo的文档资料

3) 调用父类的方法

在编程中,我们经常会遇到在子类的某个方法中需要调用父类的方法来协作完成功能。如我们定义名为com.levinzhang.Manager的 类,该类继承自com.levinzhang.Employee类,并重写getInput方法,Manager的收入分为两部分,一部分是与 com.levinzhang.Employee相同的固定收入,另一部分是与管理经验相关的其它收入,这样在定义Manager的时候,就需要调用父类 的方法,实现方式如下:

		
			dojo.declare("com.levinzhang.Manager", com.levinzhang.Employee,{ 
		
			        manageExperience:null, 
		
			        constructor: function(args){ 
		
			            this.manageExperience = args.manageExperience; 
		
			        }, 
		
			        getInput:function(){ 
		
			            var fromBase = this.inherited(arguments); 
		
			            return fromBase+1000*this.manageExperience; 
		
			        }
		
			    })	

	

从以上代码可以看到,通过inherited方法的使用,使得Manager可以调用父类的方法。测试代码如下:

var manager = new com.levinzhang.Manager( 
    {name:"levin",age:30,workExperience:4,manageExperience:2}); 		
			    alert(manager.getInput());//7000		

	

在以上的测试代码中,getInput的返回值为7000,说明该值为子类和父类方法共同确定的。

除了使用inherited来调用父类中的方法以外,从dojo的1.4版本开始提供了链式调用父类方法的功能,能够通过设置自动调用父类的方法,并且支持类似于AOP的before或after配置(dojo正在开发中的1.7版本,提供了更为丰富的AOP功能,我们将会持续关注)。

4. Dojo类机制的其它功能

除了以上介绍的类定义相关功能以外,dojo还提供了许多的便利的工具类供使用。

dojo类所生成对象具有一些特有的属性和方法,常见的如isInstanceOf方法和declaredClass属性,isInstanceOf方法判定对象是否为某个类的实例,而declaredClass属性则能够表明该对象的声明类是什么。如:

var manager = new com.levinzhang.Manager({name:"levin",age:30,workExperience:4,manageExperience:2}); 
alert(manager.isInstanceOf(com.levinzhang.Employee));//提示为true 
alert(manager.isInstanceOf(com.levinzhang.Person));//提示为true 
alert(manager.declaredClass);//提示为“com.levinzhang.Manager”

类机制还涉及到的包管理等功能,限于篇幅,不再展开叙述,感兴趣的读者可以参考dojo的在线文档或图书。

5. 小结

JavaScript本身的类机制比较复杂,对开发人员有着较高的要求,而dojo提供了功能强大的类功能,有些降低了开发的难度。本文简单介绍了dojo类机制的基本功能,包括类定义、继承、静态属性等,这是dojo最基础也是最核心的内容之一,dojo的许多高级功能都是基于此来实现的,因此了解这部分功能的使用方式甚至源码实现对于整体把握dojo框架都大有裨益。

参考资料:

关于作者:

张卫滨,关注企业级Java开发和RIA技术,个人博客:http://lengyun3566.iteye.com

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在,都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多程序园信息
开发小院