SqlSugar 动态表达式查询的深度解析与实践

前言

在现代应用开发中，动态查询是一个常见需求。SqlSugar 作为一款优秀的 ORM 框架，近期在 5.1.4.189 预览版本中增强了对动态表达式查询的支持，特别是针对导航属性的动态查询场景。本文将深入探讨这一功能的实现原理和使用方法。

动态表达式查询的挑战

传统 ORM 框架通常要求开发者在编译时确定查询表达式，这在需要根据用户输入动态构建查询条件的场景下显得不够灵活。SqlSugar 通过集成 Dynamic.Core 库，提供了强大的动态表达式解析能力。

核心实现方案

1. 基础配置

首先需要设置动态表达式解析器类型：

StaticConfig.DynamicExpressionParserType = typeof(DynamicExpressionParser);

这一步建立了 SqlSugar 与 Dynamic.Core 之间的桥梁，使得 SqlSugar 能够利用 Dynamic.Core 的表达式解析能力。

2. 表达式构建器

我们可以创建一个表达式构建器来动态生成 Lambda 表达式：

public class ExpressionBuilder
{
    public static LambdaExpression BuildPropertySelector(Type type, string propertyNames)
    {
        var parameter = Expression.Parameter(type, "x");
        var properties = propertyNames.Split(',')
                                     .Select(p => p.Trim())
                                     .ToList();

        if (properties.Count == 1)
        {
            return DynamicExpressionParser.ParseLambda(new[] { parameter }, null, properties[0]);
        }
        else
        {
            var newAnonymousTypeStr = $"new {{ {string.Join(", ", properties.Select(p => $"x.{p}"))} }}";
            return DynamicExpressionParser.ParseLambda(new[] { parameter }, null, newAnonymousTypeStr);
        }
    }
}

3. 动态查询应用

构建好表达式后，可以这样使用：

var expression = ExpressionBuilder.BuildPropertySelector(typeof(UserInfo001), "UserId, UserName");
var result = db.Queryable<UserInfo001>()
               .Select("it", "new( UserId,UserName )", expression.Body.Type)
               .ToList();

导航属性的动态查询

在 5.1.4.189-preview04 版本中，SqlSugar 增强了对导航属性的动态查询支持。例如，对于以下实体结构：

public class RootCompanyUser
{
    // 一对一导航属性
    [Navigate(NavigateType.OneToOne, nameof(RootUserInfo.UserId), nameof(UserId))]
    public RootUserInfo RootUserInfo { get; set; }

    // 一对多导航属性
    [Navigate(NavigateType.OneToMany, nameof(RootUserRole.CompanyUserId))]
    public List<RootUserRole> RootUserRoleList { get; set; }
}

我们可以构建包含导航属性的动态查询：

var selector = Extensions<RootCompanyUser>.BuildSelectExpression(
    @"UserId,
      RootUserInfo.UserName,
      RootUserInfo.UserPhone,
      RootUserRoleList.RoleId");

这相当于静态编写的表达式：

Expression<Func<RootCompanyUser, object>> exp = x => new
{
    UserId = x.UserId,
    RootUserInfo = new
    {
        x.RootUserInfo.UserName,
        x.RootUserInfo.UserPhone,
    },
    RootUserRoleList = x.RootUserRoleList.Select(y => new
    {
        y.RoleId
    })
};

高级用法：参数化查询

在 5.1.4.189-preview01 及以上版本中，还支持参数化动态查询：

var result = db.Queryable<Order>()
               .Select("it",
                new List<string>()
                { 
                    "it.Id as userId",
                    "{0} as id",
                    "it.Name as Name" 
                }, 10)  // {0} 对应参数 10
               .ToPageList(1, 2, ref count);

最佳实践建议

1. 类型安全：虽然支持动态查询，但仍建议尽可能使用强类型查询
2. 性能考虑：复杂动态表达式可能会影响查询性能，应适当优化
3. 异常处理：对用户输入的动态查询字符串进行严格验证
4. 版本选择：确保使用 5.1.4.189-preview04 或更高版本以获得完整功能

结语

SqlSugar 的动态表达式查询功能为开发者提供了极大的灵活性，特别是在需要根据运行时条件构建查询的场景下。通过合理利用这一特性，可以显著减少重复代码，提高开发效率。随着 ORM 技术的不断发展，我们期待 SqlSugar 在未来版本中提供更多强大的动态查询功能。