DIV CSS 佈局教程網

jQuery 以 POST 方式向 ashx 提交 JSON 數據的完整實解
編輯:JQuery入門技巧     

在 ASP.NET 項目中,ashx(一般處理程序)比 WebForm 更輕量,很適合專門承載 Ajax 接口。本文走一遍完整流程:前端用 jQuery 以 JSON 格式 POST 數據,後端在 ashx 中反序列化並返回結果。

後端:在 ashx 中接收並解析

public void ProcessRequest(HttpContext context)
{
    context.Response.ContentType = "application/json";
    context.Response.ContentEncoding = Encoding.UTF8;

    // 讀取請求正文
    Stream inputStream = context.Request.InputStream;
    Encoding encoding = context.Request.ContentEncoding;
    StreamReader streamReader = new StreamReader(inputStream, encoding);
    string strJson = streamReader.ReadToEnd();

    // 反序列化為模型對象
    Param p = JsonConvert.DeserializeObject<Param>(strJson);
    int top = Convert.ToInt32(p.Top);
    string term = p.Term;

    // var result = ...
    // context.Response.Write(result.ToJson());
}

關鍵在於:當 Content-Type 是 application/json 時,數據不在 Request.Form 裡,而在原始請求流中,必須自己讀出來再反序列化。這一點與傳統表單提交截然不同。

前端:用 $.ajax 提交

$.ajax({
    url: '<%= ResolveUrl("~/Handlers/xxx.ashx") %>',
    dataType: "json",
    type: "POST",
    contentType: "application/json; charset=utf-8",
    data: JSON.stringify({ top: 10, term: request.term }),
    success: function (data) {
        // 處理返回結果
    }
});

三處必須成對出現:type: "POST" 指定方法,contentType: "application/json; charset=utf-8" 聲明正文格式,JSON.stringify(...) 把對象序列化為字符串。三者缺一,後端拿到的就會是 [object Object] 或空內容。

示例中需要傳兩個參數:top 與 term。

後端:定義對應的模型

屬性名要與前端 JSON 的鍵名一致(或配置好大小寫不敏感的策略),否則反序列化後全是默認值。

using System;

namespace Insus.NET
{
    /// <summary>
    /// 承接前端 POST 上來的 JSON 數據
    /// </summary>
    public class Param
    {
        private int _top;
        public int Top
        {
            get { return _top; }
            set { _top = value; }
        }

        private string _term;
        public string Term
        {
            get { return _term; }
            set { _term = value; }
        }
    }
}

實際調試過程

在 ashx 中即可通過上面 ProcessRequest 的方式接收到數據:

以下做一次真實請求,POST 一個 top = 1628,在 Firefox 的 Firebug 中可以看到發送結果:

ashx 中接收到的原始字符串如下:

反序列化後取出 top 的值:

最後取到 term 的值:

幾個實務提醒

別忘了 IsReusable。ashx 實現 IHttpHandler 時,若 ProcessRequest 是無狀態的,可讓 IsReusable 返回 true 以複用實例。

返回 JSON 時記得設置 ContentType。如示例開頭所示,application/json 加上 UTF-8 編碼,前端 dataType: "json" 才能正確解析。

先用 caniuse 級別的手段排查。遇到中文亂碼時,檢查三處:前端 contentType 的 charset、後端 ContentEncoding、以及文件本身的保存編碼是否一致。

考慮用 Web API 替代。新項目中,ASP.NET Web API 自帶模型綁定與 JSON 序列化,不必手工讀流; ashx 的價值主要在於維護既有系統或需要極簡處理的場景。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved