使用ASP.NET AJAX异步调用.aspx页面中的类方法

让客户端JavaScript直接能够异步调用到服务器端的Web Service，这看起来真的是个不错的主意——理想化的分层Ajax应用程序就应该这样嘛！不过作为被ASP.NET服务器端开发模型“宠坏”了的我们，更加熟悉的方法是直接将方法写在ASP.NET页面中，比如处理页面中的某个服务器端按钮Click事件的代码，就可能这样调用定义在同一张页面代码文件中的方法：

protected void Button1_Click(object sender, EventArgs e)

{

    myLabel.Text = this.GetTextForLabel();

}

public string GetTextForLabel()

{

    // ......

    return "Some Text";

}

对于那些“遗留”的ASP.NET应用程序来讲，这样直接定义在ASP.NET页面中的方法更是相当常见。若是仅仅为了配合ASP.NET AJAX的客户端访问Web Service功能，就将这些方法一一迁移到Web Service中，岂不是非常麻烦？

好在ASP.NET AJAX在设计时考虑到了这个问题，并提供给我们一种作为替代的选择。ASP.NET AJAX异步通讯层能够将声明在ASP.NET页面中的公有的类方法（C#中的static，VB.NET中的Shared）当作Web Service中声明的方法一样对待，为其生成类似的客户端调用代理。

我们还是通过一个实例程序来了解这个功能。该示例程序的功能与界面均与前面一节中的完全一致，唯一的不同就是，客户端异步调用的不再是某个Web Service，而是定义在ASP.NET页面中的类方法。

首先是定义在ASP.NET页面中的类方法，完整的方法声明如下：

[WebMethod]

public static string SayHelloFromPage(string name)

{

    return string.Format("Hello {0}!", name);

}

特别需要注意的是，若要让ASP.NET AJAX为其生成客户端调用代理，那么一定要为该方法添加[WebMethod]属性。

然后是ScriptManager控件，注意粗体部分代码设置了EnablePageMethods属性为true，这也是让客户端能够直接调用服务器端页面方法所必需的。若你忘记了设定该属性，那么程序将无法完成预期功能：

<asp:ScriptManager  EnablePageMethods="true" runat="server" />

程序界面中的UI元素和前一个节中的示例程序完全一致，这里不赘：

<input  type="text" />

<input  type="button" value="Say Hello" 

    onclick="return btnInvoke_onclick()" />

<div ></div>

而本示例程序中按钮的click事件处理函数以及异步调用的回调函数则需要一定的修改，如下所示：

function btnInvoke_onclick() {

    var theName = $get("tbName").value;

    PageMethods.SayHelloFromPage(theName, onSayHelloSucceeded);

}

function onSayHelloSucceeded(result) {

    $get("result").innerHTML = result;

}

注意上述代码中的粗体部分。可以看到，调用页面方法代理时统一的前缀为PageMethods。接下来是页面方法的名称，这里为SayHelloFromPage()，其参数列表和C#中方法的定义一致，额外的一个参数表示本次异步调用的回调函数。即语法为：

PageMethods.[MethodName](param1, param2 …, callbackFunction);

这样即完成了本示例程序，运行一下，我们将会看到如图3-1和图3-2一样的界面。

总结：想要使用ASP.NET AJAX在客户端JavaScript中异步调用定义在ASP.NET页面中的方法，我们需要：

1. 将该方法声明为公有（public）；
2. 将该方法声明为类方法（C#中的static，VB.NET中的Shared），而不是实例方法；
3. 为该方法添加[WebMethod]属性；
4. 将页面中ScriptManager控件的EnablePageMethods属性设置为true；
5. 在客户端使用如下JavaScript语法调用该页面方法：

   PageMethods.[MethodName](param1, param2 …, callbackFunction)；

6. 为客户端异步调用指定回调函数，在回调函数中接收返回值并进一步处理。