FreeSql中枚举类型映射为字符串时的分组聚合问题解析

问题背景

在使用FreeSql ORM框架时，开发者可能会遇到枚举类型在数据库中以字符串形式存储，但在分组聚合操作中却按整数值进行比较的问题。这种情况会导致生成的SQL语句与预期不符，影响查询结果的准确性。

问题重现

假设我们有一个生产订单质检实体，其中包含一个质检结果枚举字段：

[Column(MapType = typeof(string), StringLength = 50)]
public InspectionResultTypeEnum InspectionResultType { get; set; }

枚举定义如下：

public enum InspectionResultTypeEnum : int
{
    [Description("合格")] Qualified = 20,
    [Description("不合格")] UnQualified = 30,
    [Description("特采")] Special = 40
}

当执行分组聚合查询时：

return await repository
    .Where(...)
    .GroupBy(t => t.ProduceOrderId.Value)
    .ToListAsync(t => new PartQualityInspectQuantityOfProduceOrderDto
    {
        ProduceOrderId = t.Key,
        QualifiedQuantity = t.Sum((t.Value.InspectionResultType == InspectionResultTypeEnum.Qualified || 
                                t.Value.InspectionResultType == InspectionResultTypeEnum.Special) 
                                ? t.Value.InspectionQuantity : 0),
        UnQualifiedQuantity = t.Sum(t.Value.InspectionResultType == InspectionResultTypeEnum.UnQualified 
                                ? t.Value.InspectionQuantity : 0)
    });

实际与期望的SQL对比

实际生成的SQL：

SELECT a.`ProduceOrderId` as1, 
       sum(case when (a.`InspectionResultType` = 20 OR a.`InspectionResultType` = 40) 
                then a.`InspectionQuantity` else 0 end) as2, 
       sum(case when a.`InspectionResultType` = 30 
                then a.`InspectionQuantity` else 0 end) as3
FROM `produce_order_bom_quality_inspection` a
...

期望生成的SQL：

SELECT a.`ProduceOrderId` as1, 
       sum(case when (a.`InspectionResultType` = 'Qualified' OR a.`InspectionResultType` = 'Special') 
                then a.`InspectionQuantity` else 0 end) as2, 
       sum(case when a.`InspectionResultType` = 'UnQualified' 
                then a.`InspectionQuantity` else 0 end) as3
FROM `produce_order_bom_quality_inspection` a
...

问题分析

1. 映射配置：虽然通过[Column(MapType = typeof(string))]属性将枚举映射为字符串存储，但在表达式解析时，FreeSql仍然使用了枚举的整数值进行比较。

2. 类型转换不一致：实体属性到数据库的映射与表达式解析时的类型处理存在不一致，导致生成的SQL不符合预期。

3. 聚合场景特殊性：在分组聚合等复杂查询场景下，类型转换逻辑可能没有完全考虑枚举的字符串映射情况。

临时解决方案

目前可以通过自定义函数来临时解决这个问题：

// 定义自定义函数
[ExpressionCall]
public static class MyDbFunc
{
    public static bool IsQualified(string inspectionResult)
    {
        // 实际实现不重要，FreeSql会替换为SQL表达式
        return false;
    }
    
    public static bool IsUnQualified(string inspectionResult)
    {
        return false;
    }
}

// 使用方式
QualifiedQuantity = t.Sum(MyDbFunc.IsQualified(t.Value.InspectionResultType.ToString()) 
                    ? t.Value.InspectionQuantity : 0)

最佳实践建议

1. 保持一致性：在设计枚举存储方式时，建议保持代码中的使用方式与数据库存储方式一致。

2. 考虑使用字符串枚举：如果业务上更关注枚举的名称而非数值，可以考虑直接使用字符串枚举。

3. 关注框架更新：此类问题通常会在框架后续版本中得到修复，建议关注FreeSql的更新日志。

总结

枚举类型在ORM中的映射和处理是一个常见的复杂场景，特别是在涉及类型转换和复杂查询时。FreeSql虽然提供了灵活的映射配置，但在某些特定场景下仍可能存在行为不一致的情况。开发者在使用时需要充分测试，确保生成的SQL符合预期，必要时可以使用自定义函数等临时解决方案。