FreeSql实现数据字段自动加解密的最佳实践

在数据库应用开发中，数据安全是一个非常重要的考虑因素。FreeSql作为一款功能强大的.NET ORM框架，提供了多种机制来实现数据字段的自动加解密。本文将详细介绍如何利用FreeSql的特性实现这一功能。

数据加解密的基本实现

FreeSql提供了AOP（面向切面编程）机制，可以通过事件钩子拦截数据操作过程。对于字段加解密，主要使用以下几个事件：

1. AuditValue：在数据插入和更新时触发，可用于加密敏感字段
2. AuditDataReader：在从数据库读取数据时触发，可用于解密敏感字段

_fsql.Aop.AuditValue += ((s, e) => {
    if (e.Property.GetCustomAttribute<SecretAttribute>() != null && e.Value != null) {
        if (e.AuditValueType == AuditValueType.Insert || 
            e.AuditValueType == AuditValueType.Update) {
            e.Value = AesEncryption.Encrypt(e.Value.ToString(), "0123456789ABCDEF");
        }
    }
});

_fsql.Aop.AuditDataReader += ((s, e) => {
    if (e.Property.GetCustomAttribute<SecretAttribute>() != null) {
        e.Value = AesEncryption.Decrypt(e.Value.ToString(), "0123456789ABCDEF");
    }
});

查询条件的加密处理

在实际应用中，我们不仅需要对存储的数据进行加解密，还需要处理查询条件中的加密字段。例如：

var query = new Order { Name = "888" };
var result = await _fsql.Select<Test, Order>()
    .InnerJoin((a, b) => a.Id == b.Id)
    .Where((a,b) => a.Name == query.Name)
    .ToListAsync();

对于这种情况，FreeSql推荐使用TypedHandler来处理。TypedHandler允许我们为特定类型定义自定义的数据库类型映射和处理逻辑。

使用TypedHandler实现统一加密

1. 首先定义一个自定义类型来包装需要加密的字段：

public struct EncryptedString 
{
    public string Value { get; private set; }
    
    public EncryptedString(string value) 
    {
        Value = value;
    }
    
    public override string ToString() => Value;
}

2. 然后实现ITypeHandler接口：

public class EncryptedStringHandler : ITypeHandler
{
    public object Parse(object value)
    {
        return new EncryptedString(AesEncryption.Decrypt(value?.ToString(), "0123456789ABCDEF"));
    }

    public object ToValue(object value)
    {
        return AesEncryption.Encrypt((value as EncryptedString)?.Value, "0123456789ABCDEF");
    }
}

3. 最后在FreeSql中注册这个类型处理器：

FreeSql.Internal.Utils.TypeHandlers.TryAdd(typeof(EncryptedString), new EncryptedStringHandler());

实体类定义

在实体类中使用自定义类型：

public class Order 
{
    public int Id { get; set; }
    
    [SecretAttribute]
    public EncryptedString Name { get; set; }
}

优势与总结

使用TypedHandler方案相比直接在AOP中处理有以下优势：

1. 统一处理：无论是插入、更新还是查询条件，都会自动进行加解密
2. 类型安全：使用强类型避免字符串操作错误
3. 可读性：代码意图更加明确
4. 维护性：加密逻辑集中在一处，便于维护和修改

FreeSql的灵活架构为数据安全提供了多种解决方案，开发者可以根据项目需求选择最适合的方式。对于需要全面加密的场景，TypedHandler提供了最优雅和完整的解决方案。