关键字类别

ESOE关键字依使用方式分为4个类别 (Category)

类别
关键字
替代方案
说明
c1
$esoe
prototype._esoe
[object]._esoe
1. 如果c1关键字发生冲突, ESOE引擎将无法工作
c2
_ns
_package
_normalize
_import
_derive
_derivex
_setpath (M2)
_getpath (M2)
_loadres (M2)
_update (M3)
$esoe.*
1. 替代方案指将关键字替代为$esoe的对应方法. 如_package用$esoe._package替代.
2. 如果c2关键字发生冲突, 可使用nokey参数关闭这些关键字, 并使用替代方案.
3. 在应用系统的发行版, 如果要兼容非ESOE系统, 最好使用替代方案.
c3
prototype._base
prototype._pkg
prototype._esoe.*
1. 替代方案指将关键字替代为prototype._esoe的对应属性. 如_base用_esoe._base 替代.
2. 对ESOE对象, c3关键字等同c4 关键字, 应由用户主动避免冲突.
3. 当规范化非ESOE对象时, 如果c3关键字发生冲突, 可关闭这些关键字, 并使用替代方案.
c4
[func]._declare
prototype._set
prototype._destroy (M4)
prototype._share (M5)
$esoe.Share (M5)
1. c4 关键字只用于ESOE对象, 理论上不会发生冲突, 或应由用户主动避免冲突.

	创建ESOE对象

ESOE对象由一空Object对象创建.
	window.$esoe= new Object;

	ESOE对象参数

ESOE引擎具有可由外部传入的参数

_param
保存所有参数以备将来使用.
_path
ESOE引擎的物理路径
_module
指示要加载的模块的字串, 可选的模块代码为1,2,3,4,5. 其中1为默认加载的核心模块, 可省略. 其它模块代码以','分隔.
例子:
"1"          M1 (默认)
"2"          M1+M2
"4,5"        M1+M4+M5
_debug
调试级别参数, 当前版本可设为以下值,
0: 不调试 (默认)
1: 设置为最低的调试级别
9: 设置为最高的调试级别
_nokey
c2 关键字冲突列表, 如果设为'*', 禁用所有c2关键字.
_libpath (M2)
默认类库加载路径, 只可设置1个. 如果未设置, 使用_path作为默认路径.
_libmode (M3)
默认类库/类文件加载模式
0: 不加载任何默认类库/类文件 (默认).
1: 先加载默认类库文件, 再加载类文件.
2: 先加载类文件, 再加载默认类库文件.
3: 仅加载默认类库文件.
4: 仅加载类文件
说明:
1. 对实际的应用系统, 并非所有的加载模式都可正常工作, 应根据调试/发行/配置等具体情况进行设置.
_nodestroy (M4)
在将来, 对于较完善的ECMAScript实现系统, 如果不存在内存泄漏问题, 可以关闭清理函数机制. 可选值, 0 (默认) 或1.

	名称空间定义

名称空间是用对象链表示的对象位置的一种方法. 在ESOE中, 任何对象链都可被称为名称空间. 对象链的根节点必然是全局对象(GLOBAL)或某个指定对象的属性, 在ESOE中称这个对象映射(Map)了所有的这个名称空间.

例如:
var obj= new Object;
obj.com= new Object;
obj.com.mycompany= new Object;
obj.com.mycompany.myclass= new Object;

以上过程在obj对象中映射了("com", "com.mycompany", "com.mycompany.myclass")名称空间, 也可以称为是在obj.com对象中映射了("mycompany", "mycompany.myclass")名称空间, 以此类推. 特别地, 也可称为在GLOBAL对象映射了"obj.com.mycompany.myclass"名称空间.

	包定义

在ESOE中, 包特指在名称空间中, 为构造下一级子对象所建立的空对象, 或者是可以构造下一级子对象的对象.

名称空间的每一个具有包概念的元素都必须是可以添加属性的对象, 如Object对象, Function对象, Array 对象等, 不可添加属性的对象不可以作为包对象, 如Number对象, String对象, Boolean对象, undefined, null等.

在ESOE中, 名称空间的末级对象是类的构造器, 但为了兼容加载非ESOE系统, 末级对象可以是其它任意可以添加属性的对象.

	ESOE的名称空间 / _ns() / _package()

ESOE载入所有类库都映射于$esoe.ns.

根据用户的要求, 已载入的类库可以在全局对象(GLOBAL)下重新映射出另一名称空间并建立引用对象. 或者在用户自定义的对象中映射并建立引用对象.

_ns关键字也用于获取已存在的名称空间对象.

_package() 关键字与_ns() 完全相同, 方便与其它系统快速兼容.

	规范化非ESOE构造器

为了快速兼容现有的大多数系统, 可以将一个现存在类文件经过少许改动, 调用规范化过程将它映射到ESOE的名称空间. 

规范化非ESOE构造器不会设置prototype.constructor.

	规范化非ESOE对象

现存的一些类库系统, 有可能使用了全局变量. 为了快速兼容这些系统, ESOE允许将任意可以添加属性的对象映射到ESOE的名称空间. 当映射非ESOE对象, _esoe属性直接添加到对象中. 

规范化非ESOE对象不会设置prototype.constructor.

	名称空间的物理映射

可以将一个名称空间映射到文件物理路径. 名称空间中的每一个包对象映射为一个同名的文件夹, 每个末端类对象映射为一个同名的文件. 经过简单的转换后, ESOE系统可以确定从何处自动加载类库文件.

例如, 名称空间com.mysite.myclass可以映射到物理路径com/mysite/myclass.[扩展名].

另外, 为了提高加载效率, 每个包对应的文件夹下可以放置一个_all.[扩展名]的文件, 文件中包括这个包下所有直接的类库. 通过设置ESOE参数_libmode可以加载这个文件.

	设置物理路径 / _setpath() / _getpath()

使用_setpath()可以指定一个包所在的路径, 每个包可以指定一个路径. 一个包所包含的下一级包可以指定不同的路径. 调用 _setpath() 时路径信息被存放在$esoe._lib对应的名称空间的$path属性下.

使用_getpath()可以提取出一个包或类所在的路径. 提取出的路径包括对本包所设置的路径, 附加上本包的名称. 对于类路径, 与包路径相同, 仅须加上文件的扩展名.

例子:
如果同时设置了
	_setpath("com","../lib/" );
	_setpath("com.mylib","../lib2/" );
那么
	"com.xtree.WebFXTree" 将从 ../lib/com/xtree/WebFXTree 加载
	"com.mylib.class1"将从../lib2/ mylib/class1加载

	类库文件自动加载 (M3)

当ESOE系统发现一个类的构造器未加载时, 会将类的名称记录于$esoe._lib对应名称空间的$fail, 并将_import的全局参数记录在$map (非全局参数不记录). 然后会尝试自动加载类库.

系统根据$esoe._libmode确定是先加载类文件还是整个包的类库文件_all. 在确认未重复加载的情况下进行以下工作,

* 如果加载了任何文件, $esoe._lib.$count加1.
* 如果是加载_all文件, $esoe._lib.$ext会置1.
* 如果加载了文件, 将$esoe._lib对应类或包的名称空间的$inc加1.
* 如果$esoe._lib.$ext已置1, 不加载类文件, 只加载_all文件.

	类定义

在ESOE中, 类特指构造器的原型 (constructor's prototype). 但构造器也可用于指示类, 构造器和原型在对类的描述上处于同一级别.

每一个类的构造器都应该具有一个声明函数 (_declare), 这个函数是一个不带参数的函数 (Function) 对象. 
	[constructor]._declare= function()
	{
		...
	}

在声明函数中, 构造器的原型可以被创建, 并且进行初始化. 如果类声明过程成功完成, _declare应返回true, 如果类声明过程出现错误, _declare应返回false. 声明函数是一个被ESOE系统所使用的回调函数.

在声明函数中, 必须进行类规范化操作.

如果要在声明函数中定义原型的方法, 应注意这些方法是使用闭包函数的方式定义的, 应减少在声明函数内和闭包函数外的位置定义新的变量. 声明函数是一个不带参数的函数, 也是为了避免这个问题.

	this

ESOE建议在对类的方法进行调用时, 要确保提供正确的this对象, 而不应将this对象设为另一个对象, 如GLOBAL对象等.

在this对象容易发生混淆的情况下, 建议在直接在参数中指明this对象.

	类导入 / _import()

类导入与类的规范化相似, 但是用户可指定名称空间的映射对象.

当用户导入一个类时, ESOE系统自动调用构造器的声明函数. 这时, 构造器的原型尚未被任何实例所引用, 因为在此之前, 还未有任何语包执行 new [构造器] 来创建构造器的第一个实例.

在M3中, 一个类如果还未正常载入, 导入过程会记录下这个类, 以供后续的自动加载工作使用.

	类继承 / _derive()

在ESOE中, 如果一个类继承自一个基类, 将继承类的原型设置为基类的一个新实例.
	[class].prototype= new [baseclass];
这一语句隐含在ESOE系统的 _derive() 过程中. 在_derive() 过程中还包括对基类和继承类的规范化操作.

如果类继承成功, 系统会添加以下属性到继承类的原型中,
	_esoe._base : 基类所对应的构造器的prototype.
如果_esoe._conflict不为1, 为方便用户使用, 继承操作会做以下工作,
	func.prototype._base= func.prototype._esoe._base;

在继承类声明函数中, 应该使用 _derive([thisclass],[baseclass]) 设置类继承关系, 而不应该直接设置prototype的值.

如果未加载M3, 所有的基类应被预先加载, 否则_dervice返回false, 继承类声明失败.

如果已加载M3, 如果基类未加载, _dervice返回false, 这时继承类的声明函数也应返回false, 等待下一次重新声明.

	多继承和属性拷贝 / _derivex()

ESOE利用属性拷贝来实现多继承. _derivex()将指定的基类的所有可见属性拷贝到继承类, 拷贝过程如有属性的名称发生冲突, 则忽略这个属性.

属性拷贝仅拷贝那些简单型变量, 如String, Number, Boolean, null等, 对于对象变量, 仍然只拷贝其引用, 如Object, Array, Function等.

	类属性的修饰

在ESOE中, 建议用户在构造器或声明函数中使用以下方式实现对类属性的修饰.

内在修饰
类型
属性声明位置
访问位置
1
private
任意
构造函数, var声明
构造函数
2
static, private
任意
独立的声明函数, var声明
声明函数
3
public
变量
使用prototype.[propety]  声明简单变量, 并直接赋值
任意
4
static, public
对象
使用prototype.[propety]  声明对象变量, 并直接赋值
任意
5
public
对象
使用prototype.[propety]  声明对象变量, 并在_set()中赋值
任意

其中, 变量指简单变量, 如String, Number, Boolean, null等; 对象指对象变量, 如Object, Array, Function等.

ESOE建议只使用表中的3,4,5方式. 方式1和2虽然可以实现属性隐藏等功能, 但同时带来代码格式不统一, 闭包函数等问题. 如果确实有必要使用, 应尽可能减少不必要的变量引用, 并使用清理函数机制.

	类实例初始化 / _set()

ESOE系统不支持在声明时附加参数, 也就是不支持类初始化参数, 但支持类实例初始化参数.

每一个ESOE类的原型都应带有一个_set()方法, 以对类实例进行初始化. 这个方法建议使用与构造器相同的参数. _set()方法在以下情况使用,

1. 在类实例化时调用_set()方法. 
2. 在有类继承的情况下, 继承类在声明时, 会调用无参数的基类构造器过程, 这时由基类自行处理_set()的无参数调用方式.
3. 在有类继承的情况下, 继承类在其自己的_set 方法中, 以call方式调用基类的_set 方法,
	this._base._set.call( this, ... );

	使用其它类

如果在类中要使用其它类, 在声明函数必须先导入这些类, 以备以后使用.

	类布局例子1

这里是一个从ESOE类向导生成的一个例子 (经过简单改动) .
1. 构造器除了作为创建对象的构造器外, 当作为函数直接调用时, 还作为对类的声明函数的调用, 这样可以减少对关键字_declare的依赖性.
2. 在声明函数中, 是用闭包函数的方法对原型方法进行定义的, 但由于没有参数和变量, 避免了部分闭包函数带来的引用问题.

	共享 $esoe 对象

ESOE通过以下方法实现$esoe对象共享

1. 在新环境构建一个空对象$esoe(从属ESOE), 此对象的原型是另一个已存在的$esoe.
2. 设置新$esoe的_global属性为新的全局对象.
3. 构建新的$esoe.ns和$esoe._lib变量.
4. 设置相关的关键字函数