From 2218b79c5c2458c74512bb700f1ab6bf4050e4f0 Mon Sep 17 00:00:00 2001 From: Vladimir Pecanac Date: Sun, 8 Nov 2026 14:47:03 +0100 Subject: [PATCH] HowToTurnCSharpObjectIntoJson: move to .NET 10, add source generation and options reuse examples Both projects target net10.0. Newtonsoft.Json 13.0.4, MSTest 4.5.2, Microsoft.NET.Test.Sdk 18.11.0, coverlet.collector 10.1.0. Assert.ThrowsException becomes Assert.ThrowsExactly (MSTest 4). Models initialise string properties and Employee.Department is nullable. Date asserts compute the expected en-US string so they pass on Linux ICU. New ProductJsonContext and three tests: source-generated context, reused options instance, Newtonsoft PreserveReferencesHandling. --- .../AdditionalSerializationTests.cs | 65 +++++++++++++++++++ .../HowToTurnCSharpObjectIntoJson.Test.csproj | 9 +-- .../NewtonsoftSerializationTests.cs | 7 +- .../SystemTextJsonSerializationTests.cs | 9 ++- .../HowToTurnCSharpObjectIntoJson.csproj | 4 +- .../Models/Customer.cs | 4 +- .../Models/CustomerNewtonsoft.cs | 4 +- .../Models/Employee.cs | 6 +- .../Models/Person.cs | 4 +- .../Models/Product.cs | 7 +- .../Models/ProductJsonContext.cs | 8 +++ 11 files changed, 102 insertions(+), 25 deletions(-) create mode 100644 json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/AdditionalSerializationTests.cs create mode 100644 json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/ProductJsonContext.cs diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/AdditionalSerializationTests.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/AdditionalSerializationTests.cs new file mode 100644 index 0000000000..5145e7d1c2 --- /dev/null +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/AdditionalSerializationTests.cs @@ -0,0 +1,65 @@ +using HowToTurnCSharpObjectIntoJson.Models; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using Newtonsoft.Json; +using System; +using System.Text.Json; + +namespace HowToTurnCSharpObjectIntoJson.Test +{ + [TestClass] + public class AdditionalSerializationTests + { + private static readonly JsonSerializerOptions IndentedOptions = new() + { + WriteIndented = true + }; + + [TestMethod] + public void WhenUsingSourceGeneratedContext_ThenSameJsonString() + { + var obj = new Product + { + Name = "Red Apples", + Stock = 100, + DateAcquired = DateTime.Parse("2017-08-24") + }; + + var jsonString = System.Text.Json.JsonSerializer.Serialize(obj, ProductJsonContext.Default.Product); + + Assert.AreEqual("{\"Name\":\"Red Apples\",\"Stock\":100,\"DateAcquired\":\"2017-08-24T00:00:00\"}", jsonString); + } + + [TestMethod] + public void WhenReusingOptionsInstance_ThenJsonIsIndented() + { + var obj = new Product + { + Name = "Red Apples", + Stock = 100, + DateAcquired = DateTime.Parse("2017-08-24") + }; + + var jsonString = System.Text.Json.JsonSerializer.Serialize(obj, IndentedOptions); + + Assert.AreEqual($"{{{Environment.NewLine} \"Name\": \"Red Apples\",{Environment.NewLine} \"Stock\": 100,{Environment.NewLine} \"DateAcquired\": \"2017-08-24T00:00:00\"{Environment.NewLine}}}", jsonString); + } + + [TestMethod] + public void WhenNewtonsoftPreservesReferences_ThenJsonHasIdsAndRefs() + { + var employee = new Employee { FirstName = "John", LastName = "Smith" }; + var department = new Department { Name = "Human Resources" }; + employee.Department = department; + department.Staff.Add(employee); + + var options = new JsonSerializerSettings + { + PreserveReferencesHandling = PreserveReferencesHandling.Objects + }; + + var jsonString = JsonConvert.SerializeObject(department, options); + + Assert.AreEqual("{\"$id\":\"1\",\"Name\":\"Human Resources\",\"Staff\":[{\"$id\":\"2\",\"FirstName\":\"John\",\"LastName\":\"Smith\",\"Department\":{\"$ref\":\"1\"}}]}", jsonString); + } + } +} diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/HowToTurnCSharpObjectIntoJson.Test.csproj b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/HowToTurnCSharpObjectIntoJson.Test.csproj index 152e99c0eb..55a925bc80 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/HowToTurnCSharpObjectIntoJson.Test.csproj +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/HowToTurnCSharpObjectIntoJson.Test.csproj @@ -1,16 +1,17 @@ - net6.0 + net10.0 enable false - - - + + + + diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/NewtonsoftSerializationTests.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/NewtonsoftSerializationTests.cs index c74ee2dfc5..1889c37287 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/NewtonsoftSerializationTests.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/NewtonsoftSerializationTests.cs @@ -4,6 +4,7 @@ using Newtonsoft.Json; using Newtonsoft.Json.Serialization; using System; +using System.Globalization; using System.IO; namespace HowToTurnCSharpObjectIntoJson.Test @@ -131,7 +132,9 @@ public void WhenUsingCustomDateTimeConverter_ThenDateTimeFormatApplied() var jsonString = JsonConvert.SerializeObject(obj, new GeneralDateTimeNewtonsoftConverter()); // assert - Assert.AreEqual($"{{\"DueDate\":\"8/24/2017 12:00:00 AM\"}}", jsonString); + var expectedDate = new DateTime(2017, 8, 24).ToString("G", new CultureInfo("en-US")); + + Assert.AreEqual($"{{\"DueDate\":{JsonConvert.SerializeObject(expectedDate)}}}", jsonString); } [TestMethod] @@ -144,7 +147,7 @@ public void WhenReferenceLoop_ThenThrowsException() department.Staff.Add(employee); // act & assert - Assert.ThrowsException(() => JsonConvert.SerializeObject(employee)); + Assert.ThrowsExactly(() => JsonConvert.SerializeObject(employee)); } diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/SystemTextJsonSerializationTests.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/SystemTextJsonSerializationTests.cs index cf0db2d8cf..4956707d47 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/SystemTextJsonSerializationTests.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.Test/SystemTextJsonSerializationTests.cs @@ -2,6 +2,7 @@ using HowToTurnCSharpObjectIntoJson.Models; using Microsoft.VisualStudio.TestTools.UnitTesting; using System; +using System.Globalization; using System.IO; using System.Text.Json; using System.Text.Json.Serialization; @@ -139,7 +140,9 @@ public void WhenUsingCustomDateTimeConverter_ThenDateTimeFormatApplied() var jsonString = JsonSerializer.Serialize(obj, options); // assert - Assert.AreEqual("{\"DateCreated\":\"8/24/2017 12:00:00 AM\"}", jsonString); + var expectedDate = new DateTime(2017, 8, 24).ToString("G", new CultureInfo("en-US")); + + Assert.AreEqual($"{{\"DateCreated\":{JsonSerializer.Serialize(expectedDate)}}}", jsonString); } [TestMethod] @@ -162,7 +165,7 @@ public void WhenJsonConverterAttribute_ThenDateTimeFormatApplied() var jsonString = JsonSerializer.Serialize(obj, options); // assert - Assert.AreEqual($"{{{Environment.NewLine} \"FirstName\": \"John\",{Environment.NewLine} \"LastName\": \"Smith\",{Environment.NewLine} \"BirthDate\": \"8/24/2017 12:00:00 AM\"{Environment.NewLine}}}", jsonString); + Assert.AreEqual($"{{{Environment.NewLine} \"FirstName\": \"John\",{Environment.NewLine} \"LastName\": \"Smith\",{Environment.NewLine} \"BirthDate\": {JsonSerializer.Serialize(new DateTime(2017, 8, 24).ToString("G", new CultureInfo("en-US")))}{Environment.NewLine}}}", jsonString); } [TestMethod] @@ -175,7 +178,7 @@ public void WhenReferenceLoop_ThenThrowsException() department.Staff.Add(employee); // act & assert - Assert.ThrowsException(() => JsonSerializer.Serialize(employee)); + Assert.ThrowsExactly(() => JsonSerializer.Serialize(employee)); } [TestMethod] diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.csproj b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.csproj index 11b28f3a8f..6c67c2fd4a 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.csproj +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson.csproj @@ -2,13 +2,13 @@ Exe - net6.0 + net10.0 enable enable - + diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Customer.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Customer.cs index e7ebf4518b..a8bd9d8e43 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Customer.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Customer.cs @@ -4,9 +4,9 @@ namespace HowToTurnCSharpObjectIntoJson.Models { public class Customer { - public string Name { get; set; } + public string Name { get; set; } = string.Empty; - public string Address { get; set; } + public string Address { get; set; } = string.Empty; [JsonIgnore] public decimal FinancialRating { get; set; } diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/CustomerNewtonsoft.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/CustomerNewtonsoft.cs index c6b38054dd..2c40842464 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/CustomerNewtonsoft.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/CustomerNewtonsoft.cs @@ -4,9 +4,9 @@ namespace HowToTurnCSharpObjectIntoJson.Models { public class CustomerNewtonsoft { - public string Name { get; set; } + public string Name { get; set; } = string.Empty; - public string Address { get; set; } + public string Address { get; set; } = string.Empty; [JsonIgnore] public decimal FinancialRating { get; set; } diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Employee.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Employee.cs index 831866e410..e806f6d94c 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Employee.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Employee.cs @@ -2,8 +2,8 @@ { public class Employee { - public string FirstName { get; set; } - public string LastName { get; set; } - public Department Department { get; set; } + public string FirstName { get; set; } = string.Empty; + public string LastName { get; set; } = string.Empty; + public Department? Department { get; set; } } } diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Person.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Person.cs index 91b01fc83d..bdf1d11716 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Person.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Person.cs @@ -5,8 +5,8 @@ namespace HowToTurnCSharpObjectIntoJson.Models { public class Person { - public string FirstName { get; set; } - public string LastName { get; set; } + public string FirstName { get; set; } = string.Empty; + public string LastName { get; set; } = string.Empty; [JsonConverter(typeof(GeneralDateTimeConverter))] public DateTime BirthDate { get; set; } diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Product.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Product.cs index e4dcbe78dd..f913e6214f 100644 --- a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Product.cs +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/Product.cs @@ -1,11 +1,8 @@ -using HowToTurnCSharpObjectIntoJson.Converters; -using Newtonsoft.Json; - -namespace HowToTurnCSharpObjectIntoJson.Models +namespace HowToTurnCSharpObjectIntoJson.Models { public class Product { - public string Name { get; set; } + public string Name { get; set; } = string.Empty; public int? Stock { get; set; } diff --git a/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/ProductJsonContext.cs b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/ProductJsonContext.cs new file mode 100644 index 0000000000..63b6d09d45 --- /dev/null +++ b/json-csharp/HowToTurnCSharpObjectIntoJson/HowToTurnCSharpObjectIntoJson/Models/ProductJsonContext.cs @@ -0,0 +1,8 @@ +using System.Text.Json.Serialization; + +namespace HowToTurnCSharpObjectIntoJson.Models; + +[JsonSerializable(typeof(Product))] +public partial class ProductJsonContext : JsonSerializerContext +{ +}