Как обрабатывать JSON с нестандартными названиями полей?

При работе с внешними API или устаревшими системами часто приходится сталкиваться с JSON, где ключи содержат пробелы, дефисы, точки или начинаются с цифр — такие имена не могут быть напрямую использованы как идентификаторы переменных в большинстве языков программирования. Обработка таких данных требует маппинга (сопоставления) между ключами в JSON и полями в объектах вашего кода.

Подходы к решению

Основные стратегии включают:

• Ручной маппинг после парсинга: Распарсить JSON в словарь/объект, а затем вручную скопировать значения в нужные поля с правильными именами.
• Использование аннотаций в библиотеках сериализации: Многие современные библиотеки позволяют указать, как ключ JSON соотносится с полем класса.
• Написание кастомных парсеров/сериализаторов: Для сложных случаев можно создать свою логику преобразования.

Примеры кода

Вот пример на Python с использованием библиотеки Pydantic, которая отлично справляется с такими задачами:

from pydantic import BaseModel, Field
from typing import Optional

# JSON может иметь ключи вроде "user-name" или "2FA_enabled"
json_data = '''
{
    "user-name": "john_doe",
    "2FA_enabled": true,
    "registration date": "2023-01-15"
}
'''

class User(BaseModel):
    # Используем Field с alias для маппинга
    username: str = Field(alias="user-name")
    two_fa_enabled: bool = Field(alias="2FA_enabled")
    registration_date: Optional[str] = Field(alias="registration date")

# Десериализация с указанием, что нужно учитывать aliases
user = User.parse_raw(json_data)
print(user.username)  # john_doe
print(user.two_fa_enabled)  # True
# Теперь в коде мы используем нормальные имена полей.

В JavaScript/TypeScript можно использовать декораторы библиотеки class-transformer:

import { plainToClass, Type, Expose } from "class-transformer";

class User {
    @Expose({ name: "user-name" })
    username: string;

    @Expose({ name: "2FA_enabled" })
    twoFaEnabled: boolean;
}

const jsonData = `{
    "user-name": "john_doe",
    "2FA_enabled": true
}`;

const parsedJson = JSON.parse(jsonData);
const user = plainToClass(User, parsedJson);
console.log(user.username); // john_doe

Где это применяется

Такая обработка критически важна при интеграции с внешними сервисами (платежные системы, социальные сети, государственные API), где формат данных контролируется третьей стороной. Также это полезно при миграции устаревших систем, где соглашения об именовании могли быть другими.

Вывод: Использование механизмов маппинга полей необходимо для чистого разделения внешнего формата данных и внутренней доменной модели приложения, что повышает поддерживаемость кода и снижает связность с внешними API.