- var Tbi = new Object(); //全局命名空间
为啥叫“Tbi”?就不要问了,项目组的名称而已,呵呵:)接下来考虑我们的模板基类,他有什么特征呢?
1、需要持有一个到页面容器的引用,以便将自身加入页面流;
2、需要保存用户设定的每页显示条目数;
3、需要保存获取分页数据的服务器端地址(URL);
这些成员可以通过构造器来初始化,除此之外,为了避免数据更新发生混乱(这个在异步非缓存的时候需要注意),还要有一个全局异步对象来获取数据,但不需要通过参数提供。
定义了成员变量,模板对象还需要有可操作的方法:
1、构造函数:initialize,这个方法在构建Prototype风格构建类,实例化对象的时候会自动调用。另外有一些技巧下面会提到;
2、在数据获取过程中,显示等待信息的方法:_showMessage,这里只是简单显示一句话,可以按需替换成显示图片等;
3、显示模板初始页面的show方法(其中有两个故意设计的事件入口,供今后扩展使用):
A、调用beforeShow,默认为空方法,什么也不做,可按需设定;
B、调用_display方法,显示模板初始页面:
a、调用2中的方法显示等待信息;
b、调用_catchContent方法异步获取服务器数据。此方法可由所有模板共用,因此放到基类中达到代码重用。可以看到,
我们为了细粒度的控制Prototype的ajax封装,使用了transport属性。
c、在成功返回服务器数据之后,addContent方法将把分页内容添加到容器中,分两步来做:
(1) addPage方法作为回调函数添加模板主体——抽象方法,由子类实现。
(2) addNavigation方法根据实际情况生成并添加分页导航——抽象方法,我将它在一个子类中实现然后演示混入(mixin),其实完全可以在基类中提供达到同样的代码复用效果。
- /*
- * 模板基类
- */
- Tbi.Template = Class.create();
- Tbi.Template.prototype = {
- initialize: function(){
- this._init.apply(this,arguments);
- },
- _init: function(wrap,items,catchUrl) {
- this.wrap = $(wrap);
- this.items = items;
- this.catchUrl = catchUrl;
- this.ajax = null; //全局异步对象
- },
- // 显示等待信息
- _showMessage: function(text){
- this.wrap.innerHTML = text;
- },
- // 显示模板默认页面
- show: function(){
- this.beforeShow(); //显示前事件处理入口
- this._display();
- this.afterShow(); //显示后时间处理入口
- },
- // 显示前事件处理入口
- beforeShow: function(){},
- _display: function(){
- this._showMessage("正在获取数据,请稍等……");
- this._catchContent();
- },
- //取得默认页面内容,由两个模板公用
- _catchContent: function(){
- if(this.ajax){
- this.ajax.transport.abort();
- }
- this.ajax = new Ajax.Request(
- this.catchUrl,
- {
- method: "get",
- parameters: {"mode":this.mode,"items":this.items},
- onComplete: this.addContent.bind(this)
- }
- );
- },
- // 添加页面内容
- addContent: function(xmlhttp){
- this.addPage(xmlhttp); //抽象方法,添加页面内容
- this.addNavigation(); //抽象方法,添加分页导航
- },
- // 显示后事件处理入口
- afterShow: function(){}
- }
一些技巧:
为了实现在子类中覆盖initialize构造函数,我们只需要将基类的成员初始化工作委托给_init方法即可,下面会看到他的作用。
模仿事件处理机制,我们留下了两个事件入口beforeShow和afterShow,分别可以设置显示前事前和显示后事件。
Prototype为Function对象扩展了一个bind方法和bindAsEventListener方法,可以很方便的将函数上下文(this)切换为别的对象,这里,我们切换为模板对象。bind和bindAsEventListener的功用相似,但是有一点区别,用bind切换的方法,如果有自动传入的参数,比如事件对象event,那么这个参数将被自动传入函数参数列表的最后,而后者则是自动传入函数参数列表的最前面,这个技巧很常用。比如改写一下上面的代码,我给onComplete事件传入一个自定义参数tmyArg,使用两种不同的绑定方法(xmlhttp是Prototype自动传入回调函数的参数):
- //用bind方法
- this.addContent.bind(this,myArg)
- //调用方式
- this.addContent(myArg,xmlhttp)
- //用bindAsEventListener方法
- this.addContent.bindAsEventListener(this,myArg)
- //调用方式
- this.addContent(xmlhttp,myArg)
第二步,实现静态模板类StaticTemplate。对于静态模板,其显示过程是这样的:向服务器发起一次异步请求,返回所有分页数据,服务器按照客户设定的每页显示数量来生成所有页,一次新传回客户端。每一页由一对tbody元素定义,然后通过css类名来讲所有的页面隐藏,最后由客户端js来控制显示页面,初始显示第一页。服务器返回的数据格式如下(只要结构一样就可以了,没有行、列数目的限制,这可以参看前一篇文章中的css设定了解,是可以随表格大小伸缩的),总条目数为6,分了两页:
- <table id='pages'>
- <caption>静态分页模板</caption>
- <thead>
- <tr>
- <th>标题一</th>
- <th>标题二</th>
- <th>标题三</th>
- <th>标题四</th>
- <th>标题五</th>
- <th>标题六</th>
- </tr>
- </thead>
- <tbody class='hidden'>
- <tr>
- <td>1</td>
- <td>1</td>
- <td>1</td>
- <td>1</td>
- <td>1</td>
- <td>1</td>
- </tr>
- <tr>
- <td>2</td>
- <td>2</td>
- <td>2</td>
- <td>2</td>
- <td>2</td>
- <td>2</td>
- </tr>
- <tr>
- <td>3</td>
- <td>3</td>
- <td>3</td>
- <td>3</td>
- <td>3</td>
- <td>3</td>
- </tr>
- <tr>
- <td>4</td>
- <td>4</td>
- <td>4</td>
- <td>4</td>
- <td>4</td>
- <td>4</td>
- </tr>
- </tbody>
- <tbody class='hidden'>
- <tr>
- <td>5</td>
- <td>5</td>
- <td>5</td>
- <td>5</td>
- <td>5</td>
- <td>5</td>
- </tr>
- <tr>
- <td>6</td>
- <td>6</td>
- <td>6</td>
- <td>6</td>
- <td>6</td>
- <td>6</td>
- </tr>
- </tbody>
- </table>
StaticTemplate类中,addPage方法统计table中tbody元素的个数来确定总页数,并附加到对象上。以供addNavigation方法成分页导航信息:
- this.pageTotal = this.wrap.getElementsByTagName("tbody").length;
在addNavigation方法中,又一次用到了前面提过的bindAsEventListener技巧,并通过切换css类名来达到突出显示当前页码以及显示页面。
具体的StaticTemplate代码实现如下:
- /*
- * 静态模板,一次请求全部数据
- */
- Tbi.StaticTemplate = Class.create();
- Tbi.StaticTemplate.prototype = Object.extend(new Tbi.Template(),
- {
- /*
- * 构造函数,实例化静态模板
- * 参数:父容器,每页显示条目数,数据获取地址
- */
- initialize: function(wrap,items,catchUrl){
- this._init(wrap,items,catchUrl);
- this.mode = "static";
- },
- // 实现父类抽象方法,向页面添加默认分页
- addPage: function(xmlhttp){
- this.wrap.innerHTML = xmlhttp.responseText;
- this.pageTotal = this.wrap.getElementsByTagName("tbody").length;
- var table = $("pages");
- var pages = $A(table.getElementsByTagName("tbody"));
- displayPage = pages[0];
- displayPage.className = "";
- },
- // 实现父类抽象方法,向页面添加分页导航
- addNavigation: function(){
- if(this.pageTotal>1){
- var navigation = document.createElement("div");
- navigation.id = "navigation";
- var context = this;
- $R(1,this.pageTotal,false).each(
- function(item){
- var link = document.createElement("a");
- link.href = "#";
- link.onclick = context._changePage.bindAsEventListener(context,link);
- link.appendChild(document.createTextNode(item));
- if(item==1){
- link.className = "active";
- }
- navigation.appendChild(link);
- }
- );
- this.wrap.appendChild(navigation);
- }
- },
- // 导航链接点击事件处理函数,切换页面内容,同时改变导航链接样式(突出显示当前页)
- _changePage: function(event,link){
- var activeLink = $$('#TMPwrap div a[class="active"]')[0];
- if(activeLink != link){
- var pages = $$("#TMPwrap tbody");
- var oldPage = pages.find(
- function(item){
- return item.className == "";
- }
- );
- var newPage = pages[link.firstChild.nodeValue-1];
//inner系列属性不兼容ff
- oldPage.className = "hidden";
- newPage.className = "";
- activeLink.className = "";
- link.className = "active";
- }
- Event.stop(event);
- }
- }
- );
这样,我们就完成了静态分页模板的设计和实现,下一步是实现动态异步的两种获取方式模板。
在前面两篇文章中,我们实现了静态表格分页模板,下面让我们继续讨论,如何实现另外两种数据获取方式的模板。要缓解服务器的压力,我们可以这样做:
1、显示初始页面也就是第一页的时候,我们构造好表头、标题和第一页的数据,并按照服务器返回的总页数生成导航链接,之后将不再更新这部分重复的内容;
2、对于每一页新内容,我们在点击页码链接的时候再动态向服务器获取数据,服务器根据所请求的页码返回特定页的内容,替换掉当前显示的页面数据,这样可以减少网络带宽的使用,毕竟每次只返回一页的内容;
3、对于数据更新频繁的分页系统,就按照上面的办法每次获取新数据;而对于不是很频繁的数据,我们提供一种客户端缓存机制来加快响应速度和减轻服务器压 力:通过一个全局的cache数组来存放服务器端之前返回的数据,在切换页面的时候,先查询缓存,如果没有命中,再向服务器发起异步请求,当响应到达的时 候,也会将此次数据存入缓存以供使用。
按照上面的分析,可以发现这两种数据获取方式的模板有很多相似的地方,不同的只是缓存与否,我们可以将他们抽象成同一个类来实现,下面是javascript代码,我将在后面就一些需要注意的地方做详细讲解: