Ajax在ASP.NET的应用原理 --转载

======================================================
注：本文源代码点此下载
======================================================

ajax在asp.net的应用原理 --转载

asynchronous javascript and xml(ajax)最近掀起的高潮,要完全归功于google在google suggest和google maps中的使用。对asp.net而言,ajax不需要回传就能进行服务器端处理,从而使客户机(浏览器)具有丰富的服务器端能力。换句话说,它为异步指派和处理请求与服务器响应提供了一个框架。ajax利用了一些不是很新颖的已有技术,但是对这些技术(加到一起就是ajax)的爱好最近突然升温。

请尝试michael schwarz的ajax .net包装器,通过它asp.net开发人员可以快速方便的部署很容易利用ajax功能的页面。需要注意的是,这个包装器处于初期开发阶段,因此还没有完全成熟。

然而,ajax这样的技术很可能破坏分层体系结构(n-tier)。我的看法是,ajax增加了表示逻辑层(甚至更糟,业务层)渗透到表示层的可能性。像我这样严肃的架构师对这种想法可能畏步不前。我感到ajax的使用即便稍微越过了层次边界,这种代价也是值得深思的。当然,这要视具体的项目和环境而定。

起步

它是如何工作的——概述

ajax依靠代理(broker)指派和处理往返服务器的请求。对此,.net包装器依靠客户端xmlhttprequest对象。多数浏览器都支持xmlhttprequest对象,这就是选择它的原因。因为包装器的目的是隐藏xmlhttprequest的实现,我们就不再详细讨论它了。

包装器本身通过将.net函数标记为ajax方法来工作。标记之后,ajax就创建对应的javascript函数,这些函数(和任何javascript函数一样)作为代理可以在客户端使用xmlhttprequest调用。这些代理再映射回服务器端函数。

复杂吗?并不复杂。我们来看一个例子。假设有一个.net函数:

public int add(int firstnumber, int secondnumber)

{

return firstnumber + secondnumber;

}

ajax .net包装器将自动创建名为“add”、带有两个参数的javascript函数。使用javascript(在客户机上)调用该函数时,请求将传递给服务器并把结果返回给客户机。

初始设置

我们首先介绍“安装”项目中使用的.dll的步骤。如果您很清楚如何添加.dll文件引用,可以跳过这一节。

首先,如果还没有的话,请下载最新的ajax版本。解压下载的文件并把ajax.dll放到项目的引用文件夹中。在visual studio.net中有机solution explorer的“references(引用)”节点并选择add reference(添加引用)。在打开的对话框中,单击browse(浏览)并找到ref/ajax.dll文件。依次单击open(打开)和ok(确认)。这样就可以用ajax .net包装器编程了。

建立httphandler

为了保证正常工作,第一步是在web.config中设置包装器的httphandler。不需要详细解释httphandlers是什么及其如何工作,只要知道它们用于处理asp.net请求就足够了。比如,所有*.aspx页面请求都由system.web.ui.pagehandlerfactory类处理。类似的,我们让所有对ajax/*.ashx的请求由ajax.pagehandlerfactory处理:

configuration>

system.web>

httphandlers>

add verb="post,get" path="ajax/*.ashx"

type="ajax.pagehandlerfactory, ajax" />

httphandlers>

system.web>

configuration>

简言之,上面的代码告诉asp.net,和指定路径(ajax/*.ashx)匹配的任何请求都由ajax.pagehandlerfactory而不是默认处理程序工厂来处理。不需要创建ajax子目录,使用这个神秘的目录只是为了让其他httphandlers能够在自己建立的子目录中使用.ashx扩展。

建立页面

现在我们可以开始编码了。创建一个新页面或者打开已有的页面,在file后的代码中,为page_load事件添加以下代码:

public class index : system.web.ui.page{

private void page_load(object sender, eventargs e){

ajax.utility.registertypeforajax(typeof(index));

//

}

//

}

调用registertypeforajax将在页面上引发后面的javascript(或者在页面中手工加入以下两行代码):

script language="javascript" src="ajax/common.ashx">script>

script language="javascript"

src="ajax/namespace.pageclass,assemblyname.ashx">script>

其中最后一行的含义是:

namespace.pageclass——当前页面的名称空间和类(通常是@page指令中inherits属性的值)

assemblyname——当前页面所属程序集的名称(通常就是项目名)

下面是ajaxplay项目中sample.aspx页面的结果例子:

@ page inherits="ajaxplay.sample" codebehind="sample.aspx.cs" %>

html>

head>

script language="javascript" src="ajax/common.ashx">script>

script language="javascript"

src="ajax/ajaxplay.sample,ajaxplay.ashx">script>

head>

body>

form id="form1" method="post" runat="server">

form>

body>

html>

可以在浏览器中手工导航到src路径(查看源代码,复制粘贴路径)检查是否一切正常。如果两个路径都输出一些(似乎)毫无意义的文本,就万事大吉了。如果什么也没输出或者出现asp.net错误,则表明有些地方出现问题。

即便不知道httphandlers如何工作,上面的例子也很容易理解。通过web.config,我们已经保证所有对ajax/*.ashx的请求都由自定义的处理程序处理。显然,这里的两个脚本标签将由自定义的处理程序处理。

创建服务器端函数

现在来创建可从客户端调用中异步访问的服务器端函数。因为目前还不支持所有的返回类型(不用担心,将在目前的基础上开发新的版本),我们继续使用简单的serversideadd函数吧。在file后的代码中,向页面添加下列代码:

[ajax.ajaxmethod()]

public int serversideadd(int firstnumber, int secondnumber)

{

return firstnumber + secondnumber;

}

要注意,这些函数具有ajax.ajaxmethod属性集。该属性告诉包装器这些方法创建javascript代理,以便在客户端调用。

客户端调用

最后一步是用javascript调用该函数。ajax包装器负责创建带有两个参数的javascript函数sample.serversideadd。对这种最简单的函数,只需要调用该方法并传递两个数字:

 

@ page inherits="ajaxplay.sample" codebehind="sample.aspx.cs" %>

html>

head>

script language="javascript" src="ajax/common.ashx">script>

script language="javascript"

src="ajax/ajaxplay.sample,ajaxplay.ashx">script>

head>

body>

form id="form1" method="post" runat="server">

script language="javascript">

var response = sample.serversideadd(100,99);

alert(response.value);

script>

form>

body>

html>

当然,我们不希望仅仅用这种强大的能力来警告用户。这就是所有客户端代理(如javascript sample.serversidead函数)还接受其他特性的原因。这种特性就是为了处理响应而调用的回调函数:

 

sample.serversideadd(100,99, serversideadd_callback);

function serversideadd_callback(response){

if (response.error != null){

alert(response.error);

return;

}

alert(response.value);

}

从上述代码中可以看到我们指定了另外一个参数。serversideadd_callback(同样参见上述代码)是用于处理服务器响应的客户端函数。这个回调函数接收一个响应对象,该对象公开了三个主要性质

value——服务器端函数实际返回的值(无论是字符串、自定义对象还是数据集)。

error——错误消息,如果有的话。

request——xml http请求的原始响应。

context——上下文对象。

首先我们检查error只看看是否出现了错误。通过在服务器端函数中抛出异常,可以很容易处理error特性。在这个简化的例子中,然后用这个值警告用户。request特性可用于获得更多信息。

处理类型

返回复杂类型

ajax包装器不仅能处理serversideadd函数所返回的整数。它目前还支持integers、strings、double、booleans、datetime、datasets和datatables,以及自定义类和数组等基本类型。其他所有类型都返回它们的tostring值。

返回的datasets和真正的.net dataset差不多。假设一个服务器端函数返回dataset,我们可以通过下面的代码在客户端显示其中的内容:

 

script language="javascript">

//asynchronous call to the mythical "getdataset" server-side function

function getdataset(){

ajaxfunctions.getdataset(getdataset_callback);

}

function getdataset_callback(response){

var ds = response.value;

if(ds != null && typeof(ds) == "object" && ds.tables != null){

var s = new array();

s[s.length] = "";

for(var i=0; ids.tables[0].rows.length; i++){

s[s.length] = "

";

s[s.length] = "

" + ds.tables[0].rows[i].firstname + "";

s[s.length] = "

" + ds.tables[0].rows[i].birthday + "";

s[s.length] = "";

}

s[s.length] = "";

tabledisplay.innerhtml = s.join("");

}

else {

alert("error. [3001] " + response.request.responsetext);

}

}

script>

ajax还可以返回自定义类,唯一的要求是必须用serializable属性标记。假设有如下的类:

 

[serializable()]

public class user{

private int _userid;

private string _firstname;

private string _lastname;

public int userid{

get { return _userid; }

}

public string firstname{

get { return _firstname; }

}

public string lastname{

get { return _lastname; }

}

public user(int _userid, string _firstname, string _lastname){

this._userid = _userid;

this._firstname = _firstname;

this._lastname = _lastname;

}

public user(){}

[ajaxmethod()]

public static user getuser(int userid){

//replace this with a db hit or something :)

return new user(userid,"michael", "schwarz");

}

}

我们可以通过调用registertypeforajax注册getuser代理:

private void page_load(object sender, eventargs e){

utility.registertypeforajax(typeof(user));

}

这样就可以在客户端异步调用getuser:

script language="javascript">

function getuser(userid){

user.getuser(getuser_callback);

}

function getuser_callback(response){

if (response != null && response.value != null){

var user = response.value;

if (typeof(user) == "object"){

alert(user.firstname + " " + user.lastname);

}

}

}

getuser(1);

script>

响应中返回的值实际上是一个对象,公开了和服务器端对象相同的属性(firstname、lastname和userid)。

自定义转换器

我们已经看到,ajax .net包装器能够处理很多不同的.net类型。但是除了大量.net类和内建类型以外,包装器对不能正确返回的其他类型仅仅调用tostring()。为了避免这种情况,ajax .net包装器允许开发人员创建对象转换器,用于在服务器和客户机之间平滑传递复杂对象。

其他事项

在其他类中注册函数

上面的例子中,我们的服务器端函数都放在执行页面背后的代码中。但是,没有理由不能把这些函数放在单独的类文件中。要记住,包装器的工作方式是在指定类中发现所有带ajax.ajaxmethod的方法。需要的类通过第二个脚本标签指定。使用ajax.utility.registertypeforajax,我们可以指定需要的任何类。比如,将我们的服务器端函数作为单独的类是合情合理的:

public class ajaxfunctions

ajax.ajaxmethod()> _

public function validate(username as string, password as string) as boolean

'do something

'return something

end function

end class

通过指定类的类型而不是页面就可以让ajax包装器创建代理:

private void page_load(object sender, eventargs e){

ajax.utility.registertypeforajax(typeof(ajaxfunctions));

//

}

要记住,客户端代理的名称是.。因此,如果serversideadd函数放在上面虚构的ajaxfunctions类中,客户端调用就应该是: ajaxfunctions.serversideadd(1,2)。

代理到底是如何工作的

ajax工具生成的第二个脚本标签(也可以手工插入)传递了页面的名称空间、类名和程序集。根据这些信息,ajax.pagehandlerfactory就能够使用反射得到具有特定属性的任何函数的详细信息。显然,处理函数查找具有ajaxmethod属性的函数并得到它们的签名(返回类型、名称和参数),从能够创建必要的客户端代理。具体而言,包装器创建一个和类同名的javascript对象,该对象提供代理。换句话说,给定一个带有ajax serversideadd方法的服务器端类ajaxfunctions,我们就会得到公开serversideadd函数的ajaxfunction javascript对象。如果将浏览器指向第二个脚本标签的路径就会看到这种动作。

返回unicode字符

ajax .net包装器能够从服务器向客户机返回unicode字符。为此,数据在返回之前必须在服务器上用html编码。比如:

[ajax.ajaxmethod]

public string test1(string name, string email, string comment){

string html = "";

html += "hello " + name + "

";

html += "thank you for your comment ";

html += system.web.httputility.htmlencode(comment);

html += ".";

return html;

}

sessionstate

服务器端函数中很可能需要访问会话信息。为此,只需要通过传递给ajax.ajaxmethod属性的一个参数告诉ajax启用这种功能。

在考察包装器会话能力的同时,我们来看看其他几个特性。这个例子中我们有一个文档管理系统,用户编辑的时候会对文档加锁。其他用户可以请求在文档可用的时候得到通知。如果没有ajax,我们就只能等待该用户再次返回来检查请求的文档是否可用。显然不够理想。使用支持会话状态的ajax就非常简单了。

首先来编写服务器端函数,目标是循环遍历用户希望编辑的documentid(保存在会话中)并返回所有已释放的文档。

[ajax.ajaxmethod(httpsessionstaterequirement.read)]

public arraylist documentreleased(){

if (httpcontext.current.session["documentswaiting"] == null){

return null;

}

arraylist readydocuments = new arraylist();

int[] documents = (int[])httpcontext.current.session["documentswaiting"];

for (int i = 0; idocuments.length; ++i){

document document = document.getdocumentbyid(documents[i]);

if (document != null && document.status == documentstatus.ready){

readydocuments.add(document);

}

}

return readydocuments;

}

}

要注意,我们指定了httpsessionstaterequirement.read值(还可以用write和readwrite)。

现在编写使用该方法的javascript:

script language="javascript">

function documentsready_callback(response){

if (response.error != null){

alert(response.error);

return;

}

if (response.value != null && response.value.length > 0){

var div = document.getelementbyid("status");

div.innerhtml = "the following documents are ready!

";

for (var i = 0; iresponse.value.length; ++i){

div.innerhtml += ""edit.aspx?documentid=" + response.value[i].documentid + "\">" + response.value[i].name + "

";

}

}

settimeout('page.documentreleased(documentsready_callback)', 10000);

}

script>

body οnlοad="settimeout('document.documentreleased(documentsready_callback)', 10000);">

我们的服务器端函数在页面加载时调用一次,然后每隔10秒钟调用一次。回调函数检查响应看看是否有返回值,有的话则在div标签中显示该用户可使用的新文档。

结束语

ajax技术已经催生了原来只有桌面开发才具备的健壮而丰富的web界面。ajax .net包装器让您很容易就能利用这种新的强大技术。请注意,ajax .net包装器和文档仍在开发之中。

======================================================
在最后，我邀请大家参加新浪APP，就是新浪免费送大家的一个空间，支持PHP+MySql，免费二级域名，免费域名绑定 这个是我邀请的地址，您通过这个链接注册即为我的好友，并获赠云豆500个，价值5元哦！短网址是http://t.cn/SXOiLh我创建的小站每天访客已经达到2000+了，每天挂广告赚50+元哦，呵呵，饭钱不愁了，\(^o^)/