在ASP.NET中实现AJAX

在ASP.NET中实现AJAX

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函数:
  1. public int Add(int firstNumber, int secondNumber)
  3. {
  5. return firstNumber + secondNumber;
  7. }
复制代码
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处理:
  1. <configuration>
  3. <system.web>
  5. <httpHandlers>
  7. <add verb="POST,GET" path="Ajax/*.ashx"
  9. type="Ajax.PageHandlerFactory, Ajax" />
  11. </httpHandlers>
  13. ...
  15. <system.web>
  17. </configuration>
复制代码
简言之，上面的代码告诉ASP.NET，和指定路径(Ajax/*.ashx)匹配的任何请求都由Ajax.PageHandlerFactory而不是默认处理程序工厂来处理。不需要创建Ajax子目录，使用这个神秘的目录只是为了让其他HttpHandlers能够在自己建立的子目录中使用.ashx扩展。
建立页面
现在我们可以开始编码了。创建一个新页面或者打开已有的页面，在file后的代码中，为Page_Load事件添加以下代码:
  1. public class Index : System.Web.UI.Page{
  3. private void Page_Load(object sender, EventArgs e){
  5. Ajax.Utility.RegisterTypeForAjax(typeof(Index));     
  7. //...   
  9. }
  11. //...
  13. }
复制代码
调用RegisterTypeForAjax将在页面上引发后面的JavaScript(或者在页面中手工加入以下两行代码):
  1. <script language="javascript" src="Ajax/common.ashx"></script>
  3. <script language="javascript"
  5. src="Ajax/Namespace.PageClass,AssemblyName.ashx"></script>
复制代码
其中最后一行的含义是:
Namespace.PageClass——当前页面的名称空间和类(通常是@Page指令中Inherits属性的值)
AssemblyName——当前页面所属程序集的名称(通常就是项目名)
下面是AjaxPlay项目中sample.aspx页面的结果例子:
  1. <%@ Page Inherits="AjaxPlay.Sample" Codebehind="sample.aspx.cs" ... %>
  3. <html>
  5. <head>
  7. <script language="javascript" src="Ajax/common.ashx"></script>
  9. <script language="javascript"
  11. src="Ajax/AjaxPlay.Sample,AjaxPlay.ashx"></script>
  13. </head>
  15. <body>   
  17. <form id="Form1" method="post" runat="server">
  19. ...
  21. </form>   
  23. </body>
  25. </html>
复制代码
可以在浏览器中手工导航到src路径(查看源代码，复制粘贴路径)检查是否一切正常。如果两个路径都输出一些(似乎)毫无意义的文本，就万事大吉了。如果什么也没输出或者出现ASP.NET错误，则表明有些地方出现问题。
即便不知道HttpHandlers如何工作，上面的例子也很容易理解。通过web.config，我们已经保证所有对Ajax/*.ashx的请求都由自定义的处理程序处理。显然，这里的两个脚本标签将由自定义的处理程序处理。
在ASP.NET中实现AJAX
创建服务器端函数
现在来创建可从客户端调用中异步访问的服务器端函数。因为目前还不支持所有的返回类型(不用担心，将在目前的基础上开发新的版本)，我们继续使用简单的ServerSideAdd函数吧。在file后的代码中，向页面添加下列代码:
  1. [Ajax.AjaxMethod()]
  3. public int ServerSideAdd(int firstNumber, int secondNumber)
  5. {
  7. return firstNumber + secondNumber;
  9. }
复制代码
要注意，这些函数具有Ajax.AjaxMethod属性集。该属性告诉包装器这些方法创建javaScript代理，以便在客户端调用。
客户端调用
最后一步是用JavaScript调用该函数。AJAX包装器负责创建带有两个参数的JavaScript函数Sample.ServerSideAdd。对这种最简单的函数，只需要调用该方法并传递两个数字:
  1. <%@ Page Inherits="AjaxPlay.Sample" Codebehind="sample.aspx.cs" ... %>
  3. <html>
  5. <head>
  7. <script language="javascript" src="Ajax/common.ashx"></script>
  9. <script language="javascript"
  11. src="Ajax/AjaxPlay.Sample,AjaxPlay.ashx"></script>
  13. </head>
  15. <body>   
  17. <form id="Form1" method="post" runat="server">
  19. <script language="javascript">
  21. var response = Sample.ServerSideAdd(100,99);
  23. alert(response.value);
  25. </script>
  27. </form>   
  29. </body>
  31. </html>
复制代码
当然，我们不希望仅仅用这种强大的能力来警告用户。这就是所有客户端代理(如JavaScript Sample.ServerSideAd函数)还接受其他特性的原因。这种特性就是为了处理响应而调用的回调函数:
  1. Sample.ServerSideAdd(100,99, ServerSideAdd_CallBack);
  2. function ServerSideAdd_CallBack(response){
  4. if (response.error != null){
  6. alert(response.error);
  8. return;
  10. }
  12. alert(response.value);
  14. }
复制代码
从上述代码中可以看到我们指定了另外一个参数。ServerSideAdd_CallBack(同样参见上述代码)是用于处理服务器响应的客户端函数。这个回调函数接收一个响应对象，该对象公开了三个主要性质
Value——服务器端函数实际返回的值(无论是字符串、自定义对象还是数据集)。
Error——错误消息，如果有的话。
Request——xml http请求的原始响应。
Context——上下文对象。
首先我们检查error只看看是否出现了错误。通过在服务器端函数中抛出异常，可以很容易处理error特性。在这个简化的例子中，然后用这个值警告用户。Request特性可用于获得更多信息。
在ASP.NET中实现AJAX
处理类型
返回复杂类型
Ajax包装器不仅能处理ServerSideAdd函数所返回的整数。它目前还支持integers、strings、double、booleans、DateTime、DataSets和DataTables，以及自定义类和数组等基本类型。其他所有类型都返回它们的ToString值。
返回的DataSets和真正的.NET DataSet差不多。假设一个服务器端函数返回DataSet，我们可以通过下面的代码在客户端显示其中的内容:
  1. <script language="JavaScript">
  3. //Asynchronous call to the mythical "GetDataSet" server-side function
  5. function getDataSet(){
  7. AjaxFunctions.GetDataSet(GetDataSet_callback);   
  9. }
  11. function GetDataSet_callback(response){
  13. var ds = response.value;
  15. if(ds != null && typeof(ds) == "object" && ds.Tables != null){
  17. var s = new Array();
  19. s[s.length] = "<table border=1>";
  21. for(var i=0; i<ds.Tables[0].Rows.length; i++){
  23. s[s.length] = "<tr>";
  25. s[s.length] = "<td>" + ds.Tables[0].Rows[i].FirstName + "</td>";
  27. s[s.length] = "<td>" + ds.Tables[0].Rows[i].Birthday + "</td>";
  29. s[s.length] = "</tr>";
  31. }
  33. s[s.length] = "</table>";
  35. tableDisplay.innerHTML = s.join("");
  37. }
  39. else {
  41. alert("Error. [3001] " + response.request.responseText);
  43. }
  45. }
  47. </script>
复制代码
Ajax还可以返回自定义类，唯一的要求是必须用Serializable属性标记。假设有如下的类:
  1. [Serializable()]
  3. public class User{
  5. private int _userId;
  7. private string _firstName;
  9. private string _lastName;
  10. public int userId{
  12. get { return _userId; }
  14. }
  16. public string FirstName{
  18. get { return _firstName; }
  20. }
  22. public string LastName{
  24. get { return _lastName; }
  26. }
  28. public User(int _userId, string _firstName, string _lastName){
  30. this._userId = _userId;
  32. this._firstName = _firstName;
  34. this._lastName = _lastName;
  36. }
  38. public User(){}
  40. [AjaxMethod()]
  42. public static User GetUser(int userId){
  44. //Replace this with a DB hit or something :)
  46. return new User(userId,"Michael", "Schwarz");
  48. }
  50. }
复制代码
我们可以通过调用RegisterTypeForAjax注册GetUser代理:
  1. private void Page_Load(object sender, EventArgs e){
  3. Utility.RegisterTypeForAjax(typeof(User));
  5. }
复制代码
这样就可以在客户端异步调用GetUser:
  1. <script language="javascript">
  3. function getUser(userId){
  5. User.GetUser(GetUser_callback);
  7. }
  9. function GetUser_callback(response){
  11. if (response != null && response.value != null){
  13. var user = response.value;
  15. if (typeof(user) == "object"){         
  17. alert(user.FirstName + " " + user.LastName);
  19. }
  21. }
  23. }
  25. getUser(1);
  27. </script>
复制代码
响应中返回的值实际上是一个对象，公开了和服务器端对象相同的属性(FirstName、LastName和UserId)。
在ASP.NET中实现AJAX
自定义转换器
我们已经看到，Ajax .NET包装器能够处理很多不同的.NET类型。但是除了大量.NET类和内建类型以外，包装器对不能正确返回的其他类型仅仅调用ToString()。为了避免这种情况，Ajax .NET包装器允许开发人员创建对象转换器，用于在服务器和客户机之间平滑传递复杂对象。
其他事项
在其他类中注册函数
上面的例子中，我们的服务器端函数都放在执行页面背后的代码中。但是，没有理由不能把这些函数放在单独的类文件中。要记住，包装器的工作方式是在指定类中发现所有带Ajax.AjaxMethod的方法。需要的类通过第二个脚本标签指定。使用Ajax.Utility.RegisterTypeForAjax，我们可以指定需要的任何类。比如，将我们的服务器端函数作为单独的类是合情合理的:
  1. Public Class AjaxFunctions
  3. <Ajax.AjaxMethod()> _
  5. Public Function Validate(username As String, password As String) As Boolean
  7. 'do something
  9. 'Return something
  11. End Function
  13. End Class
复制代码
通过指定类的类型而不是页面就可以让Ajax包装器创建代理:
  1. private void Page_Load(object sender, EventArgs e){
  3. Ajax.Utility.RegisterTypeForAjax(typeof(AjaxFunctions));
  5. //...
  7. }
复制代码
要记住，客户端代理的名称是<ClassName>.<ServerSideFunctionName>。因此，如果ServerSideAdd函数放在上面虚构的AjaxFunctions类中，客户端调用就应该是： AjaxFunctions.ServerSideAdd(1,2)。
代理到底是如何工作的
Ajax工具生成的第二个脚本标签(也可以手工插入)传递了页面的名称空间、类名和程序集。根据这些信息，Ajax.PageHandlerFactory就能够使用反射得到具有特定属性的任何函数的详细信息。显然，处理函数查找具有AjaxMethod属性的函数并得到它们的签名(返回类型、名称和参数)，从能够创建必要的客户端代理。具体而言，包装器创建一个和类同名的JavaScript对象，该对象提供代理。换句话说，给定一个带有Ajax ServerSideAdd方法的服务器端类AjaxFunctions，我们就会得到公开ServerSideAdd函数的AjaxFunction JavaScript对象。如果将浏览器指向第二个脚本标签的路径就会看到这种动作。
返回Unicode字符
Ajax .NET包装器能够从服务器向客户机返回Unicode字符。为此，数据在返回之前必须在服务器上用html编码。比如:
  1. [Ajax.AjaxMethod]
  3. public string Test1(string name, string email, string comment){
  5. string html = "";
  7. html += "Hello " + name + "<br>";
  9. html += "Thank you for your comment <b>";
  11. html += System.Web.HttpUtility.HtmlEncode(comment);
  13. html += "</b>.";
  15. return html;
  17. }
复制代码
在ASP.NET中实现AJAX

SessionState
服务器端函数中很可能需要访问会话信息。为此，只需要通过传递给Ajax.AjaxMethod属性的一个参数告诉Ajax启用这种功能。
在考察包装器会话能力的同时，我们来看看其他几个特性。这个例子中我们有一个文档管理系统，用户编辑的时候会对文档加锁。其他用户可以请求在文档可用的时候得到通知。如果没有AJAX，我们就只能等待该用户再次返回来检查请求的文档是否可用。显然不够理想。使用支持会话状态的Ajax就非常简单了。
首先来编写服务器端函数，目标是循环遍历用户希望编辑的documentId(保存在会话中)并返回所有已释放的文档。
  1. [Ajax.AjaxMethod(HttpSessionStateRequirement.Read)]
  3. public ArrayList DocumentReleased(){
  5. if (HttpContext.Current.Session["DocumentsWaiting"] == null){
  7. return null;
  9. }
  11. ArrayList readyDocuments = new ArrayList();
  13. int[] documents = (int[])HttpContext.Current.Session["DocumentsWaiting"];
  15. for (int i = 0; i < documents.Length; ++i){
  17. Document document = Document.GetDocumentById(documents[i]);
  19. if (document != null && document.Status == DocumentStatus.Ready){
  21. readyDocuments.Add(document);
  23. }       
  25. }
  27. return readyDocuments;
  29. }
  31. }
复制代码
要注意，我们指定了HttpSessionStateRequirement.Read值(还可以用Write和ReadWrite)。
现在编写使用该方法的JavaScript:
  1. <script language="javascript">
  3. function DocumentsReady_CallBack(response){
  5. if (response.error != null){
  7. alert(response.error);
  9. return;
  11. }
  13. if (response.value != null && response.value.length > 0){
  15. var div = document.getElementById("status");
  17. div.innerHTML = "The following documents are ready!<br />";
  19. for (var i = 0; i < response.value.length; ++i){
  21. div.innerHTML += "<a href=\"edit.aspx?documentId=" + response.value[i].DocumentId + "\">" + response.value[i].Name + "</a><br />";
  23. }     
  25. }
  27. setTimeout('page.DocumentReleased(DocumentsReady_CallBack)', 10000);
  29. }
  31. </script>
  33. <body onload="setTimeout('Document.DocumentReleased(DocumentsReady_CallBack)', 10000);">
复制代码
我们的服务器端函数在页面加载时调用一次，然后每隔10秒钟调用一次。回调函数检查响应看看是否有返回值，有的话则在div标签中显示该用户可使用的新文档。
结束语
AJAX技术已经催生了原来只有桌面开发才具备的健壮而丰富的Web界面。Ajax .NET包装器让您很容易就能利用这种新的强大技术。请注意，Ajax .NET包装器和文档仍在开发之
posted @ 2011-03-25 21:43  bingzer  阅读(108)  评论(0)    收藏  举报