CKTIS / JavaScript
JSON-graafverwijzingen en escaping van paden
Behoud gedeelde objecten en cycli in JSON-tekst met `$ref`-markeringen en paden die tekens in sleutels onderscheiden van padscheidingstekens.
Versie: 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 ~.Gewone JSON legt een boom van waarden vast, geen objectidentiteit. Standaard schrijft JSON.stringify() een gedeeld object zonder cyclus op elke plek apart uit. JSON.parse() maakt van die kopieën afzonderlijke objecten. Als de serialisatie een cyclus tegenkomt, gooit JSON.stringify() een TypeError.
In deze applicatieconventie bewaart een WeakMap het eerste pad van een object voordat de onderliggende waarden worden bezocht. Komt de encoder hetzelfde object opnieuw tegen, dan schrijft die {"$ref":"<path>"}. Dit object met één veld met een tekenreeks als waarde is gereserveerd voor verwijzingen; JSON.parse() lost die niet zelf op.
In een pad in JSON Pointer-stijl staat "" voor de wortel en / voor de eigenschap van de wortel met een lege sleutel. Elk segment is een objectsleutel of een array-index die bij nul begint. Vervang vóór het samenvoegen met / eerst ~ door ~0 en dan / door ~1. De sleutel a/~1 geeft /a~1~01. Bij het lezen geldt: "" heeft geen segmenten. Elk niet-leeg pad moet beginnen met /: verwijder alleen die eerste /, splits de rest op / en behoud lege segmenten. Het pad / heeft dus één leeg segment. Vervang in elk segment eerst ~1 door / en dan ~0 door ~. Dit staat los van JSON-stringescaping en URI-percentcodering.
Indexeer na het parsen eerst de eigenlijke objecten en arrays en vervang daarna de markeringen door hun doelen. Zo werken ook verwijzingen naar doelen die verderop staan. Valideer bij onbetrouwbare gegevens het formaat, begrens grootte en diepte, en wijs ongeldige paden en ontbrekende doelen af. Gebruik geen eval() en doorloop geen prototypeketens.
Als je een kopie nodig hebt in plaats van tekst, behoudt structuredClone() cycli en gedeelde verwijzingen voor ondersteunde waarden. Het is een API van het webplatform, geen methode van JSON; de beschikbaarheid verschilt per runtime.
Voorbeelden
{
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);
}Resultaat
{"a/~1":{"count":1},"alias":{"$ref":"/a~1~01"},"self":{"$ref":""}}
true
trueHet voorbeeld gebruikt vertrouwde gegevens: gewone objecten, arrays zonder gaten en primitieve waarden die in JSON kunnen worden weergegeven. De decoder vergelijkt volledige ge-escapete paden in een `Map` en hoeft segmenten dus niet te decoderen. De twee resultaten `true` bevestigen dat de gedeelde verwijzing en de cyclus zijn hersteld.
Gerelateerde lessen
- JavaScript · Les 17 · Gevorderd · Versie: 4
Bronnen
- 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