CKTIS / JavaScript
Referencie v grafoch JSON a escapovanie ciest
Zachovajte zdieľané objekty a cykly v texte JSON pomocou značiek `$ref` a ciest, ktoré rozlišujú znaky v kľúčoch od oddeľovačov.
Verzia: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
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 ~.Bežný JSON zapisuje strom hodnôt, nie identitu objektov. Pri predvolenom správaní JSON.stringify() zapíše zdieľaný objekt bez cyklu samostatne pri každom výskyte. JSON.parse() z týchto kópií vytvorí odlišné objekty. Ak serializácia narazí na cyklus, JSON.stringify() vyvolá TypeError.
V tejto aplikačnej konvencii si WeakMap zapamätá prvú cestu k objektu pred spracovaním jeho potomkov. Pri ďalšom výskyte toho istého objektu sa zapíše {"$ref":"<path>"}. Tento objekt s jediným reťazcovým poľom je vyhradený pre referencie; JSON.parse() ich sám nerozpoznáva ako odkazy na iné objekty.
V ceste v štýle JSON Pointer označuje "" koreň a / jeho vlastnosť s prázdnym kľúčom. Každý segment je kľúč objektu alebo index poľa počítaný od nuly. Pred spojením segmentov znakom / nahraďte ~ za ~0 a potom / za ~1. Kľúču a/~1 zodpovedá /a~1~01. Pri čítaní považujte "" za cestu bez segmentov. Každá neprázdna cesta sa musí začínať znakom /: odstráňte iba tento prvý znak /, zvyšok rozdeľte podľa / a zachovajte aj prázdne segmenty. Cesta / má teda jeden prázdny segment. V každom segmente nahraďte najprv ~1 znakom / a potom ~0 znakom ~. Nie je to escapovanie reťazcov JSON ani percentuálne kódovanie URI.
Po parsovaní najprv zaindexujte skutočné objekty a polia a až potom nahraďte značky ich cieľmi. Fungujú tak aj referencie na ciele uvedené neskôr. Pri nedôveryhodných dátach overte formát, obmedzte veľkosť a hĺbku a odmietnite neplatné cesty aj chýbajúce ciele. Nepoužívajte eval() ani neprechádzajte reťazce prototypov.
Ak namiesto textu potrebujete kópiu, structuredClone() zachová pri podporovaných hodnotách cykly aj zdieľané referencie. Je to API webovej platformy, nie metóda JSON; dostupnosť závisí od behového prostredia.
Príklady
{
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);
}Výsledok
{"a/~1":{"count":1},"alias":{"$ref":"/a~1~01"},"self":{"$ref":""}}
true
trueUkážka používa dôveryhodné dáta: obyčajné objekty, polia bez medzier a primitívne hodnoty reprezentovateľné v JSON. Dekodér porovnáva celé escapované cesty v `Map`, preto nemusí rušiť escapovanie segmentov. Dva výsledky `true` potvrdzujú obnovenie zdieľanej referencie aj cyklu.
Súvisiace lekcie
- JavaScript · Lekcia 17 · Pokročilá · Verzia: 4
Zdroje
- 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