Asp.net中使用DapperExtensions和反射来实现一个通用搜索

下面是关于Asp.net中使用DapperExtensions和反射来实现一个通用搜索的详细攻略。

简介

DapperExtensions是一个用于扩展Dapper ORM的库，它可以方便地进行一些高级查询操作。通常情况下，我们需要编写大量的重复代码来实现这些查询操作。而DapperExtensions就是为了解决这些问题而生的。在本篇文章中，我们将通过DapperExtensions和反射来实现一个通用搜索，以减少代码量并提高代码的可维护性。

前置条件

在开始之前，需要先安装最新版的DapperExtensions。

实现过程

步骤一：创建一个通用的搜索方法

我们可以编写一个扩展方法，通过传入一个实体类的类型和查询条件，来实现通用的搜索。

public static IList<TEntity> Search<TEntity>(this IDbConnection connection,
    DynamicParameters parameters, string searchClause) where TEntity : class
{
    var predicate = Predicates.Field<TEntity>(t => true, Operator.Eq, true);
    if (!string.IsNullOrEmpty(searchClause))
    {
        predicate = (IPredicate)System.Activator.CreateInstance(typeof(TEntity));
        predicate = predicate.ParseSearchClause(searchClause);
    }
    return connection.GetList<TEntity>(predicate, parameters);
}

这个方法接收三个参数：

• IDbConnection：连接数据库的对象。
• DynamicParameters：用于传递参数的对象。
• string：查询条件。

这个方法首先创建了一个始终为真的谓词，这个谓词查询所有的实体。然后判断查询条件是否为空，如果不为空就通过反射来创建一个实体类的实例，并解析查询条件。

步骤二：解析查询条件

我们可以为每个实体类编写一个扩展方法，解析查询条件。

public static IPredicate ParseSearchClause<TEntity>(this TEntity entity, string searchClause) where TEntity : class
{
    var predicate = Predicates.Field<TEntity>(t => true, Operator.Eq, true);
    if (!string.IsNullOrEmpty(searchClause))
    {
        var properties = typeof(TEntity).GetProperties();
        foreach (var property in properties)
        {
            var propertyName = property.Name;
            var propertyType = property.PropertyType;
            var value = ParseValue(searchClause, propertyName);
            if (value == null)
            {
                continue;
            }
            var fieldPredicate = GetFieldPredicate<TEntity>(property, value);
            predicate = Predicates.Group(GroupOperator.And, predicate, fieldPredicate);
        }
    }
    return predicate;
}

这个方法接收两个参数：

• TEntity：要解析查询条件的实体类。
• string：查询条件。

这个方法首先创建了一个始终为真的谓词，类似于步骤一中的方法。然后通过反射获取实体类的属性，再通过ParseValue方法解析查询条件中的值，并通过GetFieldPredicate方法获取字段谓词。最后将所有字段谓词合并为一个新的谓词，并返回。

步骤三：解析值

我们可以编写一个静态方法，解析查询条件中的值。

private static object ParseValue(string searchClause, string propertyName)
{
    var regex = new Regex($@"\[{propertyName}\]\s*?=\s*?([^=\s]*)", RegexOptions.IgnoreCase);
    var match = regex.Match(searchClause);
    if (match.Success)
    {
        var value = match.Groups[1].Value;
        return Convert.ChangeType(value, typeof(string));
    }
    return null;
}

这个方法接收两个参数：

• string：查询条件。
• string：字段名。

这个方法首先通过正则表达式从查询条件中匹配出指定字段的值，并通过Convert.ChangeType方法转换为对应类型的值。如果匹配失败，则返回null。

步骤四：获取字段谓词

我们可以编写一个静态方法，通过属性和属性值来创建一个字段谓词。

private static IPredicate GetFieldPredicate<TEntity>(PropertyInfo property, object value)
{
    var parameterName = $"@{property.Name}";
    var predicate = Predicates.Field<TEntity>(property.Name, Operator.Eq, value);
    if (property.PropertyType == typeof(string) && ((string)value).Contains("%"))
    {
        predicate = Predicates.Like(property.Name, value);
    }
    return predicate;
}

这个方法接收两个参数：

• PropertyInfo：实体类中的一个属性。
• object：属性的值。

这个方法首先创建了一个字段谓词，并指定谓词中的参数名、字段名和操作符。接着判断属性的类型是否为字符串类型且包含通配符%，如果符合条件则将谓词修改为Like类型。

示例

以下是在实体类Person中，查询所有姓氏为李且名字中包含小的人的示例：

using (var conn = new SqlConnection(connectionString))
{
    conn.Open();
    var parameters = new DynamicParameters();
    var searchClause = "[LastName] = 李 and [FirstName] like '%小%'";
    var people = conn.Search<Person>(parameters, searchClause);
}

以下是在实体类Order中，查询金额在2000~3000之间且日期为2021-06-01的订单的示例：

using (var conn = new SqlConnection(connectionString))
{
    conn.Open();
    var parameters = new DynamicParameters();
    var searchClause = "[Amount] >= 2000 and [Amount] <= 3000 and [Date] = '2021-06-01'";
    var orders = conn.Search<Order>(parameters, searchClause);
}

结论

通过使用DapperExtensions和反射，我们可以轻松地实现一个通用的搜索方法。这可以有效减少我们的代码量，提高代码的可维护性。同时，如果我们需要修改搜索方式或新增搜索条件，也可以非常容易地扩展代码。