Json Serializer with multiple JsonProperty Newtonsoft.Json

Question

I have an entity class with JsonProperty attribute as follows:

public class Book
{
    [JsonProperty("id")]
    public long BookId { get; set; }
    [JsonProperty("name")]
    public string BookName { get; set; }
}

I want to deserialize this from JSON string to the entity. Due to JsonProperty id & name, the json should have the id/name schema and in that case the deserialize works perfectly (as expected). But in some cases, the json string can also have BookId and BookName. Can I have multiple JsonProperty attributes to handle this? Or is there a way to let the serializer know, that if not id then deserialize using BookId? Or any other way to handle this use case?

This link might help you https://stackoverflow.com/questions/43714050/multiple-jsonproperty-name-assigned-to-single-property — Arib Yousuf, Mar 02 '21 at 07:38

score 0 · Answer 1 · edited Dec 30 '22 at 22:19

0

You can replace the property name before deserializing the json.

var book = @"
    [
      {
        'id': 123456789,
        'name': 'book1'
      },
      {
        'BookId': 1234567,
        'BookName': 'book2'
      }
    ]
    ";

    var after = book.Replace("BookId", "id").Replace("BookName", "name");
    var sbook = JsonConvert.DeserializeObject<List<Book>>(after);

Then you can get the entire deserialization object.

edited Dec 30 '22 at 22:19

derloopkat

6,232
16
38
45

answered Mar 02 '21 at 08:36

Karney.

4,803
2
7
11

@Anish Unnikrishnan, can this help you? – Karney. Mar 03 '21 at 02:07
String.replace is a clever technique. Could be use full in a different scenario. But it didn't fit my use case. Thanks anyway Karney. – Anish Unnikrishnan Mar 04 '21 at 14:52
@AnishUnnikrishnan, but what is your scenario? – Karney. Mar 05 '21 at 01:17
I am getting data from a DB call. And might have characters similar to key in the actual data itself. String.Replace will also replace the actual leading to bugs in the future. – Anish Unnikrishnan Mar 10 '21 at 07:48
1

There is no configuration to map the multiple properties, so you have to handle it manully. – Karney. Mar 10 '21 at 08:00

score 0 · Answer 2 · answered Mar 02 '21 at 09:10

You could solve this by defining alternative properties, which redirects to existing ones. For example,

public class Book
{
    [JsonProperty("bookId")]
    public long BookId { get; set; }
    
    [JsonProperty("id")]
    private long Id
    {
        get => BookId;
        set => BookId = value;
    }
    [JsonProperty("bookName")]
    public string BookName { get; set; }
    
    [JsonProperty("name")]
    private string Name
    {
        get => BookName;
        set => BookName = value;
    }
}

Demo

Note that if both properties are present in the Json, only the last one will be preserved. — Drag and Drop, Mar 03 '21 at 09:50

Json Serializer with multiple JsonProperty Newtonsoft.Json

2 Answers2