SqlSugar动态查询与分页排序问题解析

问题背景

在使用SqlSugar进行动态查询时，开发者经常会遇到一些特殊场景下的技术挑战。本文将详细分析在SqlSugar中实现动态查询、分页和排序时可能遇到的问题及其解决方案。

主要问题分析

1. 动态分页查询报错

最初的问题出现在使用动态Select语句进行分页查询时，系统抛出"Object of type 'System.Int32' cannot be converted to type 'System.Threading.CancellationToken'"错误。

根本原因：SqlSugar在5.1.4.189-preview11之前的版本中，动态Select与分页方法的参数传递存在兼容性问题。

解决方案：升级到SqlSugarCore 5.1.4.189-preview11或更高版本。新版本已修复此问题，支持以下写法：

RefAsync<int> total = 0;
var result = await db.Queryable<Order>()
    .Select("it", new List<string>{"it.Id as userId", "it.id as id", "it.Name as Name"})
    .ToPageListAsync(1, 2, total);

2. 动态排序问题

在实现动态排序时，特别是涉及导航属性的排序，开发者遇到了多种问题：

1. 使用变量传递排序字段名时失败
2. 导航属性排序时大小写敏感问题
3. 使用"x"和"it"别名不一致导致的错误

解决方案演进：

1. 初始方案（5.1.4.189-preview13）：

   • 支持基本动态排序语法：

     db.Queryable<UnitPerson011>()
       .OrderBy("it", $"it=>it.Address.Street", OrderByType.Desc)
       .ToList();
     

   • 但要求必须使用"it"作为别名

2. 最终方案（5.1.4.189-preview14）：

   • 支持任意别名（"x"或"it"）
   • 修复导航属性排序问题
   • 支持更灵活的动态字段名传递

3. 最佳实践建议

对于动态查询场景，推荐以下实践方式：

1. 动态Select：

var dynamicSelect = new List<string>{
    "x.CompanyUserId", 
    "x.IsEnable", 
    "new (x.RootUserInfo.UserName) as RootUserInfo"
};

2. 动态排序：

string orderField = "RootUserInfo.UserName";  // 可以是变量
var query = db.Queryable<RootCompanyUser>()
    .IncludesAllFirstLayer()
    .OrderBy("x", $"x=>x.{orderField}", OrderByType.Asc);

3. 完整分页查询：

RefAsync<int> total = 0;
var result = await query
    .Select("x", dynamicSelect)
    .ToPageListAsync(pageIndex, pageSize, total);

技术要点总结

1. 版本选择：务必使用5.1.4.189-preview14或更高版本，以获得完整的动态查询功能支持。

2. 别名一致性：虽然新版本支持任意别名，但在单个查询中应保持别名一致（全部使用"x"或全部使用"it"）。

3. 导航属性处理：动态查询中引用导航属性时，属性名称大小写需与实体类定义完全一致。

4. 性能考虑：动态查询虽然灵活，但可能影响查询计划缓存，在高性能要求的场景中应谨慎使用。

通过理解这些技术细节和解决方案，开发者可以更高效地使用SqlSugar实现复杂的动态查询需求，同时避免常见的陷阱和错误。