Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Reference v grafech JSON a escapování cest

Zachovejte sdílené objekty a cykly v textu JSON pomocí značek `$ref` a cest, které odlišují znaky uvnitř klíčů od oddělovačů.

Verze: ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

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 ~.

Běžný JSON zapisuje strom hodnot, nikoli identitu objektů. Ve výchozím režimu JSON.stringify() zapíše sdílený objekt bez cyklu samostatně při každém výskytu. JSON.parse() z těchto kopií vytvoří různé objekty. Pokud serializace narazí na cyklus, JSON.stringify() vyvolá TypeError.

V této aplikační konvenci si WeakMap zapamatuje první cestu k objektu před zpracováním jeho potomků. Při dalším výskytu téhož objektu se zapíše {"$ref":"<path>"}. Tento objekt s jediným řetězcovým polem je vyhrazen pro reference; JSON.parse() je sám nevyhodnocuje.

V cestě ve stylu JSON Pointer označuje "" kořen a / jeho vlastnost s prázdným klíčem. Segmentem je klíč objektu nebo index pole počítaný od nuly. Před spojením segmentů pomocí / nahraďte ~ za ~0 a poté / za ~1. Klíči a/~1 odpovídá /a~1~01. Při čtení považujte "" za cestu bez segmentů. Každá neprázdná cesta musí začínat znakem /: odstraňte pouze tento první znak /, zbytek rozdělte podle / a zachovejte i prázdné segmenty. Cesta / má tedy jeden prázdný segment. V každém segmentu nahraďte nejprve ~1 znakem / a potom ~0 znakem ~. Nejde o escapování řetězců JSON ani o procentní kódování URI.

Po parsování nejprve zaindexujte skutečné objekty a pole a teprve potom nahraďte značky jejich cíli. Tak fungují i reference na cíle, které jsou uvedeny později. U nedůvěryhodných dat ověřte formát, omezte velikost a hloubku a odmítněte neplatné cesty i chybějící cíle. Nepoužívejte eval() ani neprocházejte řetězce prototypů.

Potřebujete-li místo textu kopii, structuredClone() u podporovaných hodnot zachová cykly a sdílené reference. Je to API webové platformy, nikoli metoda JSON; dostupnost závisí na běhovém prostředí.

Pří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ýsledek

{"a/~1":{"count":1},"alias":{"$ref":"/a~1~01"},"self":{"$ref":""}}
true
true

Ukázka používá důvěryhodná data: obyčejné objekty, pole bez mezer a primitivní hodnoty reprezentovatelné v JSON. Dekodér porovnává celé escapované cesty v `Map`, takže nemusí escapování segmentů rušit. Dva výsledky `true` potvrzují obnovení sdílené reference i cyklu.

Související lekce

  • JavaScript · Lekce 17 · Pokročilá · Verze: 4

Zdroje