ORMX 数据库缓存

学习 ORMX 框架的数据库缓存集成功能，包括配置使用、缓存策略、性能优化和实际应用场景。关键字：数据库缓存，ORMX 缓存，性能优化，缓存策略，CacheBuilder

数据库缓存概述

ORMX 框架通过 CacheBuilder 类提供了内置的数据库缓存功能，为数据库操作提供高性能的缓存支持。缓存数据存储在数据库的 Cache 表中，可以显著减少重复查询，提高应用性能，特别适用于读密集型应用场景。

核心价值

性能提升：减少重复数据库查询，提高查询响应速度
零依赖：无需额外安装 Redis 等缓存服务，使用数据库本身作为缓存存储
自动过期：支持缓存自动过期机制，确保数据时效性
透明使用：缓存对开发者透明，无需手动管理缓存读写
类型安全：支持各种数据类型的自动序列化和反序列化

缓存机制

ORMX 的缓存机制基于 CacheBuilder 类实现：

缓存存储：使用数据库表 Cache 存储缓存数据
缓存键：使用 MD5 哈希生成查询的唯一缓存键
自动过期：支持设置缓存有效期，过期后自动删除
类型转换：智能处理各种数据类型的序列化和反序列化
透明调用：在查询时自动检查缓存，无需手动干预

安装与配置

基本配置

ORMX 的缓存功能内置于框架中，无需额外安装包。只需在数据库提供程序中启用缓存即可：

// 创建数据库提供程序
using var provider = new SqliteDatabaseProvider("Data Source=test.db");

// 获取表管理器并设置缓存
var tableManager = provider.GetTableManager();
tableManager.SetCacheBuilder(provider, TimeSpan.FromMinutes(10));  // 设置缓存有效期为 10 分钟

// 获取表对象
var userTable = tableManager.Table<User>();

// 查询会自动使用缓存
var users = userTable.Where(u => u.Age > 25).GetList();

缓存配置选项

配置项	类型	默认值	说明
`cacheProvider`	IDbProvider	主数据库	缓存存储的数据库提供程序
`cacheExpiration`	TimeSpan	10 分钟	缓存有效期

使用独立数据库作为缓存

可以使用独立的数据库作为缓存存储，避免缓存数据影响主数据库性能：

// 创建主数据库提供程序
using var mainProvider = new SqliteDatabaseProvider("Data Source=main.db");

// 创建缓存数据库提供程序
using var cacheProvider = new SqliteDatabaseProvider("Data Source=cache.db");

// 获取表管理器并设置缓存
var tableManager = mainProvider.GetTableManager();
tableManager.SetCacheBuilder(cacheProvider, TimeSpan.FromMinutes(30));

// 获取表对象，查询会使用独立的缓存数据库
var userTable = tableManager.Table<User>();
var users = userTable.Where(u => u.Age > 25).GetList();

使用示例

基本查询缓存

// 创建数据库提供程序
using var provider = new SqliteDatabaseProvider("Data Source=test.db");

// 获取表管理器并设置缓存
var tableManager = provider.GetTableManager();
tableManager.SetCacheBuilder(provider, TimeSpan.FromMinutes(10));

var userTable = tableManager.Table<User>();

// 首次查询会缓存结果
var users = userTable.Where(u => u.Age > 25).GetList();
Console.WriteLine("首次查询完成");

// 后续查询会使用缓存
var cachedUsers = userTable.Where(u => u.Age > 25).GetList();
Console.WriteLine("缓存查询完成");

自定义缓存过期时间

// 为特定查询设置缓存策略
var users = userTable
    .Where(u => u.Age > 25)
    .WithCacheExpiration(TimeSpan.FromHours(1)) // 自定义过期时间
    .GetList();

缓存失效

// 手动使特定表的缓存失效
var cacheProvider = provider; // 或独立的缓存数据库提供程序
var tableManager = cacheProvider.GetTableManager();
var cacheTable = tableManager.Table<CacheEntity>();

// 删除特定表的所有缓存
cacheTable.Where(x => x.Table == "User").Delete();

// 删除特定缓存键
cacheTable.Where(x => x.Key == "cache_key_here").Delete();

// 清空所有缓存
cacheTable.Delete();

事务中的缓存管理

缓存与事务的关联机制：

事务中的缓存写入：在事务中执行的缓存写入操作会被加入队列，不会立即执行
事务提交：事务提交后，缓存操作队列会自动执行，将数据写入缓存
事务回滚：事务回滚时，缓存操作队列会被清空，确保缓存与数据库一致
自动管理：开发者无需手动管理缓存失效，框架会自动处理

实际应用场景

读密集型应用

场景：新闻网站、内容管理系统等以读取为主的应用

解决方案：

// 创建数据库提供程序
using var provider = new SqliteDatabaseProvider("Data Source=content.db");

// 配置较长的缓存时间
var tableManager = provider.GetTableManager();
tableManager.SetCacheBuilder(provider, TimeSpan.FromHours(1));

// 内容查询会被缓存
var articles = tableManager.Table<Article>()
    .Where(a => a.IsPublished)
    .OrderByDesc(a => a.PublishDate)
    .Limit(10)
    .GetList();

高频查询优化

场景：商品详情页、用户个人资料等高频访问的数据

解决方案：

// 创建数据库提供程序并设置缓存
using var provider = new SqliteDatabaseProvider("Data Source=main.db");
var tableManager = provider.GetTableManager();
tableManager.SetCacheBuilder(provider, TimeSpan.FromMinutes(30));

// 商品详情查询
var product = tableManager.Table<Product>()
    .Where(p => p.Id == productId)
    .WithCacheExpiration(TimeSpan.FromMinutes(30))
    .FirstOrDefault();

// 用户资料查询
var userProfile = tableManager.Table<UserProfile>()
    .Where(up => up.UserId == userId)
    .WithCacheExpiration(TimeSpan.FromHours(1))
    .FirstOrDefault();

分页查询缓存

场景：列表页、搜索结果等分页数据

解决方案：

// 创建数据库提供程序并设置缓存
using var provider = new SqliteDatabaseProvider("Data Source=main.db");
var tableManager = provider.GetTableManager();
tableManager.SetCacheBuilder(provider, TimeSpan.FromMinutes(15));

// 分页查询缓存
var pageSize = 20;
var pageIndex = 1;

var products = tableManager.Table<Product>()
    .Where(p => p.CategoryId == categoryId)
    .OrderByDesc(p => p.CreatedAt)
    .Offset((pageIndex - 1) * pageSize)
    .Limit(pageSize)
    .WithCacheExpiration(TimeSpan.FromMinutes(15))
    .GetList();

性能调优

缓存键设计

最佳实践：

缓存键由系统自动生成，使用 MD5 哈希确保唯一性
缓存键包含查询 SQL 和参数信息
无需手动管理缓存键，系统自动处理

缓存键生成逻辑：

// 内部使用 MD5 生成缓存键
public static string GenerateCacheKey(string query, List<object> parameters)
{
    var key = $"{query}|{string.Join(",", parameters)}";
    using var md5 = System.Security.Cryptography.MD5.Create();
    var hashBytes = md5.ComputeHash(System.Text.Encoding.UTF8.GetBytes(key));
    return BitConverter.ToString(hashBytes).Replace("-", "").ToLower();
}

缓存过期策略

最佳实践：

根据数据更新频率设置合理的过期时间
热点数据使用较长的过期时间
频繁更新的数据使用较短的过期时间

示例：

// 热点数据 - 较长过期时间
.WithCacheExpiration(TimeSpan.FromHours(2))

// 频繁更新的数据 - 较短过期时间
.WithCacheExpiration(TimeSpan.FromMinutes(5))

使用独立缓存数据库

最佳实践：

对于高性能要求的应用，使用独立的数据库作为缓存存储
避免缓存操作影响主数据库性能
可以使用内存数据库（如 SQLite 的 :memory:）作为缓存

示例：

// 创建主数据库提供程序
using var mainProvider = new SqliteDatabaseProvider("Data Source=main.db");

// 使用内存数据库作为缓存
using var cacheProvider = new SqliteDatabaseProvider(":memory:");

// 配置缓存
var tableManager = mainProvider.GetTableManager();
tableManager.SetCacheBuilder(cacheProvider, TimeSpan.FromMinutes(30));

// 查询会使用内存数据库作为缓存
var userTable = tableManager.Table<User>();
var users = userTable.Where(u => u.IsActive).GetList();

缓存表维护

最佳实践：

定期清理过期的缓存数据
监控缓存表大小，避免过大影响性能
在应用启动时创建缓存表

示例：

// 确保缓存表存在
var tableManager = cacheProvider.GetTableManager();
tableManager.CreateTable<CacheEntity>();

// 定期清理过期缓存
var expiredCache = tableManager.Table<CacheEntity>()
    .Where(x => x.ExpireTime < DateTime.Now)
    .GetList();

foreach (var cache in expiredCache)
{
    tableManager.Table<CacheEntity>()
        .Where(x => x.Key == cache.Key)
        .Delete();
}

故障处理

缓存表不存在

问题：首次使用缓存时，Cache 表可能不存在

解决方案：

在应用启动时确保创建缓存表
使用 CreateTable<CacheEntity>() 方法创建表

示例：

// 确保缓存表存在
var tableManager = cacheProvider.GetTableManager();
tableManager.CreateTable<CacheEntity>();

缓存数据不一致

问题：缓存中的数据与数据库不一致

解决方案：

在数据更新后及时使相关缓存失效
使用较短的缓存过期时间
在事务提交后使缓存失效

示例：

using var transaction = provider.BeginTransaction();
try
{
    // 执行数据库操作
    userTable.Update(user);
    transaction.Commit();
    
    // 使缓存失效
    var cacheTable = provider.GetTableManager().Table<CacheEntity>();
    cacheTable.Where(x => x.Table == "User").Delete();
}
catch (Exception)
{
    transaction.Rollback();
    throw;
}

缓存占用过大

问题：缓存表数据过多，影响数据库性能

解决方案：

设置合理的缓存过期时间
定期清理过期缓存
使用独立的数据库作为缓存存储

示例：

// 清理过期缓存
var tableManager = cacheProvider.GetTableManager();
tableManager.Table<CacheEntity>()
    .Where(x => x.ExpireTime < DateTime.Now)
    .Delete();

// 清理特定表的缓存
tableManager.Table<CacheEntity>()
    .Where(x => x.Table == "User")
    .Delete();

类型转换失败

问题：缓存数据反序列化时出现类型转换错误

解决方案：

ORMX 内置了智能类型转换机制
支持各种数值类型、枚举、DateTime、List等类型
转换失败时自动返回默认值

示例：

// 系统自动处理类型转换
var count = userTable.Count();  // int
var total = userTable.Sum(u => u.Amount);  // decimal
var users = userTable.GetList();  // List<User>

最佳实践总结

配置最佳实践

合理设置过期时间：根据数据更新频率设置合适的过期时间
使用独立缓存数据库：对于高性能要求的应用，使用独立的数据库作为缓存
创建缓存表：在应用启动时确保缓存表已创建
定期清理：定期清理过期的缓存数据

使用最佳实践

透明使用：缓存对开发者透明，无需手动管理缓存键
选择合适的缓存策略：根据数据特性选择适当的缓存过期时间
管理缓存失效：在数据更新后及时使相关缓存失效
监控缓存表大小：定期检查缓存表大小，避免过大影响性能

故障处理最佳实践

确保表存在：在应用启动时创建缓存表
定期维护：定期清理过期缓存数据
使用独立数据库：避免缓存操作影响主数据库性能

常见问题与解决方案

缓存表不存在

问题：首次使用缓存时报错，提示表不存在

解决方案：

在应用启动时调用 CreateTable<CacheEntity>()
确保缓存数据库提供程序正确配置

缓存一致性问题

问题：缓存中的数据与数据库不一致

解决方案：

在数据更新后及时使相关缓存失效
使用较短的缓存过期时间
在事务提交后使缓存失效

缓存占用过大

问题：缓存表数据过多，影响数据库性能

解决方案：

设置合理的缓存过期时间
定期清理过期缓存
使用独立的数据库作为缓存存储
监控缓存表大小

类型转换失败

问题：缓存数据反序列化时出现类型转换错误

解决方案：

ORMX 内置了智能类型转换机制，自动处理常见类型
支持数值类型、枚举、DateTime、List等
转换失败时自动返回默认值，不会抛出异常

总结

ORMX 框架通过 CacheBuilder 类提供了内置的数据库缓存功能，为应用性能优化提供了有力支持。通过合理配置和使用缓存，可以显著减少重复数据库查询，提高应用响应速度，支持更多并发用户。

在实际应用中，应根据具体场景选择合适的缓存策略，合理配置缓存参数，并实施有效的缓存管理，以确保缓存系统的稳定运行和最佳性能。

通过本章的学习，您应该能够：

正确配置和使用 ORMX 的数据库缓存功能
使用缓存优化数据库查询性能
实施有效的缓存策略和最佳实践
处理缓存相关的常见问题
为不同应用场景设计合适的缓存方案

扩展思考

如何使用独立的内存数据库（如 SQLite 的 :memory:）作为缓存以实现极致性能？如何在分布式环境中实现跨进程的缓存一致性？如何设计缓存键以支持复杂查询场景的缓存？这些问题值得在深入使用缓存功能后进一步探索。

ORMX 数据库缓存 - 开发日志,：数据库缓存，ORMX 缓存，性能优化，缓存策略，CacheBuilder - 学习 ORMX 框架的数据库缓存集成功能，包括配置使用、缓存策略、性能优化和实际应用场景。

ORMX 数据库缓存

数据库缓存概述

核心价值

缓存机制

安装与配置

基本配置

缓存配置选项

使用独立数据库作为缓存

使用示例

基本查询缓存

自定义缓存过期时间

缓存失效

事务中的缓存管理

实际应用场景

读密集型应用

高频查询优化

分页查询缓存

性能调优

缓存键设计

缓存过期策略

使用独立缓存数据库

缓存表维护

故障处理

缓存表不存在

缓存数据不一致

缓存占用过大

类型转换失败

最佳实践总结

配置最佳实践

使用最佳实践

故障处理最佳实践

常见问题与解决方案

缓存表不存在

缓存一致性问题

缓存占用过大

类型转换失败

总结

扩展思考