Merge pull request #205 from TurnerSoftware/system-text-json-serializer

Add System.Text.Json serializer

Author: Turnerj

CacheTower.sln

@@ -45,6 +45,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CacheTower.Serializers.Newt
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CacheTower.Serializers.Protobuf", "src\CacheTower.Serializers.Protobuf\CacheTower.Serializers.Protobuf.csproj", "{436A6DF0-3DD8-4342-ACC5-EF0B8D5DF9DD}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CacheTower.Serializers.SystemTextJson", "src\CacheTower.Serializers.SystemTextJson\CacheTower.Serializers.SystemTextJson.csproj", "{4E94E3E8-3CC0-4F23-BFD7-157C8C386AFB}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -95,6 +97,10 @@ Global
 		{436A6DF0-3DD8-4342-ACC5-EF0B8D5DF9DD}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{436A6DF0-3DD8-4342-ACC5-EF0B8D5DF9DD}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{436A6DF0-3DD8-4342-ACC5-EF0B8D5DF9DD}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4E94E3E8-3CC0-4F23-BFD7-157C8C386AFB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4E94E3E8-3CC0-4F23-BFD7-157C8C386AFB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4E94E3E8-3CC0-4F23-BFD7-157C8C386AFB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4E94E3E8-3CC0-4F23-BFD7-157C8C386AFB}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -111,6 +117,7 @@ Global
 		{7830CC14-9FF6-4C56-BBFE-8AE9B6C7AFFA} = {FD0B0385-93AD-4DDF-9FE7-C7325B05B6B0}
 		{06C698D6-51AB-4DA5-ABF3-5207115A38B9} = {E261C038-498E-4F5A-B2D7-B79AB36FFEB0}
 		{436A6DF0-3DD8-4342-ACC5-EF0B8D5DF9DD} = {E261C038-498E-4F5A-B2D7-B79AB36FFEB0}
+		{4E94E3E8-3CC0-4F23-BFD7-157C8C386AFB} = {E261C038-498E-4F5A-B2D7-B79AB36FFEB0}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {F159337A-B345-49EE-8D58-A72EF1643174}

README.md

@@ -215,6 +215,15 @@ PM> Install-Package CacheTower.Serializers.NewtonsoftJson
 
 Uses [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json/) to perform serialization.
 
+
+### SystemTextJsonCacheSerializer
+
+```powershell
+PM> Install-Package CacheTower.Serializers.SystemTextJson
+```
+
+Uses [System.Text.Json](https://www.nuget.org/packages/System.Text.Json) to perform serialization.
+
 ### ProtobufCacheSerializer
 
 ```powershell

src/CacheTower.Serializers.SystemTextJson/CacheTower.Serializers.SystemTextJson.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<TargetFramework>netstandard2.0</TargetFramework>
+		<Title>Newtonsoft.Json Serializer for Cache Tower</Title>
+		<Description>Newtonsoft.Json cache serialization for Cache Tower</Description>
+		<PackageTags>newtonsoft;json;$(PackageBaseTags)</PackageTags>
+		<Authors>James Turner</Authors>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="System.Text.Json" Version="6.0.5" />
+	</ItemGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\CacheTower\CacheTower.csproj" />
+	</ItemGroup>
+
+</Project>
+

src/CacheTower.Serializers.SystemTextJson/SystemTextJsonCacheSerializer.cs

@@ -0,0 +1,39 @@
+using System.IO;
+using System.Text.Json;
+
+namespace CacheTower.Serializers.SystemTextJson;
+
+/// <summary>
+/// Allows serializing to and from JSON via System.Text.Json
+/// </summary>
+public class SystemTextJsonCacheSerializer : ICacheSerializer
+{
+	private readonly JsonSerializerOptions? options;
+
+	private SystemTextJsonCacheSerializer() { }
+
+	/// <summary>
+	/// An existing instance of <see cref="SystemTextJsonCacheSerializer"/>.
+	/// </summary>
+	public static SystemTextJsonCacheSerializer Instance { get; } = new();
+
+	/// <summary>
+	/// Creates a new instance of <see cref="SystemTextJsonCacheSerializer"/> with the specified <paramref name="options"/>.
+	/// </summary>
+	public SystemTextJsonCacheSerializer(JsonSerializerOptions options)
+	{
+		this.options = options;
+	}
+
+	/// <inheritdoc/>
+	public void Serialize<T>(Stream stream, T? value)
+	{
+		JsonSerializer.Serialize(stream, value, options);
+	}
+
+	/// <inheritdoc/>
+	public T? Deserialize<T>(Stream stream)
+	{
+		return JsonSerializer.Deserialize<T>(stream, options);
+	}
+}

tests/CacheTower.Tests/CacheTower.Tests.csproj

@@ -25,6 +25,7 @@
     <ProjectReference Include="..\..\src\CacheTower.Providers.FileSystem.Json\CacheTower.Providers.FileSystem.Json.csproj" />
     <ProjectReference Include="..\..\src\CacheTower.Providers.FileSystem.Protobuf\CacheTower.Providers.FileSystem.Protobuf.csproj" />
     <ProjectReference Include="..\..\src\CacheTower.Providers.Redis\CacheTower.Providers.Redis.csproj" />
+    <ProjectReference Include="..\..\src\CacheTower.Serializers.SystemTextJson\CacheTower.Serializers.SystemTextJson.csproj" />
     <ProjectReference Include="..\..\src\CacheTower\CacheTower.csproj" />
   </ItemGroup>
 

tests/CacheTower.Tests/Serializers/SystemTextJsonCacheSerializerTests.cs

@@ -0,0 +1,21 @@
+using CacheTower.Serializers.SystemTextJson;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace CacheTower.Tests.Serializers
+{
+	[TestClass]
+	public class SystemTextJsonCacheSerializerTests : BaseSerializerTests<SystemTextJsonCacheSerializer>
+	{
+		[TestMethod]
+		public void CacheEntrySerialization()
+		{
+			AssertCacheEntrySerialization(SystemTextJsonCacheSerializer.Instance);
+		}
+
+		[TestMethod]
+		public void AssertManifestSerialization()
+		{
+			AssertCacheEntrySerialization(SystemTextJsonCacheSerializer.Instance);
+		}
+	}
+}