aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Data.Caching/src/JsonCacheObjectSerializer.cs
blob: 09fbd6ce5bf8c661ab710b9ec3718aa986c027d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Data.Caching
* File: JsonCacheObjectSerializer.cs 
*
* JsonCacheObjectSerializer.cs is part of VNLib.Data.Caching which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Data.Caching is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Data.Caching is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

using System;

using System.IO;
using System.Buffers;
using System.Threading;
using System.Text.Json;
using System.Text.Json.Serialization;

namespace VNLib.Data.Caching
{
    /// <summary>
    /// Implements a <see cref="ICacheObjectDeserializer"/> and a <see cref="ICacheObjectSerializer"/>
    /// that uses JSON serialization, with writer pooling. Members of this class are thread-safe.
    /// </summary>
    public class JsonCacheObjectSerializer : ICacheObjectSerializer, ICacheObjectDeserializer
    {
        private static readonly ThreadLocal<Utf8JsonWriter> _writer = new(static () => new(Stream.Null));

        private readonly JsonSerializerOptions? _options;

        /// <summary>
        /// Initializes a new <see cref="JsonCacheObjectSerializer"/>
        /// </summary>
        /// <param name="options">JSON serialization/deserialization options</param>
        public JsonCacheObjectSerializer(JsonSerializerOptions options) => _options = options;

        /// <summary>
        /// Initializes a new <see cref="JsonCacheObjectSerializer"/> using 
        /// the default serialization rules
        /// </summary>
        public JsonCacheObjectSerializer(int bufferSize)
        {
            //Configure default serialzation options
            _options = new()
            {
                DictionaryKeyPolicy = JsonNamingPolicy.CamelCase,
                NumberHandling = JsonNumberHandling.Strict,
                ReadCommentHandling = JsonCommentHandling.Disallow,
                WriteIndented = false,
                DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
                IgnoreReadOnlyFields = true,
                PropertyNameCaseInsensitive = true,
                IncludeFields = false,
                DefaultBufferSize = bufferSize
            };
        }

        ///<inheritdoc/>
        public virtual T? Deserialize<T>(ReadOnlySpan<byte> objectData) => JsonSerializer.Deserialize<T>(objectData, _options);

        ///<inheritdoc/>
        public virtual void Serialize<T>(T obj, IBufferWriter<byte> finiteWriter)
        {
            //Read thread-local writer
            Utf8JsonWriter localWriter = _writer.Value!;

            //Init the writer with the new buffer writer
            localWriter.Reset(finiteWriter);
            try
            {
                //Serialize message
                JsonSerializer.Serialize(localWriter, obj, _options);

                //Flush writer to underlying buffer
                localWriter.Flush();
            }
            finally
            {
                //Unlink the writer
                localWriter.Reset(Stream.Null);
            }
        }
    }
}