FreeSql中使用SQLite事务时遇到"database is locked"问题的解决方案

问题背景

在使用FreeSql ORM框架操作SQLite数据库时，开发人员可能会遇到"database is locked"的错误。这种情况通常发生在使用UnitOfWork工作单元模式进行事务操作时，特别是在同时启用了自动同步表结构功能的情况下。

问题原因分析

SQLite数据库有一个特殊的设计特性：它只支持单一的事务级别，并且在事务执行期间会对整个数据库文件进行锁定。当我们在事务内部尝试执行表结构迁移操作时，就会导致数据库锁定冲突。

具体到FreeSql框架中，当同时满足以下两个条件时就会出现这个问题：

1. 启用了.UseAutoSyncStructure(true)自动同步表结构功能
2. 在事务内部执行涉及新表结构的操作

解决方案

解决这个问题的关键在于将表结构同步操作与事务操作分离。以下是推荐的解决方案：

1. 显式同步表结构：在创建数据库连接后，立即显式调用同步表结构的方法，而不是依赖自动同步。

2. 代码示例：

// 创建FreeSql实例
var fsql = new FreeSql.FreeSqlBuilder()
        .UseConnectionString(FreeSql.DataType.Sqlite, "Data Source=Demo.db")
        .UseAutoSyncStructure(true)
        .Build();

// 显式同步表结构
fsql.CodeFirst.SyncStructure(typeof(Company), typeof(Person));

// 事务操作
var uow = fsql.CreateUnitOfWork();
try
{
    var c = new Company() { Name = "Tecent" };
    c.Id = await uow.Orm.Insert(c).ExecuteIdentityAsync();
    
    var p = new Person() { Name = "Tom", CompanyId = c.Id };
    await uow.Orm.Insert(p).ExecuteIdentityAsync();
    
    uow.Commit();
}
catch
{
    uow.Rollback();
    throw;
}

最佳实践建议

1. 开发环境与生产环境分离：在开发环境中可以启用自动同步表结构功能，但在生产环境中建议禁用此功能，改为使用迁移脚本。

2. 事务设计原则：

   • 保持事务尽可能短小
   • 不要在事务中包含DDL(数据定义语言)操作
   • 复杂的业务操作考虑分多个小事务执行

3. SQLite特有注意事项：

   • SQLite的并发性能有限，不适合高并发场景
   • 考虑使用WAL(Write-Ahead Logging)模式提高并发性能
   • 合理设置busy_timeout参数处理锁冲突

通过遵循上述解决方案和最佳实践，可以有效地避免在FreeSql中使用SQLite时遇到的"database is locked"问题，同时也能提高应用程序的稳定性和性能。