CKTIS / JavaScript
JSON-Graphreferenzen und Maskierung von Pfadsegmenten
Erhalte gemeinsam referenzierte Objekte und Zyklen in JSON-Text mithilfe von `$ref`-Markern und Pfaden, die Schlüsselzeichen von Trennzeichen unterscheiden.
Version: 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 ~.Reines JSON speichert einen Wertebaum, keine Objektidentität. Beim Standardverhalten von JSON.stringify() wird ein gemeinsam referenziertes Objekt ohne Zyklus an jeder Stelle separat geschrieben. Aus diesen Kopien erzeugt JSON.parse() verschiedene Objekte. Trifft die Serialisierung auf einen Zyklus, löst JSON.stringify() einen TypeError aus.
In dieser Anwendungskonvention speichert eine WeakMap den ersten Pfad eines Objekts, bevor dessen Kindelemente oder Eigenschaften besucht werden. Bei erneutem Auftreten entsteht {"$ref":"<path>"}. Dieses Objekt mit genau einem String-Feld ist für Referenzen reserviert; JSON.parse() löst es nicht selbst auf.
Ein Pfad im JSON-Pointer-Stil ist "" für die Wurzel und / für deren Eigenschaft mit leerem Schlüssel. Ein Segment ist ein Objektschlüssel oder ein bei null beginnender Arrayindex. Vor dem Verbinden mit / wird ~ durch ~0 ersetzt, dann / durch ~1. Aus a/~1 wird /a~1~01. Beim Lesen gilt: "" hat keine Segmente. Jeder nicht leere Pfad muss mit / beginnen. Nur diesen ersten / entfernen, den Rest an / aufteilen und leere Segmente beibehalten. Der Pfad / hat somit ein leeres Segment. In jedem Segment zuerst ~1 durch / und dann ~0 durch ~ ersetzen. Das ist weder JSON-String-Escaping noch URI-Prozentkodierung.
Nach dem Parsen zuerst die eigentlichen Objekte und Arrays indexieren, dann die Marker durch ihre Ziele ersetzen. So funktionieren auch Vorwärtsreferenzen. Bei nicht vertrauenswürdigen Daten das Format prüfen, Größe und Tiefe begrenzen sowie ungültige Pfade und fehlende Ziele ablehnen. Weder eval() verwenden noch Prototypketten durchlaufen.
Wenn eine Kopie statt Text genügt, erhält structuredClone() Zyklen und gemeinsame Referenzen für unterstützte Werte. Es ist eine Webplattform-API, keine JSON-Methode; die Verfügbarkeit hängt von der Laufzeitumgebung ab.
Beispiele
{
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);
}Ergebnis
{"a/~1":{"count":1},"alias":{"$ref":"/a~1~01"},"self":{"$ref":""}}
true
trueDas Beispiel nutzt vertrauenswürdige Daten: gewöhnliche Objekte, Arrays ohne Lücken und in JSON darstellbare primitive Werte. Der Decoder gleicht vollständige maskierte Pfade in einer `Map` ab und muss die Segmente deshalb nicht demaskieren. Die beiden `true`-Ergebnisse bestätigen die gemeinsame Referenz und den Zyklus.
Zugehörige Lektionen
- JavaScript · Lektion 17 · Fortgeschritten · Version: 4
Quellen
- 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