FreeSql中自定义类型处理器的应用与问题解决

引言

在使用FreeSql进行数据库操作时，我们经常会遇到需要自定义类型处理的需求。本文将详细介绍如何在FreeSql中实现基于属性的自定义类型处理，以及在实现过程中可能遇到的问题和解决方案。

自定义类型处理的基本实现

FreeSql提供了TypeHandler机制，允许开发者自定义特定类型的数据库映射方式。标准的使用方式是通过继承TypeHandler<T>类并实现相关方法：

public class HashedHandler : TypeHandler<HashedString>
{
    public override object Serialize(HashedString value) => ...;
    public override HashedString Deserialize(object value) => ...;
    public override void FluentApi(ColumnFluent col) => col.MapType(typeof(string)).StringLength(-1);
}

然后注册到FreeSql中：

FreeSql.Internal.Utils.TypeHandlers.TryAdd(typeof(HashedString), new HashedHandler());

基于属性的类型处理问题

开发者最初尝试通过属性标记的方式实现自定义类型处理：

[Table(Name = "Users")]
public class Users
{
    public int Id { get; set; }

    [Hashed]
    public string Name { get; set; }
}

但这种方式存在以下问题：

1. 全局影响：如果直接注册string类型的TypeHandler，会影响所有string类型的映射
2. 属性标记不生效：FreeSql默认不支持基于属性的类型处理自动发现

推荐的解决方案

使用包装类型

更合理的做法是创建一个专门的包装类型：

public class HashedString
{
    public HashedString(string value) => this.Value = value;
    public string Value { get; set; }
}

然后在实体中使用：

[Table(Name = "Users")]
public class Users
{
    public int Id { get; set; }
    public HashedString Name { get; set; }
}

处理表达式中的问题

当在LINQ表达式中直接使用new HashedString()时，可能会遇到TypeHandler不触发的问题。可以通过以下方式解决：

fsql.Aop.ParseExpression += (_, e) =>
{
    if (e.Expression.Type == typeof(HashedString) && e.Expression.NodeType == ExpressionType.New)
    {
        var hashString = Expression.Lambda(e.Expression).Compile().DynamicInvoke() as HashedString;
        e.Result = e.FreeParse(Expression.Constant(hashString, typeof(HashedString)));
    }
};

API集成中的JSON序列化问题

当在Web API中使用包装类型时，返回的JSON会包含完整的对象结构。可以通过以下方式解决：

1. 实现自定义的JsonConverter
2. 在包装类型中重写ToString方法
3. 使用DTO进行映射

最佳实践建议

1. 避免为基础类型(string,int等)注册TypeHandler，以免产生全局影响
2. 对于需要特殊处理的字段，使用专门的包装类型
3. 在API层考虑使用DTO进行映射，避免直接暴露数据库实体
4. 对于复杂的表达式场景，使用AOP机制进行增强处理

总结

FreeSql提供了灵活的类型处理机制，通过合理的包装类型设计和AOP扩展，可以实现复杂的类型映射需求。理解TypeHandler的工作原理和限制条件，可以帮助开发者构建更健壮的数据访问层。