重新定义PageParameter的Sort和OrderBy,Sort用于前台接收,OrderBy用于自定义排序,优先级更高
大石头 authored at 2024-02-16 15:38:05 大石头 committed at 2024-03-03 12:06:20
5.21 KiB
X
using System.Runtime.Serialization;
using System.Web.Script.Serialization;
using System.Xml.Serialization;

namespace NewLife.Data;

/// <summary>分页参数信息。可携带统计和数据权限扩展查询等信息</summary>
/// <remarks>
/// 文档 https://newlifex.com/core/page_parameter
/// </remarks>
public class PageParameter
{
    #region 核心属性
    private String? _Sort;
    /// <summary>获取 或 设置 排序字段,前台接收,便于做SQL安全性校验</summary>
    /// <remarks>
    /// 一般用于接收单个排序字段,可以带上Asc/Desc,这里会自动拆分。
    /// 极少数情况下,前端需要传递多个字段排序,这时候可以使用OrderBy。
    /// 
    /// OrderBy优先级更高,且支持手写复杂排序语句(不做SQL安全性校验)。
    /// 如果设置Sort,OrderBy将被清空。
    /// </remarks>
    [XmlIgnore, ScriptIgnore, IgnoreDataMember]
    public virtual String? Sort
    {
        get => _Sort;
        set
        {
            _Sort = value;

            // 自动识别带有Asc/Desc的排序
            if (!_Sort.IsNullOrEmpty() && !_Sort.Contains(','))
            {
                _Sort = _Sort.Trim();
                var p = _Sort.LastIndexOf(' ');
                if (p > 0)
                {
                    var dir = _Sort.Substring(p + 1);
                    if (dir.EqualIgnoreCase("asc"))
                    {
                        Desc = false;
                        _Sort = _Sort.Substring(0, p).Trim();
                    }
                    else if (dir.EqualIgnoreCase("desc"))
                    {
                        Desc = true;
                        _Sort = _Sort.Substring(0, p).Trim();
                    }
                }
            }

            OrderBy = null;
        }
    }

    /// <summary>获取 或 设置 是否降序</summary>
    [XmlIgnore, ScriptIgnore, IgnoreDataMember]
    public virtual Boolean Desc { get; set; }

    /// <summary>获取 或 设置 页面索引。从1开始,默认1</summary>
    /// <remarks>如果设定了开始行,分页时将不再使用PageIndex</remarks>
    public virtual Int32 PageIndex { get; set; } = 1;

    /// <summary>获取 或 设置 页面大小。默认20,若为0表示不分页</summary>
    public virtual Int32 PageSize { get; set; } = 20;
    #endregion

    #region 扩展属性
    /// <summary>获取 或 设置 总记录数</summary>
    public virtual Int64 TotalCount { get; set; }

    /// <summary>获取 页数</summary>
    public virtual Int64 PageCount
    {
        get
        {
            // 如果PageSize小于等于0,则直接返回1
            if (PageSize <= 0) return 1;

            var count = TotalCount / PageSize;
            if ((TotalCount % PageSize) != 0) count++;

            return count;
        }
    }

    /// <summary>获取 或 设置 自定义排序字句。常用于用户自定义排序,不经过SQL安全性校验</summary>
    /// <remarks>
    /// OrderBy优先级更高,且支持手写复杂排序语句(不做SQL安全性校验)。
    /// 如果设置Sort,OrderBy将被清空。
    /// </remarks>
    public virtual String? OrderBy { get; set; }

    /// <summary>获取 或 设置 开始行</summary>
    /// <remarks>如果设定了开始行,分页时将不再使用PageIndex</remarks>
    [XmlIgnore, ScriptIgnore, IgnoreDataMember]
    public virtual Int64 StartRow { get; set; } = -1;

    /// <summary>获取 或 设置 是否获取总记录数,默认false</summary>
    [XmlIgnore, ScriptIgnore, IgnoreDataMember]
    public Boolean RetrieveTotalCount { get; set; }

    /// <summary>获取 或 设置 状态。用于传递统计、扩展查询等用户数据</summary>
    [XmlIgnore, ScriptIgnore, IgnoreDataMember]
    public virtual Object State { get; set; }

    /// <summary>获取 或 设置 是否获取统计,默认false</summary>
    [XmlIgnore, ScriptIgnore, IgnoreDataMember]
    public Boolean RetrieveState { get; set; }
    #endregion

    #region 构造函数
    /// <summary>实例化分页参数</summary>
    public PageParameter() { }

    /// <summary>通过另一个分页参数来实例化当前分页参数</summary>
    /// <param name="pm"></param>
    public PageParameter(PageParameter pm) { CopyFrom(pm); }
    #endregion

    #region 方法
    /// <summary>从另一个分页参数拷贝到当前分页参数</summary>
    /// <param name="pm"></param>
    /// <returns></returns>
    public virtual PageParameter CopyFrom(PageParameter pm)
    {
        if (pm == null) return this;

        OrderBy = pm.OrderBy;
        Sort = pm.Sort;
        Desc = pm.Desc;
        PageIndex = pm.PageIndex;
        PageSize = pm.PageSize;
        StartRow = pm.StartRow;

        TotalCount = pm.TotalCount;
        RetrieveTotalCount = pm.RetrieveTotalCount;
        State = pm.State;
        RetrieveState = pm.RetrieveState;

        return this;
    }

    /// <summary>获取表示分页参数唯一性的键值,可用作缓存键</summary>
    /// <returns></returns>
    public virtual String GetKey() => $"{PageIndex}-{PageCount}-{OrderBy}";
    #endregion
}