Sparkdo.Caching 1.0.2

There is a newer prerelease version of this package available.
See the version list below for details.

dotnet add package Sparkdo.Caching --version 1.0.2

NuGet\Install-Package Sparkdo.Caching -Version 1.0.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Sparkdo.Caching" Version="1.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Sparkdo.Caching" Version="1.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="Sparkdo.Caching" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Sparkdo.Caching --version 1.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Sparkdo.Caching, 1.0.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Sparkdo.Caching@1.0.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Sparkdo.Caching&version=1.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Sparkdo.Caching&version=1.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Sparkdo.Caching

Sparkdo 缓存库，提供分布式缓存功能实现。

功能特性

分布式缓存接口：提供通用的分布式缓存接口定义
默认缓存实现：基于 Microsoft.Extensions.Caching.Distributed 的默认实现
多租户支持：支持多租户场景下的缓存隔离
工作单元集成：与工作单元集成，支持事务性缓存操作
缓存键标准化：提供缓存键标准化机制
JSON 序列化：基于 UTF-8 JSON 的缓存项序列化
异常处理：可配置的缓存异常处理机制
与 Sparkdo 框架无缝集成

安装

<PackageReference Include="Sparkdo.Caching" Version="x.x.x" />

核心组件

缓存接口

IDistributedCache<TCacheItem>: 分布式缓存接口（字符串键）
IDistributedCache<TCacheItem, TCacheKey>: 分布式缓存接口（泛型键）

缓存实现

DefaultDistributedCache<TCacheItem>: 默认分布式缓存实现（字符串键）
DefaultDistributedCache<TCacheItem, TCacheKey>: 默认分布式缓存实现（泛型键）

缓存配置

SparkdoDistributedCacheOptions: 分布式缓存配置选项
DistributedCacheKeyNormalizeArgs: 缓存键标准化参数
IDistributedCacheKeyNormalizer: 缓存键标准化器接口
DefaultDistributedCacheKeyNormalizer: 默认缓存键标准化器实现

序列化

IDistributedCacheSerializer: 分布式缓存序列化器接口
Utf8JsonDistributedCacheSerializer: UTF-8 JSON 缓存序列化器实现

其他组件

ICacheSupportsMultipleItems: 支持多项操作的缓存接口
CacheNameAttribute: 缓存名称特性
UnitOfWorkCacheItem: 工作单元缓存项
UnitOfWorkCacheItemExtensions: 工作单元缓存项扩展方法

使用示例

基本缓存使用

public class MyService
{
    private readonly IDistributedCache<MyCacheItem> _cache;
    
    public MyService(IDistributedCache<MyCacheItem> cache)
    {
        _cache = cache;
    }
    
    public async Task<MyCacheItem> GetDataAsync(string key)
    {
        // 尝试从缓存获取数据
        var cachedItem = await _cache.GetAsync(key);
        if (cachedItem != null)
        {
            return cachedItem;
        }
        
        // 如果缓存中没有，从数据源获取
        var item = await GetDataFromSourceAsync(key);
        
        // 将数据存入缓存
        await _cache.SetAsync(key, item);
        
        return item;
    }
}

批量缓存操作

public class MyService
{
    private readonly IDistributedCache<MyCacheItem, int> _cache;
    
    public MyService(IDistributedCache<MyCacheItem, int> cache)
    {
        _cache = cache;
    }
    
    public async Task<Dictionary<int, MyCacheItem>> GetBatchDataAsync(int[] keys)
    {
        // 批量获取缓存数据
        var cachedItems = await _cache.GetManyAsync(keys);
        
        var result = new Dictionary<int, MyCacheItem>();
        var missingKeys = new List<int>();
        
        // 分离已缓存和未缓存的数据
        foreach (var item in cachedItems)
        {
            if (item.Value != null)
            {
                result[item.Key] = item.Value;
            }
            else
            {
                missingKeys.Add(item.Key);
            }
        }
        
        // 获取未缓存的数据
        if (missingKeys.Any())
        {
            var missingItems = await GetBatchDataFromSourceAsync(missingKeys);
            
            // 批量设置缓存
            var itemsToCache = missingItems.Select(x => new KeyValuePair<int, MyCacheItem>(x.Key, x.Value));
            await _cache.SetManyAsync(itemsToCache);
            
            // 合并结果
            foreach (var item in missingItems)
            {
                result[item.Key] = item.Value;
            }
        }
        
        return result;
    }
}

缓存配置

// 在模块配置中自定义缓存选项
public override void Configure(IConfigureContext context)
{
    context.Services.Configure<SparkdoDistributedCacheOptions>(options =>
    {
        // 配置全局缓存条目选项
        options.GlobalCacheEntryOptions.AbsoluteExpirationRelativeToNow = TimeSpan.FromHours(1);
        
        // 为特定缓存类型配置选项
        options.ConfigureCache<MyCacheItem>(new DistributedCacheEntryOptions
        {
            SlidingExpiration = TimeSpan.FromMinutes(30)
        });
    });
}

扩展性

该库提供了完整的缓存功能实现，可以通过以下方式扩展：

实现自定义的缓存键标准化器
实现自定义的缓存序列化器
实现自定义的缓存提供者
通过配置选项自定义缓存行为
通过继承和重写默认实现来定制缓存功能

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- JetBrains.Annotations (>= 2025.2.4)
- Microsoft.Extensions.Caching.Memory (>= 10.0.5)
- Microsoft.Extensions.Configuration (>= 10.0.5)
- Microsoft.Extensions.Configuration.CommandLine (>= 10.0.5)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.5)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.5)
- Microsoft.Extensions.Configuration.Json (>= 10.0.5)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.DependencyModel (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Composite (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Embedded (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Physical (>= 10.0.5)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Localization (>= 10.0.5)
- Microsoft.Extensions.Logging (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.0.5)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.5)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.5)
- Nito.AsyncEx.Context (>= 5.1.2)
- Sparkdo.Json (>= 1.0.2)
- Sparkdo.MultiTenancy.Abstractions (>= 1.0.2)
- Sparkdo.Threading (>= 1.0.2)
- Sparkdo.Uow.Abstractions (>= 1.0.2)
- System.Linq.Dynamic.Core (>= 1.7.1)
- TimeZoneConverter (>= 7.2.0)

NuGet packages (14)

Showing the top 5 NuGet packages that depend on Sparkdo.Caching:

Package	Downloads
Sparkdo.Ddd.Domain Sparkdo DDD 领域模型库，提供领域驱动设计的核心组件实现	2.5K
Sparkdo.BlobStoring.Aliyun Sparkdo 阿里云 OSS 存储提供程序，用于将 BLOB 数据存储到阿里云对象存储服务中	1.2K
Sparkdo.Caching.Hybrid Sparkdo 混合缓存库，提供基于 Microsoft.Extensions.Caching.Hybrid 的混合缓存功能实现	1.2K
Sparkdo.BlobStoring.Aws Sparkdo AWS S3 BLOB 存储提供程序，用于在 Amazon S3 云存储中存储和检索二进制大对象	1.1K
Sparkdo.BlobStoring.Minio Sparkdo MinIO BLOB 存储提供程序，用于在 MinIO 对象存储中存储和检索二进制大对象	1.1K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.3-preview.1	0	5/17/2026
1.0.2	362	4/27/2026
1.0.2-preview.5	86	4/15/2026
1.0.2-preview.4	106	2/8/2026
1.0.2-preview.3	106	2/1/2026
1.0.2-preview.2	125	1/31/2026
1.0.2-preview.1	199	12/4/2025
1.0.1	1,060	11/27/2025
1.0.0	1,035	11/25/2025
1.0.0-preview.5	137	10/24/2025

Sparkdo.Caching 1.0.2

Sparkdo.Caching

功能特性

安装

核心组件

缓存接口

缓存实现

缓存配置

序列化

其他组件

使用示例

基本缓存使用

批量缓存操作

缓存配置

扩展性

net10.0

NuGet packages (14)

GitHub repositories