jQuery $.ajax 参数说明及调用注意事项

$.ajax参数设置

备注：data、contentType、dataType属性值很重要！！！

http://www.w3school.com.cn/jquery/ajax_ajax.asp

http://api.jquery.com/jQuery.ajax/

async

类型：Boolean

默认值: true。默认设置下，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为 false。

注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。

beforeSend(XHR)

类型：Function

发送请求前可修改 XMLHttpRequest 对象的函数，如添加自定义 HTTP 头。

XMLHttpRequest 对象是唯一的参数。

这是一个 Ajax 事件。如果返回 false 可以取消本次 ajax 请求。

cache

类型：Boolean

默认值: true，dataType 为 script 和 jsonp 时默认为 false。设置为 false 将不缓存此页面。

jQuery 1.2 新功能。

complete(XHR, TS)

类型：Function

请求完成后回调函数 (请求成功或失败之后均调用)。

参数： XMLHttpRequest 对象和一个描述请求类型的字符串。

这是一个 Ajax 事件。

contentType

类型：String

默认值: "application/x-www-form-urlencoded"。发送信息至服务器时内容编码类型。

默认值适合大多数情况。如果你明确地传递了一个 content-type 给 $.ajax() 那么它必定会发送给服务器（即使没有数据要发送）。

context

类型：Object

这个对象用于设置 Ajax 相关回调函数的上下文。也就是说，让回调函数内 this 指向这个对象（如果不设定这个参数，那么 this 就指向调用本次 AJAX 请求时传递的 options 参数）。比如指定一个 DOM 元素作为 context 参数，这样就设置了 success 回调函数的上下文为这个 DOM 元素。

就像这样：

$.ajax({ url: "test.html", context: document.body, success: function(){
        $(this).addClass("done");
      }});

data

类型：String

发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。查看 processData 选项说明以禁止此自动转换。必须为 Key/Value 格式。如果为数组，jQuery 将自动为不同值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 '&foo=bar1&foo=bar2'。

dataFilter

类型：Function

给 Ajax 返回的原始数据的进行预处理的函数。提供 data 和 type 两个参数：data 是 Ajax 返回的原始数据，type 是调用 jQuery.ajax 时提供的 dataType 参数。函数返回的值将由 jQuery 进一步处理。

dataType

类型：String

预期服务器返回的数据类型。如果不指定，jQuery 将自动根据 HTTP 包 MIME 信息来智能判断，比如 XML MIME 类型就被识别为 XML。在 1.4 中，JSON 就会生成一个 JavaScript 对象，而 script 则会执行这个脚本。随后服务器端返回的数据会根据这个值解析后，传递给回调函数。可用值:

"xml": 返回 XML 文档，可用 jQuery 处理。
"html": 返回纯文本 HTML 信息；包含的 script 标签会在插入 dom 时执行。
"script": 返回纯文本 JavaScript 代码。不会自动缓存结果。除非设置了 "cache" 参数。注意：在远程请求时(不在同一个域下)，所有 POST 请求都将转为 GET 请求。（因为将使用 DOM 的 script标签来加载）
"json": 返回 JSON 数据。
"jsonp": JSONP 格式。使用 JSONP 形式调用函数时，如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名，以执行回调函数。
"text": 返回纯文本字符串

error

类型：Function

默认值: 自动判断 (xml 或 html)。请求失败时调用此函数。

有以下三个参数：XMLHttpRequest 对象、错误信息、（可选）捕获的异常对象。

如果发生了错误，错误信息（第二个参数）除了得到 null 之外，还可能是 "timeout", "error", "notmodified" 和 "parsererror"。

这是一个 Ajax 事件。

global

类型：Boolean

是否触发全局 AJAX 事件。默认值: true。设置为 false 将不会触发全局 AJAX 事件，如 ajaxStart 或 ajaxStop 可用于控制不同的 Ajax 事件。

ifModified

类型：Boolean

仅在服务器数据改变时获取新数据。默认值: false。使用 HTTP 包 Last-Modified 头信息判断。在 jQuery 1.4 中，它也会检查服务器指定的 'etag' 来确定数据没有被修改过。

jsonp

类型：String

在一个 jsonp 请求中重写回调函数的名字。这个值用来替代在 "callback=?" 这种 GET 或 POST 请求中 URL 参数里的 "callback" 部分，比如 {jsonp:'onJsonPLoad'} 会导致将 "onJsonPLoad=?" 传给服务器。

jsonpCallback

类型：String

为 jsonp 请求指定一个回调函数名。这个值将用来取代 jQuery 自动生成的随机函数名。这主要用来让 jQuery 生成度独特的函数名，这样管理请求更容易，也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存 GET 请求的时候，指定这个回调函数名。

password

类型：String

用于响应 HTTP 访问认证请求的密码

processData

类型：Boolean

默认值: true。默认情况下，通过data选项传递进来的数据，如果是一个对象(技术上讲只要不是字符串)，都会处理转化成一个查询字符串，以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息，请设置为 false。

scriptCharset

类型：String

只有当请求时 dataType 为 "jsonp" 或 "script"，并且 type 是 "GET" 才会用于强制修改 charset。通常只在本地和远程的内容编码不同时使用。

success

类型：Function

请求成功后的回调函数。

参数：由服务器返回，并根据 dataType 参数进行处理后的数据；描述状态的字符串。

这是一个 Ajax 事件。

traditional

类型：Boolean

如果你想要用传统的方式来序列化数据，那么就设置为 true。请参考工具分类下面的 jQuery.param 方法。

timeout

类型：Number

设置请求超时时间（毫秒）。此设置将覆盖全局设置。

type

类型：String

默认值: "GET")。请求方式 ("POST" 或 "GET")，默认为 "GET"。注意：其它 HTTP 请求方法，如 PUT 和 DELETE 也可以使用，但仅部分浏览器支持。

类型：String

默认值: 当前页地址。发送请求的地址。

username

类型：String

用于响应 HTTP 访问认证请求的用户名。

类型：Function

需要返回一个 XMLHttpRequest 对象。默认在 IE 下是 ActiveXObject 而其他情况下是 XMLHttpRequest 。用于重写或者提供一个增强的 XMLHttpRequest 对象。这个参数在 jQuery 1.3 以前不可用。

调用asp.net的WebService

WebService

//若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务，请取消对下行的注释。

　　[System.Web.Script.Services.ScriptService]

每个公开的方法需要加特性[WebMethod]

客户端

$.ajax里面data参数必须正确的赋值，并且拼写必须严格按照contentType属性的格式，dataType属性必须正确

                $.ajax(
                {
                    url: "YanZheng.asmx/checkLoginName",
                    type: "POST",
　　　　　　　　　　　 contentType: "application/json",//发送信息至服务器时内容编码类型
                    data: '{"name":"' + name + '","opeType":"' + opeType + '","id":"' + id + '"}',
                    dataType: "json",//服务器返回的数据类型
                    success: function (result)
                    {
                        //回调函数，result.d取出返回值
                        alert(result.d)
                    },
                    error: function (err, s)
                    {
                       
                    }
                });

调用asp.net的ashx或者aspx.cs的静态公开方法

Handler.ashx文件内容，其中需要添加Newtonsoft.Json.dll的引用，以便对后台数据做json转换，解析post参数，根据需要做出对应的处理

<%@ WebHandler Language="C#" Class="Handler" %>
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System;
using System.Web;
using System.Data;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using System.Web.Services;
using System.Collections;
using System.Collections.Generic;

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class Handler : IHttpHandler
{

    public void ProcessRequest(HttpContext context)
    {
        context.Response.Buffer = true;
        context.Response.ExpiresAbsolute = DateTime.Now.AddDays(-1);
        context.Response.AddHeader("pragma", "no-cache");
        context.Response.AddHeader("cache-control", "");
        context.Response.CacheControl = "no-cache";
        context.Response.ContentType = "text/plain";

        string action = context.Request.Params["action"].ToString();
        switch (action)
        {
            case "getVehs":
                getVehs(context);
                break;
            case "getVeh":
                getVeh(context);
                break;
            case "addVeh":
                addVeh(context);
                break;
            case "editVeh":
                editVeh(context);
                break;
            case "delVeh":
                delVeh(context);
                break;
            case "test":
                getVehs_test(context);
                break;
            default:
                break; 
        }
    }
    /// <summary>
    /// 获取交通车列表
    /// </summary>
    /// <param name="context"></param>
    void  getVehs(HttpContext context)
    {
        DataTable dt;
        string jsonData = string.Empty;

        DataSet sResult = DJ.DB.DataHelper.GetVehList(context.Request.Params["areaid"].ToString(), context.Request.Params["keywords"].ToString());
        dt = sResult.Tables[0];
        int iCount = dt.Rows.Count;

        IsoDateTimeConverter idtc = new IsoDateTimeConverter();
        idtc.DateTimeFormat = "yyyy-MM-dd hh:mm:ss ffffff";
        jsonData = JsonConvert.SerializeObject(dt, idtc).ToString();

        context.Response.Write(jsonData);
    }
    /// <summary>
    /// 获取交通车
    /// </summary>
    /// <param name="context"></param>
    void getVeh(HttpContext context)
    {
        DataTable dt;
        string jsonData = string.Empty;

        DataSet sResult = DJ.DB.DataHelper.GetVehicle(context.Request.Params["vehid"].ToString());
        dt = sResult.Tables[0];
        jsonData = JsonConvert.SerializeObject(dt).ToString();

        context.Response.Write(jsonData);
    }
    /// <summary>
    /// 添加交通车
    /// </summary>
    /// <param name="context"></param>
    void addVeh(HttpContext context)
    {
        string jsonData = string.Empty;
        var sResult = DJ.DB.DataHelper.AddVeh(context.Request.Params["areaid"].ToString(),context.Request.Params["veh"].ToString(), context.Request.Params["tel"].ToString());
        jsonData = JsonConvert.SerializeObject(sResult).ToString();
        context.Response.Write(jsonData);
    }
    /// <summary>
    /// 修改交通车
    /// </summary>
    /// <param name="context"></param>
    void editVeh(HttpContext context)
    {
        string jsonData = string.Empty;
        var sResult = DJ.DB.DataHelper.EditVeh(context.Request.Params["vehid"].ToString(),context.Request.Params["veh"].ToString(), context.Request.Params["tel"].ToString());
        jsonData = JsonConvert.SerializeObject(sResult).ToString();
        context.Response.Write(jsonData);
    }
    /// <summary>
    /// 删除交通车
    /// </summary>
    /// <param name="context"></param>
    void delVeh(HttpContext context)
    {
        string jsonData = string.Empty;

        var sResult = DJ.DB.DataHelper.DelVeh(context.Request.Params["vehid"].ToString());

        jsonData = JsonConvert.SerializeObject(sResult).ToString();

        context.Response.Write(jsonData);
    }
    
   
    public bool IsReusable
    {
        get
        {
            return false;
        }
    }

}

前端通过jquery方式调用ajax，data参数可以直接用json格式的数据传递，如果用上面的WebService方式传递json格式的数据，data参数必须是符合json格式的拼写字符串

$.post("Handler.ashx", { action: "addVeh", areaid: $('[id$=hdAreaid]').val(), veh: $("#dialog_veh").val(), tel: $("#dialog_tel").val() }, function (ajax)
{
　　//后台返回json的类型为字符串，这里做了一次转换
    if (eval(ajax))
    {
        alert（ok）;
    }
});

posted on 2013-04-25 14:39 ※WYF※ 阅读(998) 评论(0) 编辑收藏举报

博学之 审问之 慎思之 明辨之 笃行之

jQuery $.ajax 参数说明及调用注意事项

$.ajax参数设置

调用asp.net的WebService

调用asp.net的ashx或者aspx.cs的静态公开方法

博学之审问之慎思之明辨之笃行之