FreeSql 中解决 AsTable 分表查询重复数据问题

问题背景

在使用 FreeSql 进行分表查询时，开发者遇到了一个奇怪的现象：相同的查询条件有时会返回重复的数据记录。经过排查发现，这是由于多次调用 AsTable 方法导致的 UNION ALL 机制问题。

问题重现与分析

开发者提供了以下查询示例：

// 查询1：正常返回0条记录
var rechargs1 = await _myRechargeRepository
    .AsTable(oldOrder.MakeDate)
    .Where(x => x.BllId == oldOrder.Id && x.VipUserId == oldOrder.VipUserId && x.Mark == 2)
    .ToListAsync();

// 查询2：异常返回2条重复记录
var rechargs2 = await _myRechargeRepository.Select
    .AsTable(oldOrder.MakeDate)
    .Where(x => x.BllId == oldOrder.Id && x.VipUserId == oldOrder.VipUserId && x.Mark == 0)
    .ToListAsync();

// 查询3：同样异常返回2条重复记录
var rechargs3 = await _myRechargeRepository.Select
    .AsTable(oldOrder.MakeDate)
    .Where(x => x.BllId == oldOrder.Id && x.VipUserId == oldOrder.VipUserId && x.Mark == 0)
    .ToListAsync();

// 查询4：正常返回1条记录
var rechargs4 = await _myRechargeRepository.GetRepository<MyRecharge>().Select
    .AsTable(oldOrder.MakeDate)
    .Where(x => x.BllId == oldOrder.Id && x.VipUserId == oldOrder.VipUserId && x.Mark == 0)
    .ToListAsync();

通过查看生成的SQL语句，发现查询2和查询3实际上执行了UNION ALL操作，将相同的查询条件合并了两次：

SELECT * FROM (
    SELECT a."id", a."created_by", a."created_by_name", a."created_time", a."tenant_id", a."org_id", a."amount", a."bll_id", a."bll_type", a."vip_user_id", a."remark", a."mark"
    FROM "vip_my_recharge_202401" a
    WHERE (a."tenant_id" = 7905557214855237) AND (a."bll_id" = 8054737756291142 AND a."vip_user_id" = 8054737756291141 AND a."mark" = 0)
) ftb

UNION ALL

SELECT * FROM (
    SELECT a."id", a."created_by", a."created_by_name", a."created_time", a."tenant_id", a."org_id", a."amount", a."bll_id", a."bll_type", a."vip_user_id", a."remark", a."mark"
    FROM "vip_my_recharge_202401" a
    WHERE (a."tenant_id" = 7905557214855237) AND (a."bll_id" = 8054737756291142 AND a."vip_user_id" = 8054737756291141 AND a."mark" = 0)
) ftb

问题根源

FreeSql 的 AsTable 方法设计为支持多次调用，每次调用都会添加一个新的表规则，最终通过 UNION ALL 合并查询结果。这种机制在某些场景下非常有用，比如需要同时查询多个分表数据时。但在本例中，开发者无意中多次调用了 AsTable 方法，导致同一张表被多次查询并合并结果。

解决方案

1. 官方建议方案

FreeSql 官方建议开发者自行扩展方法，确保 AsTable 只被调用一次。可以创建一个静态类来封装分表逻辑：

public static class MyFreeSqlExtensions
{
    public static ISelect<T> AsSingleTable<T>(this ISelect<T> select, DateTime date)
    {
        date = new DateTime(date.Year, date.Month, 1);
        if (date > DateTime.Now.AddDays(1).Date || date < DateTime.Parse(DbBeginDate.BegDate))
        {
            return select;
        }
        
        // 清除已有的表规则
        var s0p = select as Select0Provider;
        if (s0p != null) s0p._tableRules.Clear();
        
        return select.AsTable((t, s) =>
        {
            if (t == typeof(T))
            {
                return $"{s}_{date.ToString("yyyyMM")}";
            }
            return $"{s}";
        });
    }
}

使用时：

var result = await _myRechargeRepository.Select
    .AsSingleTable(oldOrder.MakeDate)
    .Where(...)
    .ToListAsync();

2. 通用清除表规则扩展方法

如果需要更灵活的控制，可以创建一组扩展方法来清除已有的表规则：

public static class FreeSqlExtensions
{
    public static ISelect<T1> ClearTableRules<T1>(this ISelect<T1> that)
    {
        var s0p = that as Select0Provider;
        if (s0p != null) s0p._tableRules.Clear();
        return that;
    }
    
    public static IInsert<T1> ClearTableRules<T1>(this IInsert<T1> that) where T1 : class
    {
        var s0p = that as InsertProvider<T1>;
        if (s0p != null) s0p._tableRule = null;
        return that;
    }
    
    public static IUpdate<T1> ClearTableRules<T1>(this IUpdate<T1> that) where T1 : class
    {
        var s0p = that as UpdateProvider<T1>;
        if (s0p != null) s0p._tableRule = null;
        return that;
    }
    
    public static IDelete<T1> ClearTableRules<T1>(this IDelete<T1> that) where T1 : class
    {
        var s0p = that as DeleteProvider<T1>;
        if (s0p != null) s0p._tableRule = null;
        return that;
    }
    
    public static IInsertOrUpdate<T1> ClearTableRules<T1>(this IInsertOrUpdate<T1> that) where T1 : class
    {
        var s0p = that as InsertOrUpdateProvider<T1>;
        if (s0p != null) s0p._tableRule = null;
        return that;
    }
}

使用方式：

var result = await _myRechargeRepository.Select
    .ClearTableRules()
    .AsTable(oldOrder.MakeDate)
    .Where(...)
    .ToListAsync();

最佳实践建议

1. 封装分表逻辑：建议将分表查询逻辑封装到仓储层或扩展方法中，避免在业务代码中直接调用 AsTable。

2. 统一表名处理：在仓储基类中实现表名解析逻辑，确保同一请求中相同实体的分表规则一致。

3. 监控SQL执行：利用 FreeSql 的 AOP 功能监控生成的SQL语句，及时发现潜在问题。

4. 文档记录：团队内部应明确分表查询的使用规范，避免因不了解机制而误用。

总结

FreeSql 的 AsTable 方法通过 UNION ALL 机制支持多表查询，这种设计在需要合并多个分表数据时非常有用。但在只需要查询单个分表的场景下，需要注意避免多次调用 AsTable 导致的数据重复问题。通过封装扩展方法或清除已有表规则，可以灵活控制分表查询行为，满足不同业务场景的需求。