JsonExtensions下載JsonExtensions源代碼下載

jsonextensions

.NET System.Text.json的擴展集合

SingleArarrayJsonConverter

jsonConverter既可以將單個JSON對象又是JSON數組作為C＃數組。

使用默認的jsonconverter

 public sealed class Example
{
  [ JsonConverter ( typeof ( SingleOrArrayJsonConverter ) ) ]
  public string [ ] ? Array { get ; set ; }
}

 const string jsonSingle = """{"Array": "single"}""" ;
var deserializedSingle = JsonSerializer . Deserialize < Example > ( jsonSingle ) ;
Console . WriteLine ( $ " { deserializedSingle . Array . Length } : { deserializedSingle . Array [ 0 ] } " ) ;
// Output: "1: single"

const string jsonArray = """{"Array": ["first", "second"]}""" ;
var deserializedArray = JsonSerializer . Deserialize < Example > ( jsonArray ) ;
Console . WriteLine ( $ " { deserializedArray . Array . Length } : { deserializedArray . Array [ 0 ] } , { deserializedArray . Array [ 1 ] } " ) ;
// Output: "2: first, second"

使用自定義jsonConverter

 public sealed class Person
{
  public string FirstName { get ; }
  public string LastName { get ; }

  public Person ( string firstName , string lastName )
  {
    FirstName = firstName ;
    LastName = lastName ;
  }
}

// Converts a Person object into a "${FirstName} ${LastName}" string
public sealed class PersonJsonConverter : JsonConverter < string >
{
  public override string ? Read ( ref Utf8JsonReader reader , Type typeToConvert , JsonSerializerOptions options )
  {
    var personConverter = ( JsonConverter < Person > ) options . GetConverter ( typeof ( Person ) ) ;

    Person ? person = personConverter . Read ( ref reader , typeof ( Person ) , options ) ;

    return person != null ? $ " { person . FirstName } { person . LastName } " : null ;
  }

  public override void Write ( Utf8JsonWriter writer , string value , JsonSerializerOptions options )
  {
    var personConverter = ( JsonConverter < Person > ) options . GetConverter ( typeof ( Person ) ) ;

    var split = value . Split ( ' ' ) ;
    var firstName = split [ 0 ] ;
    var lastName = split [ 1 ] ;
    var person = new Person ( firstName , lastName ) ;

    personConverter . Write ( writer , person , options ) ;
  }
}

public sealed class Example
{
  [ JsonConverter ( typeof ( SingleOrArrayJsonConverter < PersonJsonConverter > ) ) ]
  public string [ ] ? Array { get ; set ; }
}

 const string jsonSingle = """{"Array": {"FirstName": "John", "LastName": "Smith"}}""" ;
var deserializedSingle = JsonSerializer . Deserialize < Example > ( json ) ;
Console . WriteLine ( $ " { deserializedSingle . Array . Length } : { deserializedSingle . Array [ 0 ] } " ) ;
// Output: "1: John Smith"

const string jsonArray = """{"Array": [{"FirstName": "John", "LastName": "Smith"}, {"FirstName": "John", "LastName": "Doe"}]}""" ;
var deserializedArray = JsonSerializer . Deserialize < Example > ( json ) ;
Console . WriteLine ( $ " { deserializedArray . Array . Length } : { deserializedArray . Array [ 0 ] } , { deserializedArray . Array [ 1 ] } " ) ;
// Output: "2: John Smith, John Doe"

jsonmultinamememememememodifier

JSONPROPERTYNAMES屬性和JSONMULTINAMEMEMEMEMEMEMEMODIFIER，允許將多個JSON鍵映射到一個C＃屬性。

允許重複的鍵

 public sealed class User
{
  [ JsonPropertyNames ( "UserName" , "User" , "Name" ) ]
  public string UserName { get ; set ; }
}

 JsonSerializerOptions jsonOptions = new ( )
{
  TypeInfoResolver = new DefaultJsonTypeInfoResolver ( )
  {
    Modifiers = { Modifiers . JsonMultiNameModifier }
  }
}

const string json1 = """{"UserName": "JohnSmith1"}""" ;
const string json2 = """{"User": "JohnSmith2"}""" ;
const string json3 = """{"Name": "JohnSmith3"}""" ;
var deserialized = JsonSerializer . Deserialize < User > ( json1 , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith1"
deserialized = JsonSerializer . Deserialize < User > ( json2 , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith2"
deserialized = JsonSerializer . Deserialize < User > ( json3 , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith3"

string json = """{"UserName": "JohnSmith1", "User": "JohnSmith2", "Name": "JohnSmith3"}""" ;
deserialized = JsonSerializer . Deserialize < User > ( json , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith3"

json = JsonSerializer . Serialize ( deserialized , jsonOptions ) ;
Console . WriteLine ( json ) ;
// Output: '{"UserName":"JohnSmith3"}'

不稱重鍵

 public sealed class User
{
  [ JsonPropertyNames ( throwOnDuplicate : true , "UserName" , "User" , "Name" ) ]
  public string UserName { get ; set ; }
}

 JsonSerializerOptions jsonOptions = new ( )
{
  TypeInfoResolver = new DefaultJsonTypeInfoResolver ( )
  {
    Modifiers = { Modifiers . JsonMultiNameModifier }
  }
}

const string json1 = """{"UserName": "JohnSmith1"}""" ;
const string json2 = """{"User": "JohnSmith2"}""" ;
const string json3 = """{"Name": "JohnSmith3"}""" ;
var deserialized = JsonSerializer . Deserialize < User > ( json1 , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith1"
deserialized = JsonSerializer . Deserialize < User > ( json2 , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith2"
deserialized = JsonSerializer . Deserialize < User > ( json3 , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith3"

try {
  const string json = """{"UserName": "JohnSmith1", "User": "JohnSmith2", "Name": "JohnSmith3"}""" ;
  deserialized = JsonSerializer . Deserialize < User > ( json , jsonOptions ) ;
  Console . WriteLine ( deserialized . UserName ) ;
} catch ( JsonException ) {
  Console . WriteLine ( "Deserialize failed" ) ;
}
// Output: "Deserialize failed"

不同的序列化密鑰

 public sealed class User
{
  [ JsonPropertyNames ( serializationName : "NickName" , "UserName" , "User" , "Name" ) ]
  public string UserName { get ; set ; }
}

 JsonSerializerOptions jsonOptions = new ( )
{
  TypeInfoResolver = new DefaultJsonTypeInfoResolver ( )
  {
    Modifiers = { Modifiers . JsonMultiNameModifier }
  }
}

string json = """{"UserName": "JohnSmith"}""" ;
var deserialized = JsonSerializer . Deserialize < User > ( json , jsonOptions ) ;
Console . WriteLine ( deserialized . UserName ) ;
// Output: "JohnSmith"

json = JsonSerializer . Serialize ( deserialized , jsonOptions ) ;
Console . WriteLine ( json ) ;
// Output: '{"NickName":"JohnSmith"}'