#
Json.NET#
-
This fork improves GUID Handling from .NET 4.0 onwards (woking in progress in pre TryCast .NET versions).
-
Support deserialize GUID from base class. Now return a GUID instead a string because in some scenarios( i.e. when you seriliaze a GUID from a Object Array and deserialize it), the GUID become a plain String instance even with full TypeNameHandling.
-
Support serialize and deserialize into/from all .NET GUID formats. Useful if you have to deserialize a 3rd party JSON with different GUID format or you have to generate the JSON and send it to 3rd party service that needs different GUID format.
-
Auto format. Useful for deserialize from several JSON with various GUID formats without coding it explicitly.
-
No breaking changes. Let default behaviour work as allways does.
Example of deserialize GUID to object problem:
public class Clase
{
public Clase()
{
Propiedad = new Object[1];
}
public object[] Propiedad { get; set; }
}
Clase clase = new Clase();
clase.Propiedad[0] = Guid.NewGuid();
string output;
output = JsonConvert.SerializeObject(clase, Formatting.Indented, new JsonSerializerSettings
{
TypeNameHandling = TypeNameHandling.All
});
Clase deserializedr = JsonConvert.DeserializeObject<Clase>(output, new JsonSerializerSettings
{
TypeNameHandling = TypeNameHandling.All
});
Console.WriteLine(deserializedr.Propiedad[0].GetType()); // String!!!!How GUID Handling works:
A new setting was added to JsonSerializerSettings. This setting allows you to control GUID format when serialize/deserialize.
public enum GuidHandling
{
/// <summary>
/// Default Newtonsoft.Json handling. Gives you a String on deserilize in some scenarios.
/// </summary>
Default = 0,
/// <summary>
/// 00000000000000000000000000000000
/// </summary>
Digits = 1,
/// <summary>
/// 00000000-0000-0000-0000-000000000000
/// </summary>
Hyphens = 2,
/// <summary>
/// {00000000-0000-0000-0000-000000000000}
/// </summary>
Braces = 3,
/// <summary>
/// (00000000-0000-0000-0000-000000000000)
/// </summary>
Parentheses = 4,
/// <summary>
/// {0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}}
/// </summary>
Hexadecimal = 5,
/// <summary>
/// Default format on serialize. Parse any valid format on deserialize and gives you GUID instance instead String.
/// </summary>
Auto = 6
}Examples:
Default Newtonsoft.Json serialization behaviour with this fork:
output = JsonConvert.SerializeObject(clase, Formatting.Indented, new JsonSerializerSettings
{
//ignore GuidHandling for default behaviour. No breaking changes!
TypeNameHandling = TypeNameHandling.All
});
output = JsonConvert.SerializeObject(clase, Formatting.Indented, new JsonSerializerSettings
{
GuidHandling = GuidHandling.Default, //same as above
TypeNameHandling = TypeNameHandling.All
});
output = JsonConvert.SerializeObject(clase, Formatting.Indented, new JsonSerializerSettings
{
GuidHandling = GuidHandling.Auto, //no breaking changes in format but deserialize to GUID instead plain string
TypeNameHandling = TypeNameHandling.All
});
With custom Guid Serialization format provided in this fork:
output = JsonConvert.SerializeObject(clase, Formatting.Indented, new JsonSerializerSettings
{
GuidHandling = GuidHandling.Hexadecimal, // {0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}} format in JSON output
TypeNameHandling = TypeNameHandling.All
});With custom Guid deserialization format provided in this fork:
Clase deserializedr = JsonConvert.DeserializeObject<Clase>(output, new JsonSerializerSettings
{
GuidHandling = GuidHandling.Auto, //acepts any valid Guid format
TypeNameHandling = TypeNameHandling.All
});
Console.WriteLine(deserializedr.Propiedad[0].GetType()); //Guid!
Clase deserializedr = JsonConvert.DeserializeObject<Clase>(output, new JsonSerializerSettings
{
GuidHandling = GuidHandling.Hexadecimal, //faster than Auto but throws exception if JSON does not meet hexadecial format
TypeNameHandling = TypeNameHandling.All
});
Console.WriteLine(deserializedr.Propiedad[0].GetType()); //Guid!