ASP.NET 使用Ajax

时间  2019-12-12
标签 asp.net asp 使用 ajax 栏目 ASP 繁體版
原文   原文链接

 

以前在Ajax初步理解中介绍了对Ajax的初步理解，本文将介绍在ASP.NET中如何方便使用Ajax，第一种固然是使用jQuery的ajax，功能强大并且操做简单方便，第二种是使用.NET封装好的ScriptManager。javascript

$.ajax向普通页面发送get请求

这是最简单的一种方式了，先简单了解jQuery ajax的语法，最经常使用的调用方式是这样：$.ajax({settings}); 有几个经常使用的setting，所有参数及其解释能够去jQuery官方API文档查询css

1. type:请求方式 get/posthtml

2. url:请求的Uri前端

3. async：请求是否为异步java

4. headers：自定义的header参数jquery

5. data：发往服务器的参数ajax

6. dataType：参数格式，常见的有string、json、xml等正则表达式

7. contents：决定怎样解析response的一个”字符串/正则表达式” mapjson

8. contentType：发送到服务器的额数据的内容编码类型，它的默认值是"application/x-www-form-urlencoded; charset=UTF-8""。api

9. success:请求成功后调用的句柄

10.error：请求失败后调用的句柄

没使用过jQuery的ajax话这样看有些云里雾里的感受,来看一个简单例子

首先使用Visual Studio新建一个WebApplication，把jQuery.js引入project，而后添加两个页面，Default.aspx做为测试用

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="Web.Default" %>
<!DOCTYPE html >
<html>
<head runat="server">
    <title>Ajax</title>
    <script src="jQuery.js" type="text/javascript"></script>
    <style type="text/css">
        html, body, form
        {
            width: 100%;
            height: 100%;
            padding: 0px;
            margin: 0px;
        }
        
        #container
        {
            margin: 100px;
            height: 300px;
            width: 500px;
            background-color: #eee;
            border: dached 1px #0e0;
        }
    </style>
</head>
<body>
    <form id="form1" runat="server">
    <div id="container">
        <input type="button" value="Test Ajax" onclick="testGet()" />
        <br />
    </div>
    <script type="text/javascript">
        function setContainer(text) {
            document.getElementById("container").innerHTML += ('<br/>' + text);
        }

        function testGet() {
            $.ajax({
                type: 'get',
                url: 'NormalPage.aspx',
                async: true,
                success: function (result) {
                    alert(result);
                },
                error: function () {
                    setContainer('ERROR!');
                }
            });
        }
    </script>
    </form>
</body>
</html>

NormalPage.aspx做为请求页面，先不作任何处理。在Default.aspx页面中的JavaScript中能够看到testGet函数就利用jQuery的ajax向Normal.aspx发送了了一个get请求，没写的参数使用jQuery默认参数，这个调用没使用任何参数，简单向Normal.aspx页面发送请求，请求成功则alert所有response（即success方法参数：result，jQuery会把responseText传入success方法第一个参数），请求失败则向DIV中添加一行错误提示文本。若是一切正常，能够看到页面弹出对话框，对话框内内容便是Normal.aspx页面内容

image

一个简单的get请求完成了，这样的结果通常没有多大用处，也不是ajax意图所在，使用Ajax主要是想使用JavaScript能够异步向服务器发送特定请求，获取服务器相关数据，好比向服务器询问天气，而后得到天气数据，更新页面，而不是获取整个页面，换句话说，使用Ajax自己就是为了摆脱更新整个页面来更新页面数据这种模式，仅仅须要服务器给咱们数据便可，这就须要调用服务器端的特定方法。

$.ajax GET请求调用服务器特定方法

咱们这时候须要修改NormalPage.aspx，为其添加几个方法供Default.aspx测试调用

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Web
{
    public partial class NormalPage : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            string action = Request.QueryString["action"];
            Response.Clear(); //清除全部以前生成的Response内容
            if (!string.IsNullOrEmpty(action))
            {
                switch (action)
                {
                    case "getTime":
                        Response.Write(GetTime());
                        break;
                    case "getDate":
                        Response.Write(GetDate());
                        break;
                }
            }
            Response.End(); //中止Response后续写入动做，保证Response内只有咱们写入内容
        }


        private string GetDate()
        {
            return DateTime.Now.ToShortDateString();
        }

        private string GetTime() 
        {
            return DateTime.Now.ToShortTimeString();
        }
    }
}

而后为Default.aspx添加一个新的方法，并修改button的onclick方法为新写的函数

function testGet2() {
            $.ajax({
                type: 'get',
                url: 'NormalPage.aspx',
                async: true,
                data:{action:'getTime'},
                success: function (result) {
                    setContainer(result);
                },
                error: function () {
                    setContainer('ERROR!');
                }
            });
        }

testGet2函数是在testGet函数的基础上作了些许修改，首先对success方法作了更改，把获得的response写到页面；而后对请求添加了data参数，请求向服务器发送了一个action：getTime的键值对，在get请求中jQuery会把此参数转为url的参数，上面写法和这种写法效果同样

function testGet3() {
            $.ajax({
                type: 'get',
                url: 'NormalPage.aspx？action=getTime',
                async: true,
                success: function (result) {
                    setContainer(result);
                },
                error: function () {
                    setContainer('ERROR!');
                }
            });
        }

看一下执行效果，这是Chrome的监视结果

image

若是调试咱们发现这个请求调用的服务器页面NormalPage.aspx的GETime方法，而且response中只包含对有用的数据，若是把请求中参数的值改成getDate，那么就会调用对应GetDate方法。

$.ajax POST与json

这样向一个页面发送请求而后在Load事件处理程序中根据参数调用不一样方法，清除Response，写入Response，终止Response，并且传入的参数局限性太大，好业余的赶脚，看看专业些解决方法。为project添加一个General Handler类型文件，关于HttpHandler相关内容本文不作详细解释，只需知道它能够很是轻量级的处理HTTP请求，不用走繁琐的页面生命周期处理各类非必需数据。

Handler.ashx.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using Newtonsoft.Json;

namespace Web
{
    /// <summary>
    /// Summary description for Handler
    /// </summary>
    public class Handler : IHttpHandler
    {
        public void ProcessRequest(HttpContext context)
        {
            Student stu = new Student();
            int Id = Convert.ToInt32(context.Request.Form["ID"]);
            if (Id == 1)
            {
                stu.Name = "Byron";
            }
            else
            {
                stu.Name = "Frank";
            }
           string stuJsonString= JsonConvert.SerializeObject(stu);
           context.Response.Write(stuJsonString);
        }

        public bool IsReusable
        {
            get
            {
                return false;
            }
        }
    }
}

关于这个类语法本文不作详细说明，每次发起HTTP请求ProcessRequest方法都会被调用到，Post类型请求参数和一再Request对象的Form中取得，每次根据参数ID值返回对应json对象字符串，为了展现json格式数据交互，须要为项目引入json.net这一开源类库处理对象序列化反序列化问题，而后建立一个Student类文件

Student.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace Web
{
    public class Student
    {
        public int ID { get; set; }
        public string Name { get; set; }
    }
}

看看页面如何处理

function testPost() {
            $.ajax({
                type: 'post',
                url: 'Handler.ashx',
                async: true,
                data: { ID: '1' },
                success: function (result) {
                    setContainer(result);
                    var stu =eval ('('+result+')');
                    setContainer(stu.ID);
                    setContainer(stu.Name);
                },
                error: function () {
                    setContainer('ERROR!');
                }
            });
        }

结果是这个样子的

image

上面代码向Handler.ashx发送一Post请求，比且带有参数{ID:’1’},能够看到结果，若是用调试工具能够发现，获得的result是一个json格式的字符串，也就是往Response写的对象序列化后的结果。这样就实现了比较专业些的方式调用Ajax，可是有一个问题依旧存在，HttpHandler会自动调用ProcessRequest方法，可是也只能调用该方法，若是想调用不一样方法只能像普通页面那样传递一个参数代表调用哪一个方法，或者写不一样的Handler文件。

WebService与ScriptManager

微软向来很贴心，看看微软怎么处理上面的困惑，那就是利用WebService，WebService配合SCriptManager有客户端调用的能力，在项目中添加一个Webservice文件

WebService.asmx

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;

namespace Web
{
    /// <summary>
    /// Summary description for WebService
    /// </summary>
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    // To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line. 
    [System.Web.Script.Services.ScriptService]
    public class WebService : System.Web.Services.WebService
    {

        [WebMethod]
        public Student GetStudent(int  ID)
        {
            if (ID == 1)
            {
                return new Student() { ID = 1, Name = "Byron" };
            }
            else
            {
                return new Student() { ID = 2, Name = "Frank" };
            }
        }

        
        [WebMethod] 
        public string GetDateTime(bool isLong)

    
        {

    
            if (isLong)

    
            {

    
                return DateTime.Now.ToLongDateString();

    
            }

    
            else

    
            {

    
                return DateTime.Now.ToShortDateString();

    
            }

    
        }
    }
}

代码中加黄的code默认是被注释掉的，要想让客户端调用须要把注释去掉，Service中定义了两个方法，写个测试方法让客户端调用第一个方法根据参数返回对应对象，首先须要在页面from内加上ScriptManager，引用刚才写的WebService文件

Default.aspx

<form id="form1" runat="server">
    <asp:ScriptManager ID="clientService" runat="server">
        <Services>
            <asp:ServiceReference Path="~/WebService.asmx" />
        </Services>
    </asp:ScriptManager>
    <div id="container">
        <input type="button" value="Test Ajax" onclick="testPost2()" />
        <br />
    </div>
...

而后添加JavaScript测试代码

function testPost2() {
            Web.WebService.GetStudent(1, function (result) {
                setContainer(result.ID);
                setContainer(result.Name);
            }, function () {
                setContainer('ERROR!');
            });
        }

测试代码中须要显示书写WebService定义方法完整路径，WebService命名空间.WebService类名.方法名，而出入的参数列表前几个是调用方法的参数列表，由于GetStudent只有一个参数，因此只写一个，若是有两个参数就顺序写两个，另外两个参数能够很明显看出来是响应成功/失败处理程序。看看执行结果：

image

观察仔细会发现使用ScriptManager和WebService组合有福利，在WebService中传回Student对象的时候并无序列化成字符串，而是直接返回，看上面图发现对象已经自动转换为一json对象，result结果能够直接操做，果然很是贴心。而上一个例子中咱们获得的response是一个json字符串，在客户端须要用eval使其转换为json对象。

ScriptManager+WebSefvice调用ajax带来了很大的便利性，但同时牺牲了不少灵活性，咱们无法像jQuery那样指定不少设置有没有一箭双鵰的办法呢

$.ajax+WebService

jQuery调用Handler几乎完美了，可是不能处理多个方法，上面例子咱们能够发现WebService能够实现这一功能，那么能不能jQUery调用WebService的不一样方法呢？答案是确定的，试一试用jQuery调用刚才WebService定义的第二个方法。写一个测试函数

function testPost3() {
            $.ajax({
                type: 'post',
                url: 'WebService.asmx/GetDateTime',
                async: true,
                data: { isLong: true },
                success: function (result) {
                    setContainer($(result).find('string').text());
                },
                error: function () {
                    setContainer('ERROR!');
                }
            });
        }

调用方式没有多大变化，简单依旧，只要把URL改成WebService路径+须要调用的方法名，而后把参数放到data里就能够了。咱们看看结果：

image

经过上图能够看到，jQuery调用WebService默认会返回一个XML文档，而须要的数据在 <string>节点中，只须要使用jQuery解析xml的语法就能够轻松获得数据。若是但愿返回一个json对象怎么办？那就得和调用Handler同样使用json.net序列化，而后前端使用eval转换了，也不会过于复杂。我在项目中最常使用这个模式，这样既保持了jQuery的灵活性又能够在一个Service中书写多个方法供调用，还不用走复杂的页面生命周期

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程