EF Core 7.0如何用表达式树实现SQL FORMAT函数？

要生成目标SQL中的FORMAT函数调用，你需要通过注册EF Core自定义数据库函数的方式，将.NET静态方法映射到SQL的FORMAT函数，同时处理可空DateTime的情况。以下是具体实现步骤：

1. 定义映射SQL FORMAT的静态方法 #

创建一个静态类，定义对应SQL FORMAT的方法（仅用于EF Core翻译，不需要实现逻辑）：

public static class SqlFunctions
{
    // 处理非可空DateTime
    public static string Format(DateTime date, string format)
        => throw new NotImplementedException("此方法仅用于EF Core SQL翻译，请勿直接调用");

    // 处理可空DateTime
    public static string Format(DateTime? date, string format)
        => date.HasValue ? Format(date.Value, format) : null;
}

2. 在DbContext中注册数据库函数 #

在你的DbContext的OnModelCreating方法中，将上述静态方法注册为SQL的FORMAT函数：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    // 注册非可空DateTime版本的FORMAT函数
    modelBuilder.HasDbFunction(() => SqlFunctions.Format(default(DateTime), default(string)))
        .HasName("FORMAT")
        .HasTranslation(args => new SqlFunctionExpression(
            "FORMAT",
            args,
            typeof(string),
            null));

    // 注册可空DateTime版本的FORMAT函数
    modelBuilder.HasDbFunction(() => SqlFunctions.Format(default(DateTime?), default(string)))
        .HasName("FORMAT")
        .HasTranslation(args => new SqlFunctionExpression(
            "FORMAT",
            args,
            typeof(string),
            null));
}

3. 用表达式树构建FORMAT调用 #

替换之前调用DateTime.ToString的逻辑，改为调用我们注册的SqlFunctions.Format方法，同时自动适配可空/非可空属性：

// 获取属性表达式
var propertyExpr = Expression.PropertyOrField(parameter, prop.Name);
var propertyType = prop.PropertyType;

// 获取对应的Format方法
MethodInfo formatMethod;
if (propertyType == typeof(DateTime))
{
    formatMethod = typeof(SqlFunctions).GetMethod(nameof(SqlFunctions.Format), new[] { typeof(DateTime), typeof(string) });
}
else if (propertyType == typeof(DateTime?))
{
    formatMethod = typeof(SqlFunctions).GetMethod(nameof(SqlFunctions.Format), new[] { typeof(DateTime?), typeof(string) });
}
else
{
    throw new InvalidOperationException("目标属性必须是DateTime或可空DateTime类型");
}

// 构建FORMAT调用表达式
var formatCallExpr = Expression.Call(
    formatMethod,
    propertyExpr,
    Expression.Constant("dd/MM/yyyy, hh-mm-ss", typeof(string)));

4. 构建LIKE/Contains表达式 #

基于上述formatCallExpr，继续构建Contains（对应SQL LIKE）的表达式：

var containsCallExpr = Expression.Call(
    formatCallExpr,
    typeof(string).GetMethod(nameof(string.Contains), new[] { typeof(string) }),
    Expression.Constant("15/12/", typeof(string)));

关键说明 #

• 为什么之前的DateTime.ToString不行？EF Core默认没有将.ToString(string)方法映射到SQL的FORMAT函数，因此无法翻译，必须通过自定义函数注册实现映射。
• 可空DateTime处理：通过注册重载的静态方法，直接传入可空属性表达式即可，无需额外拆箱操作，EF Core会自动生成正确的SQL处理逻辑。

内容的提问来源于stack exchange，提问作者Goran Petrović