ENRU

Порядок ключей в JSON: почему числовые ключи встают первыми

Обновлено

Если разобрать {"b":1,"10":2,"2":3} в JavaScript и напечатать обратно, получится {"2":3,"10":2,"b":1}. Ничего не сломалось: JavaScript перечисляет ключи, похожие на целые числа, первыми и по возрастанию, а остальные — в порядке добавления. Ниже — точное правило, почему сортировка, наоборот, ставит "10" перед "2", что говорит о порядке RFC 8259 и когда порядок действительно важен.

Почему JavaScript переставляет числовые ключи

Порядок задаёт язык, а не JSON. Когда JavaScript перечисляет собственные ключи объекта (OrdinaryOwnPropertyKeys в спецификации ECMAScript), он отдаёт три группы: сначала ключи, похожие на индексы массива, то есть канонические целые от 0 до 2^32 − 2, по возрастанию; затем остальные строковые ключи в порядке создания; затем символы. JSON.parse создаёт свойства в порядке документа, но Object.keys, циклы for, JSON.stringify и консоль пользуются именно этим перечнем.

const data = JSON.parse('{"b":1,"10":2,"2":3,"a":4,"01":5,"-1":6}');

Object.keys(data);    // ['2', '10', 'b', 'a', '01', '-1']
JSON.stringify(data); // '{"2":3,"10":2,"b":1,"a":4,"01":5,"-1":6}'

"01" и "-1" остаются на месте: это не канонические индексы, как и "1.5" или "4294967295". Поэтому объект с ключами-ID, годами или кодами ответа HTTP возвращается отсортированным по числам, а остальное в нём сохраняет порядок. Reviver не поможет: он видит ключи уже переставленными.

Почему сортировка ставит «10» перед «2»

Инструменты, которые сортируют ключи, сравнивают их как текст, посимвольно, а 1 идёт раньше 2. Поэтому jq -S, sort_keys=True в Python, encoding/json в Go для map, SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS в Jackson и «Сортировать ключи» на этом сайте печатают "10" перед "2", а "B" перед "b". Один и тот же документ выходит как 2, 10 из JavaScript и как 10, 2 из сортировщика. Ошибки нет ни там, ни там.

У Python своя тонкость: если у словаря целые ключи, sort_keys=True сортирует их как числа и только потом превращает в строки, так что {10: "a", 2: "b"} становится {"2": "b", "10": "a"}. Смесь ключей int и str даёт TypeError: '<' not supported between instances of 'str' and 'int'.

Что RFC 8259 говорит о порядке

Раздел 1 краток: объект — это «неупорядоченная коллекция из нуля или более пар имя/значение». Раздел 4 добавляет, что библиотеки разбора по-разному решают, показывать ли вызывающему коду порядок членов объекта, и что код, который от этого порядка не зависит, совместим с любой из них.

Выходит, у текста документа порядок есть, а модель данных сохранить его не обещает. Код, который полагается на порядок ключей, полагается на свой парсер, а не на JSON. С массивами иначе: их порядок — часть значения. Рядом лежит ловушка с повторными ключами: JavaScript и Python оставляют место первого ключа и значение последнего, так что {"a":1,"b":2,"a":3} читается как {"a":3,"b":2}.

Python, Go, Java и jq

ПарсерПорядок после разбораСортировка
JavaScript JSON.parseЦелочисленные ключи первыми, по возрастанию; остальные как записаныОпции нет, сортировать вручную
Python jsonКак записаны: dict хранит порядок вставкиsort_keys=True, как текст
Go encoding/jsonСтруктуры: порядок объявления полей. Map: порядка нетMap всегда пишутся отсортированными, как текст
Java, JacksonКак записаны (LinkedHashMap, ObjectNode)ORDER_MAP_ENTRIES_BY_KEYS, как текст
jq 1.7Как записаны-S, как текст
JSON StathamКак записаны, числовые ключи тоже«Сортировать ключи», по кодам символов
import json

data = json.loads('{"b": 1, "10": 2, "2": 3}')
list(data)                        # ['b', '10', '2']
json.dumps(data, sort_keys=True)  # '{"10": 2, "2": 3, "b": 1}'
var m map[string]int
if err := json.Unmarshal([]byte(`{"b":1,"10":2,"2":3}`), &m); err != nil {
	log.Fatal(err)
}
out, _ := json.Marshal(m)
fmt.Println(string(out)) // {"10":2,"2":3,"b":1}

Сортировку ключей map описывает документация json.Marshal. Чтобы сохранить в Go порядок ввода, объект можно читать по токенам через Decoder.Token или держать как json.RawMessage и передавать байты дальше нетронутыми.

Когда порядок ключей важен

  • Подписи и хеши тела. После разбора и повторной сериализации байты меняются, даже если данные те же. Подписывать нужно ровно те байты, что отправлены, или договориться о канонической форме вроде RFC 8785: она сортирует ключи по кодовым единицам UTF-16.
  • Сравнение и код-ревью. Переставленный файл показывает изменения, которых никто не вносил. Сравнение JSON сопоставляет объекты по ключам и порядок не учитывает.
  • Файлы, которые читают люди: конфиги, фикстуры, примеры API. Нужен логичный порядок, id и name первыми, или единая сортировка опцией «Сортировать ключи» в форматировании.
  • Потоковые читатели, которые ждут поле с типом раньше остального объекта. Его стоит писать первым и не давать переформатированию его сдвинуть.
  • Порядок со смыслом: шаги, рейтинг. Ему место в массиве: [{"id":"10"},{"id":"2"}] сохраняет порядок в любом парсере.

Порядок ключей на этом сайте

Форматирование, минификация, JSON в YAML и дерево сохраняют ключи в порядке текста, числовые тоже, потому что ни одно из них не пользуется JSON.parse. Сортировка включается отдельно и упорядочивает ключи по кодам символов на всех уровнях. Сравнение порядок ключей не учитывает. Убедиться легко: в меню «Пример» форматирования выбрать «Тест точности» — "10" останется перед "2".

Порядок ключей в JSON: частые вопросы

Сохраняет ли JSON порядок ключей?

У текста порядок есть, но RFC 8259 называет объект неупорядоченным, так что парсер вправе сохранить порядок, отсортировать ключи или переставить их. Python, Jackson и jq порядок сохраняют, JavaScript переносит целочисленные ключи вперёд, map в Go его теряют.

Как запретить JavaScript переставлять числовые ключи?

Обычным объектом — никак: порядок задан языком. Можно передавать массив пар, добавить к ключам префикс ("id10") или держать данные текстом и читать парсером, который сохраняет порядок.

Меняет ли сортировка ключей данные?

Нет. Те же имена указывают на те же значения, и любой читатель JSON увидит те же данные. Меняются байты, а это важно для подписей, хешей и построчного сравнения.

Почему Go сортирует мои ключи?

encoding/json пишет map с отсортированными ключами, чтобы вывод был стабильным: у map в Go нет порядка, который можно было бы сохранить. Если нужен фиксированный порядок, подойдёт структура: её поля пишутся в порядке объявления.