利用ajax.dll进行Ajax的开发2 、3

建立页面

现在我们可以开始编码了。创建一个新页面或者打开已有的页面,在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函数所返回的整数。它目前还支持integersstringsdoublebooleansDateTimeDataSetsDataTables,以及自定义类和数组等基本类型。其他所有类型都返回它们的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] = "<table border=1>";
    
for(var i=0; i<ds.Tables[0].Rows.length; i++){
       s[s.length] = "<tr>";
       s[s.length] = "<td>" + ds.Tables[0].Rows[i].FirstName + "</td>";
       s[s.length] = "<td>" + ds.Tables[0].Rows[i].Birthday + "</td>";
       s[s.length] = "</tr>";
     }
     s[s.length] = "</table>";
     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>

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

自定义转换器

我们已经看到,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;
}

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值