Nie można deserializować obiektu za pomocą właściwości tablicy bajtów za pomocą Json.NET 8.0.1

Question

Po uaktualnieniu podstawy kodu w celu użycia Json.NET 8.0.1, niektóre deserializacje potykają się. Korzystanie z Json.NET 7.0.1 wszystko działa dobrze. Najwyraźniej jest to deserializacja właściwości typu byte[], która powoduje problem. Jeśli usuniemy właściwość byte[], to działa poprawnie. mogę odtworzyć zachowanie przy użyciu tej prostej aplikacji konsoli:

internal class Program 
{ 
    private static void Main(string[] args) 
    { 
     Dictionary<string, Account> accounts; 
     var jsonSerializerSettings = new JsonSerializerSettings 
     { 
      TypeNameHandling = TypeNameHandling.Objects, 
      TypeNameAssemblyFormat = FormatterAssemblyStyle.Simple 
     }; 

     using (var streamReader = new StreamReader("accounts.json")) 
     { 
      var json = streamReader.ReadToEnd(); 
      accounts = JsonConvert.DeserializeObject<Dictionary<string, Account>>(json, jsonSerializerSettings); 
     } 

     foreach (var account in accounts) 
     { 
      Debug.WriteLine(account.Value.Name); 
     } 
    } 
} 

internal class Account 
{ 
    public string Id { get; set; } 

    public string Name { get; set; } 

    public byte[] EncryptedPassword { get; set; } 
} 

Plik accounts.json wygląda tak:

{ 
    "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[ConsoleApplication1.Account, ConsoleApplication1]], mscorlib", 
    "lars.michael": { 
     "$type": "ConsoleApplication1.Account, ConsoleApplication1", 
     "EncryptedPassword": { 
      "$type": "System.Byte[], mscorlib", 
      "$value": "cGFzc3dvcmQ=" 
     }, 
     "Name": "Lars Michael", 
     "Id": "lars.michael" 
    }, 
    "john.doe": { 
     "$type": "ConsoleApplication1.Account, ConsoleApplication1", 
     "EncryptedPassword": { 
      "$type": "System.Byte[], mscorlib", 
      "$value": "cGFzc3dvcmQ=" 
     }, 
     "Name": "John Doe", 
     "Id": "john.doe" 
    } 
} 

Jest to prawdopodobnie błąd w Json.NET 8.0.1 czy mogę może rozwiązać ten problem przez ulepszenie JsonSerializerSettings?

Jeśli ktokolwiek próbuje odtworzyć to, należy zsynchronizować nazwę zespołu w pliku accounts.json z nazwą zespołu aplikacji konsoli (w tym przypadku ConsoleApplication1).

Answer 1

Aktualizacja

Fixed w zmianie ustaw 70120ce, które zostaną zawarte w Json.NET 8.0.2.

Original Odpowiedź

potwierdzone - to wydaje się być regresji. Rozważmy następującą prostą klasę testową:

internal class HasByteArray 
{ 
    public byte[] EncryptedPassword { get; set; } 
} 

Teraz gdy próbuję obie klasy z TypeNameHandling.Objects:

private static void TestSimple() 
    { 
     var test = new HasByteArray { EncryptedPassword = Convert.FromBase64String("cGFzc3dvcmQ=") }; 
     try 
     { 
      TestRoundTrip(test); 
     } 
     catch (Exception ex) 
     { 
      Debug.WriteLine(ex); 
     } 
    } 

    private static void TestRoundTrip<T>(T item) 
    { 
     var jsonSerializerSettings = new JsonSerializerSettings 
     { 
      TypeNameHandling = TypeNameHandling.Objects, 
      TypeNameAssemblyFormat = FormatterAssemblyStyle.Simple 
     }; 

     TestRoundTrip<T>(item, jsonSerializerSettings); 
    } 

    private static void TestRoundTrip<T>(T item, JsonSerializerSettings jsonSerializerSettings) 
    { 
     var json = JsonConvert.SerializeObject(item, Formatting.Indented, jsonSerializerSettings); 
     Debug.WriteLine(json); 

     var item2 = JsonConvert.DeserializeObject<T>(json, jsonSerializerSettings); 

     var json2 = JsonConvert.SerializeObject(item2, Formatting.Indented, jsonSerializerSettings); 

     Debug.WriteLine(json2); 

     if (!JToken.DeepEquals(JToken.Parse(json), JToken.Parse(json2))) 
      throw new InvalidOperationException("Round Trip Failed"); 
    } 

pojawia się następujący wyjątek:

Newtonsoft.Json.JsonSerializationException: Additional text found in JSON string after finishing deserializing object. 
    at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent) in C:\Development\Releases\Json\Working\Newtonsoft.Json\Working-Signed\Src\Newtonsoft.Json\Serialization\JsonSerializerInternalReader.cs:line 196 
    at Newtonsoft.Json.JsonSerializer.DeserializeInternal(JsonReader reader, Type objectType) in C:\Development\Releases\Json\Working\Newtonsoft.Json\Working-Signed\Src\Newtonsoft.Json\JsonSerializer.cs:line 823 
    at Newtonsoft.Json.JsonSerializer.Deserialize(JsonReader reader, Type objectType) in C:\Development\Releases\Json\Working\Newtonsoft.Json\Working-Signed\Src\Newtonsoft.Json\JsonSerializer.cs:line 802 
    at Newtonsoft.Json.JsonConvert.DeserializeObject(String value, Type type, JsonSerializerSettings settings) in C:\Development\Releases\Json\Working\Newtonsoft.Json\Working-Signed\Src\Newtonsoft.Json\JsonConvert.cs:line 863 
    at Newtonsoft.Json.JsonConvert.DeserializeObject[T](String value, JsonSerializerSettings settings) in C:\Development\Releases\Json\Working\Newtonsoft.Json\Working-Signed\Src\Newtonsoft.Json\JsonConvert.cs:line 820 
    at Question34654184.TestClass.TestRoundTrip[T](T item, JsonSerializerSettings jsonSerializerSettings) 
    at Question34654184.TestClass.TestRoundTrip[T](T item) 
    at Question34654184.TestClass.TestSimple() 

Wyjątek robi nie występuje w Json 7.0. Powinieneś report an issue.

W międzyczasie, można użyć następującego konwerter aby obejść problem:

public class ByteArrayConverter : JsonConverter 
{ 
    public override bool CanConvert(Type objectType) 
    { 
     return objectType == typeof(byte[]); 
    } 

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) 
    { 
     if (reader.TokenType == JsonToken.Null) 
      return null; 
     var token = JToken.Load(reader); 
     if (token == null) 
      return null; 
     switch (token.Type) 
     { 
      case JTokenType.Null: 
       return null; 
      case JTokenType.String: 
       return Convert.FromBase64String((string)token); 
      case JTokenType.Object: 
       { 
        var value = (string)token["$value"]; 
        return value == null ? null : Convert.FromBase64String(value); 
       } 
      default: 
       throw new JsonSerializationException("Unknown byte array format"); 
     } 
    } 

    public override bool CanWrite { get { return false; } } // Use the default implementation for serialization, which is not broken. 

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) 
    { 
     throw new NotImplementedException(); 
    } 
} 

z ustawieniami

  var jsonSerializerSettings = new JsonSerializerSettings 
      { 
       TypeNameHandling = TypeNameHandling.Objects, 
       TypeNameAssemblyFormat = FormatterAssemblyStyle.Simple, 
       Converters = new [] { new ByteArrayConverter() }, 
      };