Let BaseObjectStorageHelper use custom JsonSerializerOptions

Author: sperrat

Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/BaseObjectStorageHelper.cs

@@ -16,7 +16,26 @@ namespace Microsoft.Toolkit.Uwp.Helpers
     /// </summary>
     public abstract class BaseObjectStorageHelper : IObjectStorageHelper
     {
-        private JsonSerializer serializer = new JsonSerializer();
+        private readonly JsonSerializerSettings settings;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BaseObjectStorageHelper"/> class,
+        /// which can read and write serialized data using the provided <see cref="JsonSerializerSettings"/>.
+        /// </summary>
+        /// <param name="serializerSettings">The serializer settings to use.</param>
+        public BaseObjectStorageHelper(JsonSerializerSettings serializerSettings)
+        {
+            settings = serializerSettings;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BaseObjectStorageHelper"/> class,
+        /// which can read and write serialized data using the default <see cref="JsonSerializerSettings"/>.
+        /// </summary>
+        public BaseObjectStorageHelper()
+            : this(new JsonSerializerSettings())
+        {
+        }
 
         /// <summary>
         /// Gets or sets the settings container.
@@ -87,7 +106,7 @@ public bool KeyExists(string compositeKey, string key)
                 return (T)Convert.ChangeType(value, type);
             }
 
-            return JsonConvert.DeserializeObject<T>((string)value);
+            return Deserialize<T>((string)value);
         }
 
         /// <summary>
@@ -106,7 +125,7 @@ public bool KeyExists(string compositeKey, string key)
                 string value = (string)composite[key];
                 if (value != null)
                 {
-                    return JsonConvert.DeserializeObject<T>(value);
+                    return Deserialize<T>(value);
                 }
             }
 
@@ -132,7 +151,7 @@ public void Save<T>(string key, T value)
             }
             else
             {
-                Settings.Values[key] = JsonConvert.SerializeObject(value);
+                Settings.Values[key] = Serialize(value);
             }
         }
 
@@ -155,11 +174,11 @@ public void Save<T>(string compositeKey, IDictionary<string, T> values)
                 {
                     if (composite.ContainsKey(setting.Key))
                     {
-                        composite[setting.Key] = JsonConvert.SerializeObject(setting.Value);
+                        composite[setting.Key] = Serialize(setting.Value);
                     }
                     else
                     {
-                        composite.Add(setting.Key, JsonConvert.SerializeObject(setting.Value));
+                        composite.Add(setting.Key, Serialize(setting.Value));
                     }
                 }
             }
@@ -168,7 +187,7 @@ public void Save<T>(string compositeKey, IDictionary<string, T> values)
                 ApplicationDataCompositeValue composite = new ApplicationDataCompositeValue();
                 foreach (KeyValuePair<string, T> setting in values)
                 {
-                    composite.Add(setting.Key, JsonConvert.SerializeObject(setting.Value));
+                    composite.Add(setting.Key, Serialize(setting.Value));
                 }
 
                 Settings.Values[compositeKey] = composite;
@@ -195,7 +214,7 @@ public Task<bool> FileExistsAsync(string filePath)
         public async Task<T> ReadFileAsync<T>(string filePath, T @default = default(T))
         {
             string value = await StorageFileHelper.ReadTextFromFileAsync(Folder, filePath);
-            return (value != null) ? JsonConvert.DeserializeObject<T>(value) : @default;
+            return (value != null) ? Deserialize<T>(value) : @default;
         }
 
         /// <summary>
@@ -208,7 +227,11 @@ public Task<bool> FileExistsAsync(string filePath)
         /// <returns>The <see cref="StorageFile"/> where the object was saved</returns>
         public Task<StorageFile> SaveFileAsync<T>(string filePath, T value)
         {
-            return StorageFileHelper.WriteTextToFileAsync(Folder, JsonConvert.SerializeObject(value), filePath, CreationCollisionOption.ReplaceExisting);
+            return StorageFileHelper.WriteTextToFileAsync(Folder, Serialize(value), filePath, CreationCollisionOption.ReplaceExisting);
         }
+
+        private string Serialize<T>(T value) => JsonConvert.SerializeObject(value, typeof(T), settings);
+
+        private T Deserialize<T>(string value) => JsonConvert.DeserializeObject<T>(value, settings);
     }
 }

Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/LocalObjectStorageHelper.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using Newtonsoft.Json;
 using Windows.Storage;
 
 namespace Microsoft.Toolkit.Uwp.Helpers
@@ -12,12 +13,24 @@ namespace Microsoft.Toolkit.Uwp.Helpers
     public class LocalObjectStorageHelper : BaseObjectStorageHelper
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="LocalObjectStorageHelper"/> class.
+        /// Initializes a new instance of the <see cref="LocalObjectStorageHelper"/> class,
+        /// which can read and write serialized data using the provided <see cref="JsonSerializerSettings"/>.
         /// </summary>
-        public LocalObjectStorageHelper()
+        /// <param name="serializerSettings">The serializer settings to use.</param>
+        public LocalObjectStorageHelper(JsonSerializerSettings serializerSettings)
+            : base(serializerSettings)
         {
             Settings = ApplicationData.Current.LocalSettings;
             Folder = ApplicationData.Current.LocalFolder;
         }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LocalObjectStorageHelper"/> class,
+        /// which can read and write serialized data using the default <see cref="JsonSerializerSettings"/>.
+        /// </summary>
+        public LocalObjectStorageHelper()
+            : this(new JsonSerializerSettings())
+        {
+        }
     }
 }

Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/RoamingObjectStorageHelper.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using Newtonsoft.Json;
 using Windows.Storage;
 
 namespace Microsoft.Toolkit.Uwp.Helpers
@@ -12,12 +13,24 @@ namespace Microsoft.Toolkit.Uwp.Helpers
     public class RoamingObjectStorageHelper : BaseObjectStorageHelper
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="RoamingObjectStorageHelper"/> class.
+        /// Initializes a new instance of the <see cref="RoamingObjectStorageHelper"/> class,
+        /// which can read and write serialized data using the provided <see cref="JsonSerializerSettings"/>.
         /// </summary>
-        public RoamingObjectStorageHelper()
+        /// <param name="serializerSettings">The serializer settings to use.</param>
+        public RoamingObjectStorageHelper(JsonSerializerSettings serializerSettings)
+            : base(serializerSettings)
         {
             Settings = ApplicationData.Current.RoamingSettings;
             Folder = ApplicationData.Current.RoamingFolder;
         }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RoamingObjectStorageHelper"/> class,
+        /// which can read and write serialized data using the default <see cref="JsonSerializerSettings"/>.
+        /// </summary>
+        public RoamingObjectStorageHelper()
+            : this(new JsonSerializerSettings())
+        {
+        }
     }
 }