[英]Library For JQuery DataTables ASP.NET MVC
我想在我的ASP.NET MVC 5項目中使用jQuery DataTables。
我確實使用了數據表,它的工作非常好,但問題是我必須手動設置過濾器和查詢,我有一種感覺,我試圖在mvc中實現數據表的方式是不對的。 是的我得到的結果,但我想遵循和標准加上我想要的東西,我不必一次又一次地輸入過濾器和分頁代碼,我只發送參數到某個函數或類,我得到結果。
這就是我試圖尋找一些帶有適當文檔的數據表庫的原因。
當我遇到這個圖書館時。
https://github.com/ALMMa/datatables.mvc
但是沒有好的文檔可以讓我理解該庫中究竟發生了什么,或者如何使用該庫?
是的我試過那個庫,但是由於缺乏對c#和asp.net的了解,我不明白如何實現它,我找不到任何與這個庫相關的例子,我可以理解這個庫的工作..
然而,我也偶然發現了這個記錄良好的過程。
http://www.codeproject.com/Articles/155422/jQuery-DataTables-and-ASP-NET-MVC-Integration-Part
它確實很有效,因為它們提供了如何實施的非常詳細的解釋。
我制作了我的控制器代碼。
public ActionResult Index(jQueryDataTableParamModel param = null)
{
if (Request.IsAjaxRequest() && param != null)
{
var allCategories = _db.Categories.ToList();
IEnumerable<Category> categories;
var sortColumnIndex = Convert.ToInt32(Request["iSortCol_0"]);
var sortDirection = Request["sSortDir_0"]; // asc or desc
Func<Category,string> orderingFunction = (c => sortColumnIndex==1? c.Name :
sortColumnIndex==2? c.SortOrder.ToString(): c.Status.ToString());
if (!string.IsNullOrEmpty(param.sSearch))
{
if(sortDirection == "desc"){
categories = (from category in allCategories
where category.Name.ToLower().Contains(param.sSearch.ToLower())
select category).OrderByDescending(orderingFunction).Skip(param.iDisplayStart).Take(param.iDisplayLength);
}
else
{
categories = (from category in allCategories
where category.Name.ToLower().Contains(param.sSearch.ToLower())
select category).OrderBy(orderingFunction).Skip(param.iDisplayStart).Take(param.iDisplayLength);
}
}
else
{
if (sortDirection == "desc") {
categories = (from category in allCategories
select category).OrderByDescending(orderingFunction).Skip(param.iDisplayStart).Take(param.iDisplayLength);
}
else{
categories = (from category in allCategories
select category).OrderBy(orderingFunction).Skip(param.iDisplayStart).Take(param.iDisplayLength);
}
}
var actionButtons = "<div class='btn-group'>"+
"<button class='btn btn-primary btn-gradient btn-sm' type='button'>"+
"<span class='fa fa-pencil'></span>"+
"</button>";
return Json(new
{
sEcho = param.sEcho,
iTotalRecords = categories.Count(),
iTotalDisplayRecords = categories.Count(),
aaData = (from category in categories
select new[] { category.CategoryID.ToString(), category.Name, category.SortOrder.ToString(), actionButtons }).ToArray()
},
JsonRequestBehavior.AllowGet);
}
return View();
}
但正如你所看到的,如果有更多的數據表方法,現在只有1種方法中有很多代碼,我將不得不一次又一次地編寫所有代碼。 所以我可以制作某種常見的數據表類或函數,並通過提供一些參數調用它,我得到了所需的結果。
我沒有ASP.NET MVC5或C#的經驗,有些日子我正在研究MVC 5.所以如果有更好的方法來實現我在代碼中實現的結果,請分享一下,任何建議你認為你認為對於數據表應該對我很好。
我正在使用自定義模型綁定器和JsonConverter(用於JSON.NET):
包含數據表請求的模型示例:
public class MyModel
{
[JsonConverter(typeof(DataTableConverter))]
public DataTableRequest DataTableRequest { get; set; }
// other properties
}
然后動作方法將如下所示:
[HttpPost]
public virtual ActionResult GetDataTableData(MyModel myModel)
{
}
數據表DataTableRequest類。 GetOrderByExpression返回Dynamic Linq表達式:
public class DataTableRequest
{
public int PageIndex { get; private set; }
public int PageSize { get; private set; }
public string Search { get; private set; }
private List<SortBy> SortingColumns { get; set; }
public int SEcho { get; private set; }
public DataTableRequest(int pageIndex, int pageSize, string search, List<SortBy> sortingColumns, int sEcho)
{
PageIndex = pageIndex;
PageSize = pageSize;
Search = search;
SortingColumns = sortingColumns;
SEcho = sEcho;
}
public string GetOrderByExpression()
{
// could be passed to EntityFramework with DynamicLinq like query.OrderBy(dataTableRequest.GetOrderByExpression())
var columnDirectionPairs = SortingColumns.Select(c => Thread.CurrentThread.CurrentCulture.TextInfo.ToTitleCase(c.Column.Replace("_", ".")) + " " + c.Direction);
var orderByExpression = string.Join(", ", columnDirectionPairs);
return orderByExpression;
}
public class SortBy
{
public SortBy(string column, string direction)
{
Guard.ArgumentNotNullOrEmpty(column, "column");
Guard.ArgumentNotNullOrEmpty(direction, "direction");
Column = column;
Direction = direction;
}
public string Column { get; set; }
public string Direction { get; set; }
}
}
數據表轉換器(用於序列化為json):
public class DataTableConverter : JsonConverter
{
public override bool CanConvert(Type objectType)
{
return objectType == typeof(DataTableRequest);
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
var jArray = JArray.Load(reader);
var tableValueCollection = jArray.Select(x => new { Name = x["name"].Value<string>(), Value = x["value"].Value<string>() }).ToDictionary(x => x.Name, x => x.Value);
var numberOfColumns = int.Parse(tableValueCollection["iColumns"], CultureInfo.InvariantCulture);
var columns = new List<string>();
for (int i = 0; i < numberOfColumns; i++)
{
var queryParamName = string.Format("mDataProp_{0}", i.ToString(CultureInfo.InvariantCulture));
columns.Add(tableValueCollection[queryParamName]);
}
var numberOfSortingColumns = int.Parse(tableValueCollection["iSortingCols"], CultureInfo.InvariantCulture);
var sortingColumns = new List<DataTableRequest.SortBy>();
for (int i = 0; i < numberOfSortingColumns; i++)
{
var sortColQueryParamName = string.Format("iSortCol_{0}", i.ToString(CultureInfo.InvariantCulture));
if (tableValueCollection[sortColQueryParamName] != null)
{
var sortDirQueryParamName = string.Format("sSortDir_{0}", i.ToString(CultureInfo.InvariantCulture));
var sortingDirection = tableValueCollection[sortDirQueryParamName];
var sortingColumnIndex = int.Parse(tableValueCollection[sortColQueryParamName], CultureInfo.InvariantCulture);
var sortingColumnName = columns[sortingColumnIndex];
sortingColumns.Add(new DataTableRequest.SortBy(sortingColumnName, sortingDirection));
}
}
var displayStart = int.Parse(tableValueCollection["iDisplayStart"], CultureInfo.InvariantCulture);
var displayLength = int.Parse(tableValueCollection["iDisplayLength"], CultureInfo.InvariantCulture);
var pageSize = displayLength;
var pageIndex = displayStart / displayLength;
string search = null;
if (tableValueCollection.ContainsKey("sSearch"))
{
search = tableValueCollection["sSearch"];
}
var sEcho = int.Parse(tableValueCollection["sEcho"], CultureInfo.InvariantCulture);
var dataTableRequest = new DataTableRequest(pageIndex, pageSize, search, sortingColumns, sEcho);
return dataTableRequest;
}
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
throw new NotImplementedException();
}
}
DataTableModelBinder用於反序列化DataTableRequest對象:
public class DataTableModelBinder : DefaultModelBinder
{
public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
var request = controllerContext.HttpContext.Request;
var contentType = request.ContentType;
if (!contentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
return (null);
request.InputStream.Seek(0, SeekOrigin.Begin);
var bodyText = new StreamReader(request.InputStream).ReadToEnd();
if (string.IsNullOrEmpty(bodyText)) return (null);
var jsonObj = JObject.Parse(bodyText);
var jArray = (JArray)jsonObj["aoData"];
var tableValueCollection = jArray.Select(x => new { Name = x["name"].Value<string>(), Value = x["value"].Value<string>() }).ToDictionary(x => x.Name, x => x.Value);
var numberOfColumns = int.Parse(tableValueCollection["iColumns"], CultureInfo.InvariantCulture);
var columns = new List<string>();
for (int i = 0; i < numberOfColumns; i++)
{
var queryParamName = string.Format("mDataProp_{0}", i.ToString(CultureInfo.InvariantCulture));
columns.Add(tableValueCollection[queryParamName]);
}
var numberOfSortingColumns = int.Parse(tableValueCollection["iSortingCols"], CultureInfo.InvariantCulture);
var sortingColumns = new List<DataTableRequest.SortBy>();
for (int i = 0; i < numberOfSortingColumns; i++)
{
var sortColQueryParamName = string.Format("iSortCol_{0}", i.ToString(CultureInfo.InvariantCulture));
if (tableValueCollection[sortColQueryParamName] != null)
{
var sortDirQueryParamName = string.Format("sSortDir_{0}", i.ToString(CultureInfo.InvariantCulture));
var sortingDirection = tableValueCollection[sortDirQueryParamName];
var sortingColumnIndex = int.Parse(tableValueCollection[sortColQueryParamName], CultureInfo.InvariantCulture);
var sortingColumnName = columns[sortingColumnIndex];
sortingColumns.Add(new DataTableRequest.SortBy(sortingColumnName, sortingDirection));
}
}
var displayStart = int.Parse(tableValueCollection["iDisplayStart"], CultureInfo.InvariantCulture);
var displayLength = int.Parse(tableValueCollection["iDisplayLength"], CultureInfo.InvariantCulture);
var pageSize = displayLength;
var pageIndex = displayStart / displayLength;
string search = null;
if (tableValueCollection.ContainsKey("sSearch"))
{
search = tableValueCollection["sSearch"];
}
var sEcho = int.Parse(tableValueCollection["sEcho"], CultureInfo.InvariantCulture);
var dataTableRequest = new DataTableRequest(pageIndex, pageSize, search, sortingColumns, sEcho);
return dataTableRequest;
}
}
在Global.asax.cs中的Application_Start上注冊模型綁定器:
ModelBinders.Binders.Add(typeof (DataTableRequest), new DataTableModelBinder());
我正在使用DataTables 1.9.4並遵循json模型綁定器:
public class JsonModelBinder : DefaultModelBinder
{
public static JsonSerializerSettings GlobalSerializerSettings
{
get
{
return new JsonSerializerSettings()
{
ContractResolver = new CamelCasePropertyNamesContractResolver(),
Converters = { new IsoDateTimeConverter() }
};
}
}
public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
if (!IsJSONRequest(controllerContext))
{
return base.BindModel(controllerContext, bindingContext);
}
// Get the JSON data that's been posted
var request = controllerContext.HttpContext.Request;
request.InputStream.Seek(0, SeekOrigin.Begin);
var streamReader = new StreamReader(request.InputStream);
var jsonStringData = streamReader.ReadToEnd();
if (string.IsNullOrEmpty(jsonStringData))
return null;
return JsonConvert.DeserializeObject(jsonStringData, bindingContext.ModelMetadata.ModelType, GlobalSerializerSettings);
}
protected static bool IsJSONRequest(ControllerContext controllerContext)
{
var contentType = controllerContext.HttpContext.Request.ContentType;
return contentType.Contains("application/json");
}
}
替換默認模型綁定器:
ModelBinders.Binders.DefaultBinder = new JsonModelBinder();
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.