ajaxPro.dll用法解析

最新推荐文章于 2015-08-21 13:25:55 发布

mathewsking

最新推荐文章于 2015-08-21 13:25:55 发布

阅读量499

点赞数

分类专栏：学习笔记文章标签： javascript ajax xmlhttprequest callback 服务器 string

学习笔记专栏收录该内容

59 篇文章 0 订阅

订阅专栏

ajaxPro.dll用法解析

引用：

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 函数：

ublic 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 处理：

简言之，上面的代码告诉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 （或者在页面中手工加入以下两行代码）：

其中最后一行的含义是：

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 。对这种最简单的函数，只需要调用该方法并传递两个数字：

当然，我们不希望仅仅用这种强大的能力来警告用户。这就是所有客户端代理（如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 ，我们可以通过下面的代码在客户端显示其中的内容：

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 ：

响应中返回的值实际上是一个对象，公开了和服务器端对象相同的属性（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 ：