RKSoftware.Packages.Caching.System.Text.Json.Converter 3.0.1

RKSoftware.Packages.Caching.System.Text.Json.Converter

System.Text.Json serialization for RKSoftware.Packages.Caching. It contains an IObjectToTextConverter implementation together with the registration extension that plugs it into the cache service, so cached objects are stored in Redis as JSON strings.

The core caching package defines how values are cached but not how they are serialized — this package supplies the missing half. Register exactly one converter package in an application.

Installation

dotnet add package RKSoftware.Packages.Caching
dotnet add package RKSoftware.Packages.Caching.System.Text.Json.Converter

Getting started

Chain the converter registration onto the cache registration:

using RKSoftware.Packages.Caching.Infrastructure;
using RKSoftware.Packages.Caching.System.Text.Json.Converter;

builder.Services
    .UseRKSoftwareCache(
        builder.Configuration.GetSection(nameof(RedisCacheSettings)),
        scopedKeyPrefix: "MyApp")
    .UseSystemTextJsonTextConverter();

Nothing else is required — ICacheService now serializes with System.Text.Json:

using RKSoftware.Packages.Caching.Contract;

public sealed class ProductService(ICacheService cache, IProductRepository repository)
{
    public Task<Product?> GetAsync(int id) =>
        cache.GetOrSetCachedObjectAsync(
            $"product.{id}",
            () => repository.LoadAsync(id),
            storageDuration: 600);
}

What it registers

UseSystemTextJsonTextConverter() (namespace RKSoftware.Packages.Caching.System.Text.Json.Converter) adds two scoped services:

API overview

SystemTextJsonTextConverter implements IObjectToTextConverter:

Both members are constrained to where T : class, matching ICacheService. Serialization uses the System.Text.Json defaults, so annotate your models with System.Text.Json.Serialization attributes ([JsonPropertyName], [JsonIgnore], [JsonConverter]) to influence the output.

Choosing a converter

• Use this package for new code: System.Text.Json is built into the framework and adds no extra dependency.
• Use RKSoftware.Packages.Caching.Newtonsoft.Json.Converter when your models already rely on Newtonsoft.Json attributes or custom converters.
• Use RKSoftware.Packages.Caching.System.Text.Json.StreamConverter for large payloads: it serializes straight to UTF-8 bytes and deserializes from a stream, avoiding the intermediate string this package produces.

Related packages

• — the core caching abstractions this package extends. Required.
• — JSON string serialization with Newtonsoft.Json.
• — UTF-8 byte and stream serialization with System.Text.Json.

Source, issues and full documentation: github.com/rk-software-systems/rk-dn-redis-cache-provider

License

Released into the public domain under The Unlicense.