Как проверить наличие ключа в TJSONObject в Delphi 10.1 Update 2: обходной путь вместо отсутствующего containskey метода?

Delphi , Технологии , Объектно-ориентированное программирование

Разработка на Delphi часто предполагает работу с данными в различных форматах, и JSON является одним из самых распространенных. При работе с JSON-объектами в Delphi, особенно в старых версиях, таких как Delphi 10.1 Update 2, может возникнуть ситуация, когда вам потребуется проверить, существует ли определенный ключ в TJSONObject. Однако, в отличие от некоторых других языков программирования, TJSONObject в Delphi не имеет встроенного метода ContainsKey. В этой статье мы рассмотрим, как обойти это ограничение и эффективно проверить наличие ключа в JSON-объекте.

Проблема:

Пользователь JIMSMITH столкнулся с проблемой при работе с TJSONObject в Delphi 10.1 Update 2: отсутствие метода ContainsKey. Это затрудняет проверку существования ключа перед попыткой получить его значение, что может привести к ошибкам времени выполнения. Оригинальный вопрос заключался в поиске обходного пути для замены JSONObject.ContainsKey('keyvalue').

Решение 1: Использование GetValue()

Самым простым и распространенным решением является использование метода GetValue(). Этот метод возвращает значение, соответствующее указанному ключу, или nil, если ключ не найден. Таким образом, можно проверить наличие ключа, сравнив результат GetValue() с nil.

uses
  System.JSON;

procedure ProcessJSONObject(const JSONObject: TJSONObject);
var
  Value: TJSONValue;
begin
  if (JSONObject.GetValue('keyvalue') <> nil) then
  begin
    Value := JSONObject.GetValue('keyvalue');
    // Обработка значения, если ключ существует
    if Value is TJSONString then
      ShowMessage('Значение ключа keyvalue: ' + TJSONString(Value).Value)
    else if Value is TJSONNumber then
      ShowMessage('Значение ключа keyvalue: ' + TJSONNumber(Value).ToString)
    // ... другие типы значений
  end
  else
  begin
    // Обработка ситуации, когда ключ отсутствует
    ShowMessage('Ключ keyvalue не найден.');
  end;
end;

В этом примере мы проверяем, не является ли результат JSONObject.GetValue('keyvalue') равным nil. Если это так, значит, ключ 'keyvalue' существует в JSON-объекте, и мы можем безопасно получить его значение. В противном случае, мы обрабатываем ситуацию отсутствия ключа.

Решение 2: Использование TryGetValue<T>()

Как отметил pyscripter, существует еще один метод - TryGetValue<T>(), унаследованный от TJSONValue. Этот метод позволяет получить значение, соответствующее ключу, и сохранить его в указанной переменной, если ключ существует. Если ключ не найден, переменная остается неинициализированной.

uses
  System.JSON;

procedure ProcessJSONObjectTryGetValue(const JSONObject: TJSONObject);
var
  Value: TJSONValue;
begin
  if JSONObject.TryGetValue<TJSONValue>('keyvalue', Value) then
  begin
    // Обработка значения, если ключ существует
    if Value is TJSONString then
      ShowMessage('Значение ключа keyvalue: ' + TJSONString(Value).Value)
    else if Value is TJSONNumber then
      ShowMessage('Значение ключа keyvalue: ' + TJSONNumber(Value).ToString)
    // ... другие типы значений
  end
  else
  begin
    // Обработка ситуации, когда ключ отсутствует
    ShowMessage('Ключ keyvalue не найден.');
  end;
end;

Сравнение решений и альтернативные подходы

Хотя TryGetValue<T>() кажется более элегантным, Remy Lebeau справедливо указывает на то, что он имеет несколько недостатков:

• Более высокая накладные расходы: TryGetValue<T>() выполняет дополнительную обработку, включая обработку пути и проверку типа, что может снизить производительность, особенно при частом использовании.
• Необходимость объявления переменной: Метод требует объявления переменной для получения значения, даже если это значение не используется.

Поэтому, в большинстве случаев, использование GetValue() является более предпочтительным вариантом, особенно в Delphi 10.1 Update 2.

Решение 3: Создание Helper-класса (предложенный Remy Lebeau)

Remy Lebeau предложил создать helper-класс для TJSONObject, который будет содержать метод ContainsKey. Это позволяет инкапсулировать логику проверки наличия ключа и сделать код более читаемым и поддерживаемым.

uses
  System.JSON;

type
  TJSONObjectHelper = class helper for TJSONObject
    function ContainsKey(const AKeyName: String): Boolean;
  end;

function TJSONObjectHelper.ContainsKey(const AKeyName: String): Boolean;
begin
  Result := Self.GetValue(AKeyName) <> nil;
end;

procedure ProcessJSONObjectHelper(const JSONObject: TJSONObject);
begin
  if TJSONObjectHelper.ContainsKey('keyvalue') then
  begin
    // Обработка значения, если ключ существует
    // ...
  end
  else
  begin
    // Обработка ситуации, когда ключ отсутствует
    // ...
  end;
end;

Этот подход предлагает чистый и понятный способ проверки наличия ключа, используя существующий метод GetValue(). Он особенно полезен, если проверка наличия ключа выполняется часто в коде.

Заключение

В Delphi 10.1 Update 2 отсутствует встроенный метод ContainsKey для TJSONObject. Однако, существуют эффективные обходные пути для проверки наличия ключа: использование GetValue(), TryGetValue<T>() или создание helper-класса. Выбор наиболее подходящего решения зависит от конкретных требований проекта и приоритетов (производительность, читаемость кода и т.д.). В большинстве случаев, использование GetValue() является наиболее простым и эффективным вариантом. Helper-класс предоставляет более структурированный подход и улучшает читаемость кода, особенно при частом использовании.

Создано по материалам из источника по ссылке.

В статье предложены способы проверки наличия ключа в TJSONObject для Delphi 10.1 Update 2 при отсутствии встроенного метода ContainsKey, включая использование GetValue, TryGetValue и создание вспомогательного класса.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Объектно-ориентированное программирование ::