CKTIS / JavaScript
Препратки в JSON графи и екраниране на пътища
Запазете споделените обекти и циклите в JSON текст чрез маркери `$ref` и пътища, които разграничават знаците в ключовете от разделителите.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
Application-defined JSON graph marker: {"$ref":"<path>"}
Root path: "". Child path: parentPath + "/" + escapeToken(keyOrIndex).
escapeToken(token): replace ~ with ~0, then / with ~1.
To read a path as segments, treat "" as zero segments. For any other path, require a leading /, remove exactly that first /, then split the remainder at /, keeping empty segments. The path / has one empty segment. In each segment, replace ~1 with /, then ~0 with ~.Обикновеният JSON описва дърво от стойности, но не и идентичността на обектите. По подразбиране JSON.stringify() записва споделен обект без цикъл отделно при всяка поява. JSON.parse() създава различни обекти от тези копия. Ако сериализацията срещне цикъл, JSON.stringify() хвърля TypeError.
Според тази конвенция на приложението WeakMap запомня първия път до обекта, преди да бъдат обходени вложените му стойности. При повторна поява на същия обект се записва {"$ref":"<path>"}. Този обект с единствено поле от тип низ е запазен за препратки; JSON.parse() не ги разрешава самостоятелно.
В път в стил JSON Pointer "" означава корена, а / — неговото свойство с празен ключ. Всеки сегмент е ключ на обект или индекс на масив, броен от нула. Преди да съедините сегментите с /, заменете ~ с ~0, а после / с ~1. Ключът a/~1 дава /a~1~01. При четене приемете, че "" е път без сегменти. Всеки непразен път трябва да започва с /: премахнете само този първи знак /, разделете остатъка по / и запазете празните сегменти. Така пътят / има един празен сегмент. Във всеки сегмент заменете първо ~1 с /, а после ~0 с ~. Това е различно от екранирането на JSON низове и процентното кодиране на URI.
След разбора първо индексирайте действителните обекти и масиви, после заменете маркерите с техните цели. Така работят и препратките към цели, които се появяват по-нататък. При ненадеждни данни проверявайте формата, ограничавайте размера и дълбочината и отхвърляйте невалидните пътища и липсващите цели. Не използвайте eval() и не обхождайте вериги от прототипи.
Ако ви трябва копие вместо текст, structuredClone() запазва циклите и споделените препратки за поддържаните стойности. Това е API на уеб платформата, а не метод на JSON; наличността зависи от средата за изпълнение.
Примери
{
const childPath = (path, key) =>
path + '/' + String(key).replace(/~/g, '~0').replace(/\//g, '~1');
const shared = { count: 1 };
const graph = { 'a/~1': shared, alias: shared };
graph.self = graph;
const seen = new WeakMap();
function encode(value, path = '') {
if (value === null || typeof value !== 'object') return value;
if (seen.has(value)) return { $ref: seen.get(value) };
seen.set(value, path);
if (Array.isArray(value)) {
return value.map((item, index) => encode(item, childPath(path, index)));
}
return Object.fromEntries(Object.entries(value).map(([key, item]) =>
[key, encode(item, childPath(path, key))]));
}
const text = JSON.stringify(encode(graph));
const restored = JSON.parse(text);
const nodes = new Map();
const links = [];
function index(node, path = '') {
nodes.set(path, node);
for (const [key, item] of Object.entries(node)) {
if (item === null || typeof item !== 'object') continue;
const keys = Object.keys(item);
if (!Array.isArray(item) && keys.length === 1 && keys[0] === '$ref' &&
typeof item.$ref === 'string') {
links.push([node, key, item.$ref]);
} else {
index(item, childPath(path, key));
}
}
}
index(restored);
for (const [owner, key, path] of links) {
if (!nodes.has(path)) throw new Error('Invalid reference path');
owner[key] = nodes.get(path);
}
console.log(text);
console.log(restored.alias === restored['a/~1']);
console.log(restored.self === restored);
}Резултат
{"a/~1":{"count":1},"alias":{"$ref":"/a~1~01"},"self":{"$ref":""}}
true
trueПримерът използва надеждни данни: обикновени обекти, масиви без пропуски и примитивни стойности, представими в JSON. Декодерът сравнява целите екранирани пътища в `Map`, затова не се налага да декодира сегментите. Двата резултата `true` потвърждават, че споделената препратка и цикълът са възстановени.
Свързани уроци
- JavaScript · Урок 17 · Напреднало · Версия: 4
Източници
- ECMAScript 2024 Language Specification — JSON.stringify
- ECMAScript 2024 Language Specification — JSON.parse
- ECMAScript 2024 Language Specification — WeakMap Objects
- ECMAScript 2024 Language Specification — Object.fromEntries
- HTML Standard — StructuredDeserialize
- HTML Standard — Structured cloning API
- RFC 6901 — JavaScript Object Notation (JSON) Pointer