posts - 134,  comments - 22,  trackbacks - 0

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

请尝试Michael Schwarz的AJAX .NET包装器,通过它ASP.NET开发人员可以快速方便的部署很容易利用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版本。AjaxDll下载地址:http://www.cnitblog.com/Files/rd416/AjaxDll.zip
本实例源码下载地址:http://www.cnitblog.com/Files/rd416/AjaxTest.zip
解压下载的文件并把ajax.dll放到项目的引用文件夹中。在Visual Studio.NET中有机Solution Explorer的“References(引用)”节点并选择Add Reference(添加引用)。在打开的对话框中,单击Browse(浏览)并找到ref/ajax.dll文件。依次单击Open(打开)和Ok(确认)。这样就可以用AJAX .NET包装器编程了。
      我用的是日文系统,贴出以下图片以供参考。
       1,项目-->右键-->参照追加
       2,
      
      3,
    


建立HttpHandler
为了保证正常工作,第一步是在web.config中设置包装器的HttpHandler。不需要详细解释HttpHandlers是什么及其如何工作,只要知道它们用于处理ASP.NET请求就足够了。比如,所有*.aspx页面请求都由
System.Web.UI.PageHandlerFactory类处理。类似的,我们让所有对ajax/*.ashx的请求由Ajax.PageHandlerFactory处理:
<configuration>    
  <system.web>
  <!--Ajaxの配置 -->
  <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扩展。
建立页面
  现在我们可以开始编码了。创建一个新页面(WebForm1)或者打开已有的页面,在file后的代码中,为Page_Load事件添加以下代码:
private void Page_Load(object sender, System.EventArgs e)
  {
   // ページを初期化するユーザー コードをここに挿入します。

   Ajax.Utility.RegisterTypeForAjax(typeof(WebForm1));
  }

调用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——当前页面所属程序集的名称(通常就是项目名) 
下面是AjaxTest项目中WebForm1.aspx页面的结果例子:

 1<%@ Page language="c#" Codebehind="WebForm1.aspx.cs" AutoEventWireup="false" Inherits="AjaxTest.WebForm1" %>
 2<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" > 
 3
 4<html>
 5  <head>
 6    <title>WebForm1</title>
 7    <meta name="GENERATOR" Content="Microsoft Visual Studio .NET 7.1">
 8    <meta name="CODE_LANGUAGE" Content="C#">
 9    <meta name=vs_defaultClientScript content="JavaScript">
10    <meta name=vs_targetSchema content="http://schemas.microsoft.com/intellisense/ie5">
11    <!--Ajaxの配置  -->
12    <script language="javascript" src="ajax/common.ashx"></script>
13  <script language="javascript" src="ajax/AjaxTest.WebForm1,AjaxTest.ashx"></script>
14  </head>
15  <script language="javascript">
16    function getTextBoxValue(){    
17        
18        WebForm1.getTextBoxValueServer(100,99,getTextBoxValueServer_CallBack);    
19    
20    }

21    
22    function getTextBoxValueServer_CallBack(response){
23        if (response.error != null){
24        alert(response.error); 
25        return
26        }

27        alert(response.value); 
28        document.getElementById("txtValue").value=response.value;
29    }

30    
31    function getDivValue(){    
32        
33        WebForm1.getDivValueServer(getDivValueServer_CallBack);    
34    
35    }

36    
37    function getDivValueServer_CallBack(response){
38        if (response.error != null){
39        alert(response.error); 
40        return
41        }

42        alert(response.value); 
43        document.getElementById("testContent").innerHTML=response.value;
44    }

45            
46            
47            
48 
</script>
49  
50  <body MS_POSITIONING="GridLayout">
51    
52    <form id="Form1" method="post" runat="server">
53        <input type=text value ="aa" id="txtValue"/>
54        <input type=button onclick="getTextBoxValue();" value="TextBoxValue"/>
55        <input type=button onclick="getDivValue();" value="DivValue"/>
56        <div id="testContent" style="WIDTH: 300px; HEIGHT: 200px; BACKGROUND-COLOR: #ff99cc"></div>
57    </form>
58    
59  </body>
60</html>
61

即便不知道HttpHandlers如何工作,上面的例子也很容易理解。通过web.config,我们已经保证所有对ajax/*.ashx的请求都由自定义的处理程序处理。显然,这里的两个脚本标签将由自定义的处理程序处理。
创建服务器端函数
现在来创建可从客户端调用中异步访问的服务器端函数。在WebForm1.cs的代码中,向页面添加下列代码:
 1using System;
 2using System.Collections;
 3using System.ComponentModel;
 4using System.Data;
 5using System.Drawing;
 6using System.Web;
 7using System.Web.SessionState;
 8using System.Web.UI;
 9using System.Web.UI.WebControls;
10using System.Web.UI.HtmlControls;
11
12namespace AjaxTest
13{
14    /// <summary>
15    /// WebForm1 の概要の説明です。
16    /// </summary>

17    public class WebForm1 : System.Web.UI.Page
18    {
19        private void Page_Load(object sender, System.EventArgs e)
20        {
21            // ページを初期化するユーザー コードをここに挿入します。
22
23            Ajax.Utility.RegisterTypeForAjax(typeof(WebForm1)); 
24        }

25
26
27        [Ajax.AjaxMethod()]
28        public int getTextBoxValueServer(int firstNumber, int secondNumber)
29        {
30            return firstNumber + secondNumber; 
31        }

32
33
34        [Ajax.AjaxMethod()]
35        public string getDivValueServer()
36        {
37            string    divStr ="<table border=1 style='color:red'>";
38                    divStr+="<tr>";    
39                    divStr+="<td>";    
40                    divStr+="This is a Test!";
41                    divStr+="</td>";
42                    divStr+="<td>";    
43                    divStr+="Here is a Test!";
44                    divStr+="</td>";
45                    divStr+="</tr>";
46                    divStr+="<tr>";    
47                    divStr+="<td>";    
48                    divStr+="This is a Test2!";
49                    divStr+="</td>";
50                    divStr+="<td>";    
51                    divStr+="Here is a Test2!";
52                    divStr+="</td>";
53                    divStr+="</tr>";            
54                    divStr+="</table>";
55            return divStr; 
56        }

57        Web フォーム デザイナで生成されたコード
76    }

77}

78

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

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

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

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

Context——上下文对象。


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

处理类型

返回复杂类型

Ajax包装器不仅能处理ServerSideAdd函数所返回的整数。它目前还支持integers、strings、double、booleans、DateTime、DataSets和DataTables,以及自定义类和数组等基本类型。其他所有类型都返回它们的ToString值。

返回的DataSets和真正的.NET DataSet差不多。假设一个服务器端函数返回DataSet,我们可以通过下面的代码在客户端显示其中的内容:
 1<script language="JavaScript">
 2//Asynchronous call to the mythical "GetDataSet" server-side function
 3function getDataSet(){
 4AjaxFunctions.GetDataSet(GetDataSet_callback); 
 5}

 6function GetDataSet_callback(response){
 7var ds = response.value; 
 8if(ds != null && typeof(ds) == "object" && ds.Tables != null){
 9var s = new Array(); 
10s[s.length] = "<table border=1>"
11for(var i=0; i<ds.Tables[0].Rows.length; i++){
12s[s.length] = "<tr>"
13s[s.length] = "<td>" + ds.Tables[0].Rows[i].FirstName + "</td>"
14s[s.length] = "<td>" + ds.Tables[0].Rows[i].Birthday + "</td>"
15s[s.length] = "</tr>"
16}

17s[s.length] = "</table>"
18tableDisplay.innerHTML = s.join(""); 
19}

20else 
21alert("Error. [3001] " + response.request.responseText); 
22}

23}

24</script>

Ajax还可以返回自定义类,唯一的要求是必须用Serializable属性标记。假设有如下的类:
 1[Serializable()]
 2public class User{
 3private int _userId; 
 4private string _firstName; 
 5private string _lastName;
 6public int userId{
 7get return _userId; }
 8}

 9public string FirstName{
10get return _firstName; }
11}

12public string LastName{
13get return _lastName; }
14}

15public User(int _userId, string _firstName, string _lastName){
16this._userId = _userId; 
17this._firstName = _firstName; 
18this._lastName = _lastName; 
19}

20public User(){}
21[AjaxMethod()]
22public static User GetUser(int userId){
23//Replace this with a DB hit or something :)
24return new User(userId,"Michael""Schwarz"); 
25}

26}

我们可以通过调用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)); 
//
}

要记住,客户端代理的名称是<ClassName>.<ServerSideFunctionName>。因此,如果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 + "<br>"; 
html += "Thank you for your comment<b>"; 
html += System.Web.HttpUtility.HtmlEncode(comment); 
html += "</b>."; 
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; i 〈 documents.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!<br />"; 
for (var i = 0; i (response.value.length; ++i){
div.innerHTML += "<a href=\"edit.aspx?documentId=" + response.value[i].DocumentId + "\">" + response.value[i].Name + "</a>〈br />"; 
} 
}
setTimeout(''page.DocumentReleased(DocumentsReady_CallBack)'', 10000); 
}
〈/script> 
〈body onload="setTimeout(''Document.DocumentReleased(DocumentsReady_CallBack)'', 10000); ">

结束语

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




posted on 2009-11-25 10:10 TRE-China R&D 阅读(1060) 评论(0)  编辑 收藏 引用 所属分类: AJAXASP.NETC#
只有注册用户登录后才能发表评论。