XCOJS1.0.1使用教程

var intVal &＃61; xco.getIntegerValue("intVal"); //number
var stringVal &＃61; xco.getStringValue("stringVal"); //string
var xcoVal &＃61; xco.getXCOValue("xcoVal"); //XCO
var stringArray &＃61; xco.getStringArrayValue("stringArray"); //[]// ... 更多可参考xco.js


c. 序列化

// XML序列化
var xml &＃61; xco.toXML();// 反序列化
var xco &＃61; new XCO();
xco.fromXML(xml);


d. 以ognl方式访问

xco.get(&＃39;intVal&＃39;);
xco.get(&＃39;xcoVal.stringVal&＃39;);
xco.get(&＃39;stringArray[0]&＃39;);


2. XCO请求

XCO请求是基于AJAX的异步请求&＃xff0c;和普通的AJAX请求区别在于&＃xff1a;

1. contentType为application/xco;charset&＃61;utf-8&＃xff1b;
2. 请求方式为POST
3. 请求参数位于BODY体内&＃xff0c;数据格式为XCO对象序列化后的XML字符串&＃xff1b;

xco.jquery-{version}.js提供了XCO请求的具体实现&＃xff0c;从名字上我们大致可以看出&＃xff0c;XCO请求从实现角度&＃xff0c;是基于jquery的&＃xff0c;因此在使用XCO请求的时候&＃xff0c;我们也需要引入jquery类库。

2.1. 使用示例

XCO请求





**说明&＃xff1a;**关于服务端的接收和处理&＃xff0c;可参考http://www.xson.org/project/web/1.2.0/

2.2. 成功处理

对于请求成功后的处理&＃xff0c;XCO请求还提供多回调函数的支持。

function doSubmit() {var xco &＃61; new XCO();xco.setIntegerValue("id", 1);xco.setStringValue("name", "张三");var options &＃61; {url : "/m1.xco", //请求的URL地址data : xco, //请求的参数&＃xff0c;必须为XCO对象success : [ doCallBack1, doCallBack2, doCallBack3 ]};$.doXcoRequest(options);
}function doCallBack1(data) {// TODO
}
function doCallBack2(data) {// TODO
}
function doCallBack3(data) {// TODO
}


2.3. 结果检测

XCO请求返回的结果是一个XCO对象&＃xff0c;我们可以通过XCO对象的getCode方法拿到请求的状态代码&＃xff08;一般情况下&＃xff0c;0代表处理成功&＃xff0c;非0代表处理失败&＃xff09;&＃xff0c;通过getMessage方法拿到错误信息。对于返回结果&＃xff0c;我们往往会先检测其状态代码&＃xff0c;然后再做业务处理&＃xff1b;我们先看一个示例&＃xff1a;

示例1

function doCallBack(data) {if(1 &＃61;&＃61; data.getCode()){alert(data.getMessage());// 处理错误码1return;}if(2 &＃61;&＃61; data.getCode()){alert(data.getMessage());// 处理错误码2return;}...if(0 &＃61;&＃61; data.getCode()){// 处理正常业务}
}


现在&＃xff0c;我们可以使用另一种方式来实现上面的功能&＃xff1a;

示例2

function doSubmit() {var xco &＃61; new XCO();xco.setIntegerValue("id", 1);xco.setStringValue("name", "张三");var options &＃61; {url : "/m1.xco", //请求的URL地址data : xco, //请求的参数&＃xff0c;必须为XCO对象success : doCallBack&＃xff0c; //成功后的回调函数detector : doDetector //结果检测:该函数只有返回true&＃xff0c;success回调才会执行};$.doXcoRequest(options);
}function doDetector(data) {if(0 &＃61;&＃61; data.getCode()){return true;}if(1 &＃61;&＃61; data.getCode()){alert(data.getMessage());// 处理错误码1} else if(2 &＃61;&＃61; data.getCode()){alert(data.getMessage());// 处理错误码2}return false;
}function doCallBack(data) {// 处理正常业务
}


示例3

function doSubmit() {var xco &＃61; new XCO();xco.setIntegerValue("id", 1);xco.setStringValue("name", "张三");var options &＃61; {url : "/m1.xco", //请求的URL地址data : xco, //请求的参数&＃xff0c;必须为XCO对象success : doCallBack&＃xff0c; //成功后的回调函数detector : [doDetector1, doDetector2]};$.doXcoRequest(options);
}
function doDetector1(data) {if(1 &＃61;&＃61; data.getCode()){alert(data.getMessage());// 处理错误码1return false;} return true;
}
function doDetector2(data) {if(2 &＃61;&＃61; data.getCode()){alert(data.getMessage());// 处理错误码2return false;} return true;
}


示例3中&＃xff0c;我们使用了两个结果检测函数&＃xff0c;只有这两个检测函数都返回true&＃xff0c;success回调才会执行&＃xff0c;任何一个检测函数返回false&＃xff0c;都将结束回调流程。

如果我们希望先检测code是否为0&＃xff0c;如果为0后续则无需再做检测&＃xff0c;该如何做呢&＃xff1f;我们可以将示例3中的代码做如下改动&＃xff1a;

function doDetector1(data) {if(0 &＃61;&＃61; data.getCode()){return IGNORE_FOLLOW_UP; //返回特殊标记&＃xff0c;忽略后续结果检测}// 其他结果检测
}


3. 模板引擎

模板引擎是基于预定义好的模板&＃xff0c;使用填充数据&＃xff08;XCO对象&＃xff09;进行数据填充&＃xff0c;得到渲染后的HTML代码。

XCO模板引擎的优势&＃xff1a;

1. HTML代码和JS代码分离
2. 保持原有的HTML代码和结构
3. 进一步提高编码效率

3.1. 使用示例

定义模板&＃xff1a;

填充数据

**说明&＃xff1a;**doCallBack方法中的data参数为XCO请求后的返回结果&＃xff0c;是一个XCO对象&＃xff0c;用XML格式表示如下&＃xff1a;

渲染后的HTML