-
第68章 完整定义nopCommerce Jquery DataTable插件之初始化学生表格
在表格的初始化定义实现中，有个最为重要的功能需要被定义实现，即分页，在通过Jquery DataTable插件分页渲染显示所有学生信息时，其中：分页功能的定义实现实际上是包含两部分：1、Jquery DataTable插件本身渲染分页定义实现；2、数据库学生表中所有学生实例的逻辑分页的实现定义实现。在实际上开发中为了简化实现学生实例的逻辑分页实际上是可以不被定义的，即可以不定义逻辑分页实现，而直接定义渲染分页实现；逻辑分页的功用是：逻辑分页只获取1个指定逻辑页面中的所有实例，由于被渲染数据量的减少，大大的提升了页面的刷新渲染速度。
1逻辑分页的定义实现
1 IPagedList
///
///
/// 【分页列表--接口】
///
/// 摘要：
/// 继承于该接口的具体实现类及其属性成员实例，为1个指定类的数据源执行分页操作提供数据支撑。
///
public interface IPagedList<T> : IList
{
#region 属性
///
/// 【页数索引】
///
/// 摘要：
/// 获取分页操作中当前页的页数值。
///
///
int PageIndex { get; }
///
/// 【页数大小】
///
/// 摘要：
/// 获取分页操作中每页最多显示实例的项(行)数值。
///
///
int PageSize { get; }
///
/// 【项数总计】
///
/// 摘要：
/// 获取分页操作中数据源实例的项(行)数总计值。
///
///
int TotalCount { get; }
///
/// 【页数总计】
///
/// 摘要：
/// 获取分页操作中页数总计值。
///
///
int TotalPages { get; }
///
/// 【有上1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在分页操作中当前页是否有上1页(第1页之前没有上1页)。
///
///
bool HasPreviousPage { get; }
///
/// 【有下1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在分页操作中当前页是否有下1页(最后1页之后没有下1页)。
///
///
bool HasNextPage { get; }
#endregion
}
2 PagedList
///
///
/// 【分页列表--类】
///
/// 摘要：
/// 通过该类及其属性成员实例，为1个指定类的数据源执行分页操作提供数据支撑。
///
[Serializable]
public class PagedList<T> : List
, IPagedList {
#region 拷贝构造方法
///
///
///
///
///
/// 【拷贝构造方法】
///
/// 摘要：
/// 通过拷贝构造方法为该类中的属性成员赋值实例化初始值。
///
///
public PagedList(IList
source, int pageIndex, int pageSize, int? totalCount = null){
//分页操作中每页最多显示实例的项(行)数值，“Math.Max”方法保证该参数实例的最小值必须>=1。
pageSize = Math.Max(pageSize, 1);
TotalCount = totalCount ?? source.Count;
TotalPages = TotalCount / pageSize;
if (TotalCount % pageSize > 0)
TotalPages++;
PageSize = pageSize;
PageIndex = pageIndex;
//该方法主要功能是只从数据源中加载1页数据，以最的小内存开销，为页面的渲染显示提供相应数据支撑，在当前类中基本没有起到应用的作用；真正起到应有作用的是定义在“PagedListExtension(AsyncIQueryableExtensions).ToPagedList”方法中的该方法。
AddRange(totalCount != null ? source : source.Skip(pageIndex * pageSize).Take(pageSize));
}
#endregion
#region 属性
///
/// 【页数索引】
///
/// 摘要：
/// 获取分页操作中当前页的页数值。
///
///
public int PageIndex { get; }
///
/// 【页数大小】
///
/// 摘要：
/// 获取分页操作中每页最多显示实例的项(行)数值。
///
///
public int PageSize { get; }
///
/// 【项数总计】
///
/// 摘要：
/// 获取分页操作中数据源实例的项(行)数总计值。
///
///
public int TotalCount { get; }
///
/// 【页数总计】
///
/// 摘要：
/// 获取分页操作中页数总计值。
///
///
public int TotalPages { get; }
///
/// 【有上1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在分页操作中当前页是否有上1页(第1页之前没有上1页)。
///
///
public bool HasPreviousPage => PageIndex > 0;
///
/// 【有下1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在分页操作中当前页是否有下1页(最后1页之后没有下1页)。
///
///
public bool HasNextPage => PageIndex + 1 < TotalPages;
#endregion
}
3 AsyncIQueryableExtensions
///
/// 【异步语言集成查询扩展--类】
///
/// 摘要：
/// 为实现对“IQueryable”(语言集成查询，继承于“IEnumerable”)实例的异步操作，从而定义了该扩展类及其方法成员。
///
public static class AsyncIQueryableExtensions
{
///
///
///
///
/// 【异步总计】
///
/// 摘要：
/// 以异步操作方式，获取数据源中(符合指定查询条件的)所有实例的(整型)总计值。
///
///
/// (整型)总计值。
///
public static Task<int> CountAsync<TSource>(this IQueryable
source, Expression
{
return predicate == null ? AsyncExtensions.CountAsync(source) : AsyncExtensions.CountAsync(source, predicate);
}
///
///
///
/// 【异步列表】
///
/// 摘要：
/// 以异步操作方式，把数据源中(符合指定查询条件的)所有实例的存储到列表实例中。
///
///
/// 列表实例。
///
public static Task
source) {
return AsyncExtensions.ToListAsync(source);
}
///
///
///
///
///
///
/// 【异步分页列表】
///
/// 摘要：
/// 以异步操作方式，只从数据源中加载指定1页中的数据，存储到“PagedList”类的实例中，为页面的渲染显示提供相应数据支撑。
///
///
/// 分页列表实例。
///
public static async Task
source, int pageIndex, int pageSize, bool getOnlyTotalCount = false){
if (source == null)
return new PagedList
( new List(), pageIndex, pageSize); //分页操作中每页最多显示实例的项(行)数值，“Math.Max”方法保证该参数实例的最小值必须>=1。
pageSize = Math.Max(pageSize, 1);
var count = await source.CountAsync();
var data = new List
(); //指示只从数据源获取指定1页中的数据，从而以最少的数据量，提升页面的刷新渲染速度。
if (!getOnlyTotalCount)
data.AddRange(await source.Skip(pageIndex * pageSize).Take(pageSize).ToListAsync());
//把数据存储到分页列表实例中，为页面的渲染显示提供相应数据支撑。
return new PagedList
(data, pageIndex, pageSize, count); }
}
4 SearchStudentPagedListAsync
///
///
///
///
///
///
///
///
/// 【异步学生分页列表】
///
/// 摘要：
/// 以异步操作方式，把学生表中符合查询条件的所有实例存储到分页列表实例中，为页面的渲染显示提供相应数据支撑。
///
///
/// 分页列表实例。
///
protected virtual async Task
string code = null, string name = null, int specialtyId = 0, int gradeId = 0, int categoryId = 0)
{
//如果数据库不支持int.MaxValue，则即每1面中最多包含的实例数为：int.MaxValue - 1。
if (pageSize == int.MaxValue)
pageSize = int.MaxValue - 1;
var _studentsIQueryable = from studentsQuery in _context.StudentDbSet.Include(student => student.SpecialtySingleton).Include(student => student.GradeSingleton).Include(student => student.CategorySingleton) select studentsQuery;
if (!string.IsNullOrEmpty(name))
_studentsIQueryable = _studentsIQueryable.Where(s => s.Name.Contains(name));
if (!string.IsNullOrEmpty(code) || specialtyId > 0 || gradeId > 0 || categoryId > 0)
_studentsIQueryable = _studentsIQueryable.Where(s => s.Code == code || s.SpecialtyId == specialtyId || s.GradeId == gradeId || s.CategoryId == categoryId);
return await _studentsIQueryable.OrderByDescending(s => s.Id).ToPagedListAsync(pageIndex, pageSize);
}
2 渲染分页的定义实现
1 StudentModel
public partial record StudentModel
{
#region 属性
///
/// 【编号】
///
/// 摘要：
/// 获取/设置学生实体1个指定实例的整型编号值。
///
///
public int Id { get; set; }
///
/// 【学号】
///
/// 摘要：
/// 获取/设置学生实体1个指定实例的学号。
///
///
public string Code { get; set; }
///
/// 【姓名】
///
/// 摘要：
/// 获取/设置1个指定学生的姓名。
///
///
public string Name { get; set; }
///
/// 【专业编号】
///
/// 摘要：
/// 获取/设置专业实体1个指定实例的整型编号值。
///
///
public string SpecialtyName { get; set; }
///
/// 【年级编号】
///
/// 摘要：
/// 获取/设置年级实体1个指定实例的整型编号值。
///
///
public string GradeName { get; set; }
///
/// 【班级编号】
///
/// 摘要：
/// 获取/设置班级实体1个指定实例的整型编号值。
///
///
public string CategoryName { get; set; }
#endregion
}
2 BasePagedListModel
namespace JsonTable.Models.Paged
{
/*
IPagedModel
： 通过Jquery DataTabes插件实现分页操作，实际上是Jquery DataTabes插件分页与实体实例分页的结合与集成，nopCommerce开发者为了区分开Jquery DataTabes插件分页与实体实例逻辑分页，指定当前纪录定义继承于IPagedModel
接口， 以指定继承该纪录的指定模型纪录实例的分页操作是Jquery DataTabes插件分页；并对nopCommerce程序中通过IPagedList和PagedList所实现的实体实例逻辑分页操作作出明确的区分。
由于继承于BaseNopModel，基于相同的原因， 本人删除了当前纪录定义对IPagedModel
的继承，并不影响Jquery DataTabes插件的渲染显示。 */
///
///
/// 【基本分页列表模型--纪录】
///
/// 摘要：
/// 该类及其属性成员实例，为Jquery DataTable插件渲染显示提供基本且必须的数据支撑。
/// 注意：
/// 该纪录是抽象纪录，所以该纪录只能被其它纪录所继承，并由继承纪录所实例化。
///
public abstract partial record BasePagedListModel<T>
{
#region 属性--Jquery DataTable插件
///
/// 【数据】
///
/// 摘要：
/// 获取/设置以枚举数接口进行存储的1指定类中的所有实例。
/// 注意：
/// 因为Jquery DataTable插件是通过Jquery Ajax操作在浏览器中渲染出1指定类中的所有实例数据，所以该属性必须被命名为“Data”，也只能被命名为“Data”，否则浏览器中将不会渲染出这些数据。
///
///
public IEnumerable
Data { get; set; }///
/// 【绘制】
///
/// 摘要：
/// 获取/设置1个指定的Jquery DataTable插件被操作的次数值。
/// [JsonProperty(PropertyName = "string")]：
/// 如果对继承于该纪录的具体纪录实例在使用调用 Json(object)方法时，都会转到JsonConvert.SerializeObject(object)方法对具体纪录实例进行序列化编码，编码后的JSON数据中键(key)名，
/// 是通过[JsonProperty(PropertyName = "string")]标记所指定的键(key)名；在C#中如果不使用[JsonProperty(PropertyName = "string")]标记，则JSON数据中键(key)名与与属性成员名相同。
/// 但是在Jquery中JSON数据中键(key)名的第1个字母必须是小写字母，否则，将不会获取该键(key)名及其相对应值，为了让JSON数据同时兼容C#和Jquery，
/// 所以通过[JsonProperty(PropertyName = "string")]标记，把当前属性成员的第1个字母特定指定为小写字母，让Jquery能够获取JSON数据中键(key)名及其相对应值。
///
///
[JsonProperty(PropertyName = "draw")]
public string Draw { get; set; }
///
/// 【过滤总计】
///
/// 摘要：
/// 获取/设置符合指定过滤条件的1个指定实体所有实例的总计值。
/// [JsonProperty(PropertyName = "string")]：
/// 如果对继承于该纪录的具体纪录实例在使用调用 Json(object)方法时，都会转到JsonConvert.SerializeObject(object)方法对具体纪录实例进行序列化编码，编码后的JSON数据中键(key)名，
/// 是通过[JsonProperty(PropertyName = "string")]标记所指定的键(key)名；在C#中如果不使用[JsonProperty(PropertyName = "string")]标记，则JSON数据中键(key)名与与属性成员名相同。
/// 但是在Jquery中JSON数据中键(key)名的第1个字母必须是小写字母，否则，将不会获取该键(key)名及其相对应值，为了让JSON数据同时兼容C#和Jquery，
/// 所以通过[JsonProperty(PropertyName = "string")]标记，把当前属性成员的第1个字母特定指定为小写字母，让Jquery能够获取JSON数据中键(key)名及其相对应值。
///
///
[JsonProperty(PropertyName = "recordsFiltered")]
public int RecordsFiltered { get; set; }
///
/// 【总计】
///
/// 摘要：
/// 获取/设置1个指定实体所有实例的总计值。
/// [JsonProperty(PropertyName = "string")]：
/// 如果对继承于该纪录的具体纪录实例在使用调用 Json(object)方法时，都会转到JsonConvert.SerializeObject(object)方法对具体纪录实例进行序列化编码，编码后的JSON数据中键(key)名，
/// 是通过[JsonProperty(PropertyName = "string")]标记所指定的键(key)名；在C#中如果不使用[JsonProperty(PropertyName = "string")]标记，则JSON数据中键(key)名与与属性成员名相同。
/// 但是在Jquery中JSON数据中键(key)名的第1个字母必须是小写字母，否则，将不会获取该键(key)名及其相对应值，为了让JSON数据同时兼容C#和Jquery，
/// 所以通过[JsonProperty(PropertyName = "string")]标记，把当前属性成员的第1个字母特定指定为小写字母，让Jquery能够获取JSON数据中键(key)名及其相对应值。
///
///
[JsonProperty(PropertyName = "recordsTotal")]
public int RecordsTotal { get; set; }
#endregion
}
}
3 StudentPagedListModel
///
/// 【学生分页列表模型--纪录】
///
/// 摘要：
/// 该纪录没有定义任何成员实现，它的作用只是能够通过该纪录能够对抽象基纪录进行实例化，为Jquery DataTable插件渲染显示提供基本且必须的数据支撑。
///
public partial record StudentPagedListModel : BasePagedListModel
{
}
3 AsyncIEnumerableExtensions
public static class AsyncIEnumerableExtensions
{
///
///
///
///
///
/// 【异步总计】
///
/// 摘要：
/// 以(阻塞性：ValueTask)异步委托操作方式，获取数据源中符合指定查询条件的所有实例后，把这些实例存储到“IAsyncEnumerable”(可枚举/枚举数)接口实例中。
///
///
/// “IAsyncEnumerable”(可枚举/枚举数)接口实例。
///
public static IAsyncEnumerable
SelectAwait< TSource, TResult>(this IEnumerablesource, Func
{
return source.ToAsyncEnumerable().SelectAwait(predicate);
}
}
4 ModelExtensions
public static class ModelExtensions
{
///
///
///
///
///
///
///
///
/// 【异步预处理表格】
///
/// 摘要：
/// 以异步操作方式，获取数据源中符合指定查询条件的所有实例后，把这些实例存储到“IAsyncEnumerable”(可枚举/枚举数)接口实例中。
///
///
/// “IAsyncEnumerable”(可枚举/枚举数)接口实例。
///
public static async Task
PrepareToGridAsync< TListModel, TModel, TObject>(this TListModel listModel,BaseSearchModel searchModel, IPagedList
objectList, Func where TListModel : BasePagedListModel
{
if (listModel == null)
throw new ArgumentNullException(nameof(listModel));
listModel.Data = await (dataFillFunction?.Invoke()).ToListAsync();
listModel.Draw = searchModel?.Draw;
listModel.RecordsTotal = objectList?.TotalCount ?? 0;
listModel.RecordsFiltered = objectList?.TotalCount ?? 0;
return listModel;
}
}
3 预处理与AJAX控制器
1 SearchStudentPagedListAsync、PrepareStudentPagedListModelAsync
///
///
///
///
///
///
///
///
/// 【异步学生(逻辑)分页列表】
///
/// 摘要：
/// 以异步操作方式，把学生表中符合查询条件的所有实例存储到(逻辑)分页列表实例中，为(渲染)分页列表的实例化提供相应数据支撑。
///
///
/// (逻辑)分页列表实例。
///
protected virtual async Task
string code = null, string name = null, int specialtyId = 0, int gradeId = 0, int categoryId = 0)
{
//如果数据库不支持int.MaxValue，则即每1面中最多包含的实例数为：int.MaxValue - 1。
if (pageSize == int.MaxValue)
pageSize = int.MaxValue - 1;
var _studentsIQueryable = from studentsQuery in _context.StudentDbSet.Include(student => student.SpecialtySingleton).Include(student => student.GradeSingleton).Include(student => student.CategorySingleton) select studentsQuery;
if (!string.IsNullOrEmpty(name))
_studentsIQueryable = _studentsIQueryable.Where(s => s.Name.Contains(name));
if (!string.IsNullOrEmpty(code) || specialtyId > 0 || gradeId > 0 || categoryId > 0)
_studentsIQueryable = _studentsIQueryable.Where(s => s.Code == code || s.SpecialtyId == specialtyId || s.GradeId == gradeId || s.CategoryId == categoryId);
return await _studentsIQueryable.OrderByDescending(s => s.Id).ToPagedListAsync(pageIndex, pageSize);
}
///
///
/// 【异步学生(渲染)分页列表】
///
/// 摘要：
/// 以异步操作方式，把学生表中符合查询条件的所有实例存储到(渲染)分页列表实例中，为页面的渲染显示提供相应数据支撑。
///
///
/// (逻辑)分页列表实例。
///
public virtual async Task
PrepareStudentPagedListModelAsync(StudentSearchModel studentSearchModel) {
IPagedList
_studentIPagedList = await SearchStudentPagedListAsync(studentSearchModel.Page - 1,studentSearchModel.PageSize,
studentSearchModel.Code,
studentSearchModel.Name,
studentSearchModel.SpecialtyId,
studentSearchModel.GradeId,
studentSearchModel.CategoryId);
var model = await new StudentPagedListModel().PrepareToGridAsync(studentSearchModel, _studentIPagedList, () =>
{
//由于当前返回的是一个1个(阻塞性：ValueTask)异步委托方法定义的查询条件实例，在该方法中并设有调用相关的异步方法所以“lambda”表达式会出语法现警告。
return _studentIPagedList.SelectAwait(async item =>
{
StudentModel _studentModel = new StudentModel();
_studentModel.Id = item.Id;
_studentModel.Name = item.Name;
_studentModel.Code = item.Code;
_studentModel.SpecialtyName = item.SpecialtySingleton.Name;
_studentModel.GradeName = item.GradeSingleton.Name;
_studentModel.CategoryName = item.CategorySingleton.Name;
return _studentModel;
});
});
return model;
}
2 StudentListAjax
///
///
/// 【学生表格局部刷新】
///
/// 摘要：
/// 通过参数实例，实现学生表格的局部刷新渲染。
///
///
///
/// 学生表格局部刷新渲染所需要的JSON格式的数据。
///
[HttpPost]
public virtual async Task
StudentListAjax(StudentSearchModel studentSearchModel) {
var model = await PrepareStudentPagedListModelAsync(studentSearchModel);
return Json(model);
}
4 渲染流程和改进
nopCommerce程序中对Jquery DataTable插件的渲染的定义实现是从小模型纪录实例向大模型纪录实例进行集成，或通过小模型纪录实例对大模型记录实例进行实例化，但这也造成了BaseSearchModel定义与 BasePagedListModel定义中有重复的与Jquery DataTable插件相关的属性成员，同时nopCommerce程序中还没有定义与排序相关的模型纪录，如果定义，按照nopCommerce程序所给定的渲染流程，则排序相关的模型纪录定义中也将会定义出一些重复的与Jquery DataTable插件相关的属性成员。为了简化渲染的定义实现，必须对原有的渲染流程进行如下图所示：
注意：
该示例程序中的所有渲染实现都通过Jquery Ajax方法 触发指定的URL，根据该URL调用指定的控件器方法，控件器方法经过一系列执行操作后，向Jquery Ajax方法发送JSON格式的渲染数据，最后通过Jquery语言调用JSON格式的渲染数据，把班级下拉控件和学生表格进行局部渲染显示，但是种方式中需要使用大量的Jquery语言，由Jquery语言是非强类型的，所以总是对程序的健壮性有一些若有若无的担心。解决这种焦虑的最好方法就是根据第二种渲染流程，通过指定的控件器方法向cshtml文件中发送model强类型实例结合HTML标签或以cshtml局部页定义的部件，来实现对班级下拉控件和学生表格进行局部渲染显示；在该方式中Jquery Ajax方法只用于触发指定的URL，调用指定的控件器方法，而渲染的定义实现则交由了model强类型实例和合HTML标签或cshtml局部页。以上这些改进只是一种合理的想法，并没有相应的示例程序作为支撑，如果和时间我会按照该想法来实现相应的示例程序的。
对以上功能更为具体实现和注释见：22-09-08-068_JsonTable(完整定义nopCommerce Jquery DataTable插件之初始化学生表格)。
-
相关阅读:
算法通关村-----回溯模板如何解决排列组合问题
udp/tcp错误总结
如何保证分布式情况下的幂等性
Java常用类
linux gpio喂狗驱动
操作系统导论_第四章_抽象：进程
java中stringbuffer用法：StringBuffer实现高效字符串拼接
面试算法题之旋转置换，旋转跳跃我闭着眼
SpringNative GraalVM 打包 SpringBoot 为 Linux 的 单文件应用程序
Unity Memory Profiler
- 原文地址：https://blog.csdn.net/zhoujian_911/article/details/126761199