FreeSql中弱类型CRUD操作Update时IgnoreColumns的使用注意事项

在使用FreeSql进行数据库操作时，开发者可能会遇到弱类型CRUD操作中Update方法忽略字段(IgnoreColumns)无效的情况。本文将深入分析这一问题，并给出正确的解决方案。

问题现象

当开发者尝试使用弱类型方式进行数据更新时，可能会编写类似以下代码：

var res = await DB.SqlServer.Update<object>()
    .AsType(Type.GetType($"Models." + TableName))
    .SetDto(ndata)
    .WhereDynamic(type.GetProperty("Id").GetValue(ndata))
    .IgnoreColumns(new[] { "Id" })
    .ExecuteUpdatedAsync();

期望通过IgnoreColumns方法忽略ID字段的更新，但实际执行后发现该配置并未生效，ID字段仍然被包含在更新语句中。

原因分析

FreeSql提供了两种不同的更新模式，它们对字段忽略的处理方式有所不同：

1. SetSource + IgnoreColumns/UpdateColumns组合模式：这是FreeSql推荐的标准用法，在这种模式下，字段忽略功能可以正常工作。

2. SetDto模式：这是一种批量设置模式，其设计初衷是快速将DTO对象映射到数据库实体，因此它有自己的字段处理逻辑，不会与IgnoreColumns直接配合使用。

解决方案

要正确实现字段忽略功能，应采用FreeSql推荐的标准用法：

var res = await DB.SqlServer.Update<object>()
    .AsType(Type.GetType($"Models." + TableName))
    .SetSource(ndata)  // 使用SetSource而非SetDto
    .WhereDynamic(type.GetProperty("Id").GetValue(ndata))
    .IgnoreColumns(new[] { "Id" })  // 现在IgnoreColumns会生效
    .ExecuteUpdatedAsync();

最佳实践建议

1. 明确操作模式：在使用FreeSql进行更新操作前，应先确定使用哪种模式。如果需要精细控制更新的字段，应优先考虑SetSource模式。

2. 理解方法语义：

   • SetSource：设置要更新的数据源，适合需要精确控制更新字段的场景
   • SetDto：快速批量设置DTO数据，适合简单场景
   • IgnoreColumns：明确指定要忽略的字段
   • UpdateColumns：明确指定要更新的字段

3. 类型安全考虑：虽然FreeSql支持弱类型操作，但在可能的情况下，尽量使用强类型方式，可以获得更好的编译时检查和IDE支持。

4. 性能考量：对于大批量更新操作，明确指定更新的字段(无论是通过IgnoreColumns还是UpdateColumns)可以减少不必要的数据传输，提高性能。

总结

FreeSql提供了灵活的CRUD操作方式，但不同方法间的配合使用需要遵循一定的规则。理解SetSource和SetDto两种模式的区别，是正确使用字段忽略功能的关键。在实际开发中，建议开发者根据具体需求选择合适的模式，并参考官方文档了解各方法的详细行为，以避免类似问题的发生。