Quartz.NET/Quartz.Serialization.SystemTextJsonv3.13.1

::: tip JSON is recommended persistent format to store data in database for greenfield projects. You should also strongly consider setting useProperties to true to restrict key-values to be strings. :::

Quartz.Serialization.SystemTextJson provides JSON serialization support for job stores using System.Text.Json facilities to handle the actual serialization process.

Installation

You need to add NuGet package reference to your project which uses Quartz.

Install-Package Quartz.Serialization.SystemTextJson

Configuring

Classic property-based configuration

var properties = new NameValueCollection { ["quartz.jobStore.type"] = "Quartz.Impl.AdoJobStore.JobStoreTX, Quartz", ["quartz.serializer.type"] = "stj" }; ISchedulerFactory schedulerFactory = new StdSchedulerFactory(properties);

Configuring using scheduler builder

var config = SchedulerBuilder.Create(); config.UsePersistentStore(store => { // it's generally recommended to stick with // string property keys and values when serializing store.UseProperties = true; store.UseGenericDatabase(dbProvider, db => db.ConnectionString = "my connection string" ); store.UseSystemTextJsonSerializer(); }); ISchedulerFactory schedulerFactory = config.Build();

Migrating from binary serialization

There's now official solution for migration as there can be quirks in every setup, but there's a recipe that can work for you.

• Configure custom serializer like MigratorSerializer below that can read binary serialization format and writes JSON format
• Either let system gradually migrate as it's running or create a program which loads and writes back to DB all relevant serialized assets

Example hybrid serializer

using System.Text.Json; using Quartz.Simpl; using Quartz.Spi; namespace Quartz; public sealed class MigratorSerializer : IObjectSerializer { private readonly BinaryObjectSerializer binarySerializer; private readonly SystemTextJsonObjectSerializer jsonSerializer; public MigratorSerializer() { binarySerializer = new BinaryObjectSerializer(); // you might need custom configuration, see sections about customizing // in documentation jsonSerializer = new SystemTextJsonObjectSerializer(); } public T DeSerialize<T>(byte[] data) where T : class { try { // Attempt to deserialize data as JSON return jsonSerializer.DeSerialize<T>(data)!; } catch (JsonException) { // Presumably, the data was not JSON, we instead use the binary serializer var binaryData = binarySerializer.DeSerialize<T>(data); if (binaryData is JobDataMap jobDataMap) { // make sure we mark the map as dirty so it will be serialized as JSON next time jobDataMap[SchedulerConstants.ForceJobDataMapDirty] = "true"; } return binaryData!; } } public void Initialize() { binarySerializer.Initialize(); jsonSerializer.Initialize(); } public byte[] Serialize<T>(T obj) where T : class { return jsonSerializer.Serialize(obj); } }