建立 ASP.NET MVC 專案後,jQuery 腳本已經內建在 Scripts 資料夾裡,不必另外下載。本文沿用先前的環境,示範如何從 Model 準備資料、在 Controller 輸出 JSON,再用 jQuery 在前端呈現。
JSON 本質上就是 key-value 形式的資料結構。這裡用 LINQ 從 test 表取出 id 與 name 兩個欄位:
// JsonDataArray
public static Array GetJsonArray(String name)
{
Array data = null;
try
{
data = (from c in testDb.test
where c.name.Contains(name)
select new { c.id, c.name }).ToArray();
}
catch (ArgumentNullException ae) { }
return data;
}
按預設選項建立控制器(預設只有 Index 方法),再自行加入一個供 jQuery 呼叫的 action:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using MvcWeb.Models;
namespace MvcWeb.Controllers
{
public class JQueryController : Controller
{
// GET: /JQuery/
public ActionResult Index()
{
return View();
}
public JsonResult FindByName(string name)
{
return Json(TestModel.GetJsonArray(name), JsonRequestBehavior.AllowGet);
}
}
}
這裡有個關鍵:MVC 2.0 預設禁止以 GET 方式回傳 JSON(避免 JSON 劫持攻擊),因此必須明確加上 JsonRequestBehavior.AllowGet。若無特別需求,更安全的做法是改用 POST。
在 Index() 上按右鍵、選預設選項建立視圖,然後補上腳本:
<script src="../../Scripts/jquery-1.4.1.js" type="text/javascript"></script>
<script language="javascript" type="text/javascript">
$(document).ready(function () {
$('#updater').hide();
$('#dataHead').hide();
$('#linkFind').click(function (event) {
event.preventDefault();
$('#dataHead').show();
$('#updater').show();
$.getJSON('/JQuery/FindByName/', { name: $('#textSearch')[0].value }, function (data) {
$('#testList > div').remove();
$.each(data, function (i, item) {
$('#testList').append('<div>' + item.id + ' ' + item.name + '</div>');
});
});
$('#updater').hide();
});
});
</script>
<h2>使用 jQuery 實現 Ajax 實例</h2>
<div id="query">
<%= Html.TextBox("textSearch") %>
<a href="#" id="linkFind">搜索</a>
<span class="update" id="updater"> Loading... </span>
</div>
<div id="dataHead">ID Name</div>
<div id="testList"></div>
運行後在文字框輸入 t 並按「搜索」,頁面不刷新即顯示查詢結果:
發生問題時,$.getJSON 的錯誤訊息不易取得,這時可改用基礎方法 $.ajax 並掛上 error 回呼:
<script language="javascript" type="text/javascript">
$(document).ready(function () {
$('#linkFind').click(function (event) {
event.preventDefault();
var handleData = function (data) { alert("success:" + data); };
var handleErr = function (e) {
alert(e.responseText);
};
$.ajax({
type: "get",
url: "/Jquery/FindByName",
data: "name=t",
success: handleData,
error: handleErr
});
});
});
</script>
範例中有個小瑕疵:$('#updater').hide() 緊跟在 getJSON 之後執行,由於 AJAX 是異步的,loading 提示幾乎還沒顯示就被藏起來了。正確做法是把 hide 寫進 success(或 complete)回呼裡。這也是初學 AJAX 時最常見的時序誤解——異步請求的下一步,永遠要寫在回呼裡,而不是下一行。