Язык программирования C#9 и платформа .NET5 - Эндрю Троелсен

(применение JsonSerializationOptions) будут включаться все открытые поля в графе объектов. Чтобы исключить отдельные открытые поля с использованием такого приема, вам придется использовать для этих полей атрибут JsonExclude.

Модифицируйте метод SaveAsJsonFormat(), как показано ниже:

static void SaveAsJsonFormat<T>(T objGraph, string fileName)

{

  var options = new JsonSerializerOptions

  {

    IncludeFields = true,

  };

  File.WriteAllText(fileName,

      System.Text.Json.JsonSerializer.Serialize(objGraph, options));

}

Вместо применения класса JsonSerializerOptions того же результата можно достичь, обновив все открытые поля в примерах классов следующим образом (имейте в виду, что вы можете оставить в классах атрибуты Xml и они не будут помехой JsonSerializer):

// Radio.cs

public class Radio

{

  [JsonInclude]

  public bool HasTweeters;

  [JsonInclude]

  public bool HasSubWoofers;

  [JsonInclude]

  public List<double> StationPresets;

  [JsonInclude]

  public string RadioId = "XF-552RR6";

  ...

}

// Car.cs

public class Car

{

  [JsonInclude]

  public Radio TheRadio = new Radio();

  [JsonInclude]

  public bool IsHatchBack;

  ...

}

// JamesBondCar.cs

public class JamesBondCar : Car

{

  [XmlAttribute]

  [JsonInclude]

  public bool CanFly;

  [XmlAttribute]

  [JsonInclude]

  public bool CanSubmerge;

  ...

}

// Person.cs

public class Person

{

  // Открытое поле.

  [JsonInclude]

  public bool IsAlive = true;

  ...

}

Теперь в результате запуска кода любым способом все открытые свойства и поля записываются в файл. Однако, заглянув содержимое файла, вы увидите, что данные JSON были записаны в минифицированном виде, т.е. в формате, в котором все незначащие пробельные символы и разрывы строк удаляются. Формат является стандартным во многом из-за широкого использования JSON для служб REST и уменьшения размера пакета данных при передаче информации между службами по HTTP/HTTPS.

На заметку! Поля для сериализации JSON обрабатываются точно так же, как для десериализации JSON. Если вы выбирали вариант включения полей при сериализации JSON, то также должны делать это при десериализации JSON.

Понятный для человека вывод данных JSON

В дополнение к варианту с включением открытых полей экземпляр класса JsonSerializer можно проинструктировать о необходимости записи данных JSON с отступами (для удобства чтения человеком). Модифицируйте свой метод, как показано ниже:

static void SaveAsJsonFormat<T>(T objGraph, string fileName)

{

  var options = new JsonSerializerOptions

  {

    IncludeFields = true,

    WriteIndented = true

  };

  File.WriteAllText(fileName,

     System.Text.Json.JsonSerializer.Serialize(objGraph, options));

}

Заглянув в файл CarData.json, вы заметите, что вывод стал гораздо более читабельным:

{

  "CanFly": true,

  "CanSubmerge": false,

  "TheRadio": {

    "HasTweeters": true,

    "HasSubWoofers": false,

    "StationPresets": [

      89.3,

      105.1,

      97.1

    ],

    "RadioId": "XF-552RR6"

  },

  "IsHatchBack": false

}

Именование элементов JSON в стиле Pascal или в "верблюжьем" стиле

Стиль Pascal представляет собой формат, в котором первый символ и каждая важная часть имени начинается с символа в верхнем регистре. В предыдущем листинге данных JSON примером стиля Pascal служит CanSubmerge. В "верблюжьем" стиле, с другой стороны, для первого символа применяется нижний регистр, а все важные части имени начинаются с символа в верхнем регистре. Версия предыдущего примера в "верблюжьем" стиле выглядит как canSubmerge.

Почему это важно? Дело в том, что большинство популярных языков (в том числе С#) чувствительно к регистру. Таким образом, CanSubmerge и canSubmerge — два разных элемента. Повсюду в книге вы видели, что общепринятым стандартом для именования открытых конструкций в C# (классов, открытых свойств, функций и т.д.) является использование стиля Pascal. Тем не менее, в большинстве фреймворков JavaScript задействован "верблюжий" стиль. В итоге могут возникать проблемы при использовании .NET и C# для взаимодействия с другими системами, например, в случае передачи данных JSON туда и обратно между службами REST.

К счастью, JsonSerializer допускает настройку для поддержки большинства ситуаций, в том числе отличий в стилях именования. Если политика именования не указана, то JsonSerializer при сериализации и десериализации JSON будет применять стиль Pascal. Чтобы заставить процесс сериализации использовать "верблюжий" стиль, модифицируйте параметры, как показано ниже:

static void SaveAsJsonFormat<T>(T objGraph, string fileName)

{

  JsonSerializerOptions options = new()

  {

    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,

    IncludeFields = true,

    WriteIndented = true,

  };

  File.WriteAllText(fileName,

      System.Text.Json.JsonSerializer.Serialize(objGraph, options));

}

Теперь выпускаемые данные JSON будут представлены в "верблюжьем" стиле:

{

  "canFly": true,

  "canSubmerge": false,

  "theRadio": {

    "hasTweeters": true,

    "hasSubWoofers": false,

    "stationPresets": [

      89.3,

      105.1,

      97.1

    ],

    "radioId": "XF-552RR6"

  },

  "isHatchBack": false

}

При чтении данных JSON в коде C# по умолчанию поддерживается чувствительность к регистру символов. Политика именования соответствует настройке PropertyNamingPolicy, применяемой во время десериализации. Если ничего не установлено, тогда используется стандартный стиль Pascal. Установка PropertyNamingPolicy в CamelCase свидетельствует об ожидании того, что все входящие данные JSON должны быть представлены в "верблюжьем" стиле. Если политики именования не совпадают, то процесс десериализации (рассматриваемый далее) потерпит неудачу.

При десериализации JSON существует третий вариант — нейтральность к политике именования. Установка параметра PropertyNameCaseInsensitive в true приводит к тому, что canSubmerge и CanSubmerge будут десериализироваться. Вот код установки этого параметра:

JsonSerializerOptions options = new()

{

  PropertyNameCaseInsensitive = true,

  IncludeFields = true

};

Обработка чисел с помощью JsonSerializer

Стандартным режимом обработки чисел является Strict, который предусматривает, что числа будут сериализироваться как числа (без кавычек) и сериализироваться как числа (без кавычек). В классе JsonSerializerOptions имеется свойство NumberHandling, которое управляет чтением