JavaScript Async Local Storage: Zvládnutí správy kontextu v asynchronních prostředích

Asynchronní programování je základem moderního JavaScriptu, zejména v Node.js pro serverové aplikace a stále více i v prohlížeči. Správa kontextu – dat specifických pro požadavek, uživatelskou relaci nebo transakci – napříč asynchronními operacemi však může být náročná. Standardní techniky, jako je předávání dat prostřednictvím volání funkcí, se mohou stát těžkopádnými a náchylnými k chybám, zejména ve složitých aplikacích. Právě zde přichází Async Local Storage (ALS) jako výkonné řešení.

Co je Async Local Storage (ALS)?

Async Local Storage (ALS) poskytuje způsob, jak ukládat data, která jsou lokální pro specifickou asynchronní operaci. Představte si to jako thread-local storage v jiných programovacích jazycích, ale přizpůsobené pro jednovláknový, událostmi řízený model JavaScriptu. ALS vám umožňuje asociovat data s aktuálním asynchronním kontextem provádění, čímž je zpřístupňuje napříč celým řetězcem asynchronních volání, aniž byste je museli explicitně předávat jako argumenty.

V podstatě ALS vytváří úložný prostor, který se automaticky šíří asynchronními operacemi iniciovanými v rámci stejného kontextu. To zjednodušuje správu kontextu a výrazně snižuje množství opakujícího se kódu (boilerplate) potřebného k udržení stavu přes asynchronní hranice.

Proč používat Async Local Storage?

ALS nabízí několik klíčových výhod v asynchronním vývoji v JavaScriptu:

• Zjednodušená správa kontextu: Vyhněte se předávání kontextových proměnných přes více volání funkcí, což snižuje nepřehlednost kódu a zlepšuje čitelnost.
• Zlepšené ladění: Snadno sledujte data specifická pro požadavek v celém asynchronním call stacku, což usnadňuje ladění a řešení problémů.
• Méně opakujícího se kódu: Eliminujte potřebu manuálního šíření kontextu, což vede k čistšímu a udržitelnějšímu kódu.
• Zvýšený výkon: Šíření kontextu je řešeno automaticky, což minimalizuje výkonnostní režii spojenou s manuálním předáváním kontextu.
• Centralizovaný přístup ke kontextu: Poskytuje jediné, dobře definované místo pro přístup k datům kontextu, což zjednodušuje přístup a modifikaci.

Případy použití Async Local Storage

ALS je obzvláště užitečné ve scénářích, kde potřebujete sledovat data specifická pro požadavek napříč asynchronními operacemi. Zde jsou některé běžné případy použití:

1. Sledování požadavků ve webových serverech

Na webovém serveru lze každý příchozí požadavek považovat za samostatný asynchronní kontext. ALS lze použít k uložení informací specifických pro požadavek, jako je ID požadavku, ID uživatele, autentizační token a další relevantní data. To vám umožní snadný přístup k těmto informacím z jakékoli části vaší aplikace, která požadavek zpracovává, včetně middleware, kontrolerů a databázových dotazů.

Příklad (Node.js s Expressem):

const express = require('express');
const { AsyncLocalStorage } = require('async_hooks');
const { v4: uuidv4 } = require('uuid');

const app = express();
const asyncLocalStorage = new AsyncLocalStorage();

app.use((req, res, next) => {
  const requestId = uuidv4();
  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);
    console.log(`Požadavek ${requestId} zahájen`);
    next();
  });
});

app.get('/', (req, res) => {
  const requestId = asyncLocalStorage.getStore().get('requestId');
  console.log(`Zpracovávám požadavek ${requestId}`);
  res.send(`Dobrý den, ID požadavku: ${requestId}`);
});

app.listen(3000, () => {
  console.log('Server naslouchá na portu 3000');
});

V tomto příkladu je každému příchozímu požadavku přiděleno jedinečné ID, které je uloženo v Async Local Storage. K tomuto ID lze poté přistupovat z jakékoli části handleru požadavku, což vám umožní sledovat požadavek po celou dobu jeho životního cyklu.

2. Správa uživatelských relací

ALS lze také použít ke správě uživatelských relací. Když se uživatel přihlásí, můžete do ALS uložit data jeho relace (např. ID uživatele, role, oprávnění). To vám umožní snadný přístup k datům relace uživatele z jakékoli části vaší aplikace, která je potřebuje, aniž byste je museli předávat jako argumenty.

Příklad:

const { AsyncLocalStorage } = require('async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

function authenticateUser(username, password) {
  // Simulace autentizace
  if (username === 'user' && password === 'password') {
    const userSession = { userId: 123, username: 'user', roles: ['admin'] };
    asyncLocalStorage.run(new Map(), () => {
      asyncLocalStorage.getStore().set('userSession', userSession);
      console.log('Uživatel ověřen, relace uložena v ALS');
      return true;
    });
    return true;
  } else {
    return false;
  }
}

function getUserSession() {
  return asyncLocalStorage.getStore() ? asyncLocalStorage.getStore().get('userSession') : null;
}

function someAsyncOperation() {
  return new Promise(resolve => {
    setTimeout(() => {
      const userSession = getUserSession();
      if (userSession) {
        console.log(`Asynchronní operace: ID uživatele: ${userSession.userId}`);
        resolve();
      } else {
        console.log('Asynchronní operace: Nalezena žádná uživatelská relace');
        resolve();
      }
    }, 100);
  });
}

async function main() {
  if (authenticateUser('user', 'password')) {
    await someAsyncOperation();
  } else {
    console.log('Ověření selhalo');
  }
}

main();

V tomto příkladu je po úspěšném ověření uživatelská relace uložena v ALS. Funkce `someAsyncOperation` pak může k těmto datům relace přistupovat, aniž by je musela explicitně přijímat jako argument.

3. Správa transakcí

V databázových transakcích lze ALS použít k uložení transakčního objektu. To vám umožní přistupovat k transakčnímu objektu z jakékoli části vaší aplikace, která se transakce účastní, a zajistit tak, že všechny operace jsou prováděny v rámci stejného transakčního rozsahu.

4. Logování a auditování

ALS lze použít k ukládání kontextově specifických informací pro účely logování a auditování. Například můžete do ALS uložit ID uživatele, ID požadavku a časové razítko a poté tyto informace zahrnout do svých logovacích zpráv. To usnadňuje sledování aktivity uživatelů a identifikaci potenciálních bezpečnostních problémů.

Jak používat Async Local Storage

Používání Async Local Storage zahrnuje tři hlavní kroky:

1. Vytvořte instanci AsyncLocalStorage: Vytvořte instanci třídy `AsyncLocalStorage`.
2. Spusťte kód v rámci kontextu: Použijte metodu `run()` k provedení kódu v rámci specifického kontextu. Metoda `run()` přijímá dva argumenty: úložiště (obvykle Map nebo objekt) a callback funkci. Úložiště bude dostupné všem asynchronním operacím iniciovaným v rámci této callback funkce.
3. Přistupte k úložišti: Použijte metodu `getStore()` pro přístup k úložišti z asynchronního kontextu.

Příklad:

const { AsyncLocalStorage } = require('async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

function doSomethingAsync() {
  return new Promise(resolve => {
    setTimeout(() => {
      const value = asyncLocalStorage.getStore().get('myKey');
      console.log('Hodnota z ALS:', value);
      resolve();
    }, 500);
  });
}

async function main() {
  asyncLocalStorage.run(new Map(), async () => {
    asyncLocalStorage.getStore().set('myKey', 'Ahoj z ALS!');
    await doSomethingAsync();
  });
}

main();

AsyncLocalStorage API

Třída `AsyncLocalStorage` poskytuje následující metody:

• constructor(): Vytvoří novou instanci AsyncLocalStorage.
• run(store, callback, ...args): Spustí poskytnutou callback funkci v kontextu, kde je dostupné dané úložiště. Úložiště je typicky `Map` nebo obyčejný JavaScript objekt. Všechny asynchronní operace iniciované v rámci callbacku zdědí tento kontext. Callback funkci lze předat další argumenty.
• getStore(): Vrátí aktuální úložiště pro aktuální asynchronní kontext. Vrátí `undefined`, pokud s aktuálním kontextem není žádné úložiště spojeno.
• disable(): Deaktivuje instanci AsyncLocalStorage. Jakmile je deaktivována, metody `run()` a `getStore()` již nebudou fungovat.

Doporučení a osvědčené postupy

Ačkoliv je ALS mocný nástroj, je důležité ho používat uvážlivě. Zde jsou některá doporučení a osvědčené postupy:

• Vyhněte se nadměrnému používání: Nepoužívejte ALS na všechno. Používejte ho pouze tehdy, když potřebujete sledovat kontext přes asynchronní hranice. Zvažte jednodušší řešení, jako jsou běžné proměnné, pokud kontext není potřeba šířit přes asynchronní volání.
• Výkon: Ačkoliv je ALS obecně efektivní, nadměrné používání může ovlivnit výkon. Měřte a optimalizujte svůj kód podle potřeby. Dbejte na velikost úložiště, které do ALS vkládáte. Velké objekty mohou ovlivnit výkon, zejména pokud je iniciováno mnoho asynchronních operací.
• Správa kontextu: Ujistěte se, že správně řídíte životní cyklus úložiště. Vytvořte nové úložiště pro každý požadavek nebo relaci a ukliďte ho, když už není potřeba. Ačkoliv ALS samo pomáhá spravovat rozsah platnosti, data *uvnitř* úložiště stále vyžadují správné zacházení a garbage collection.
• Zpracování chyb: Dbejte na zpracování chyb. Pokud dojde k chybě v asynchronní operaci, kontext může být ztracen. Zvažte použití bloků try-catch pro zpracování chyb a zajištění správného udržení kontextu.
• Ladění: Ladění aplikací založených na ALS může být náročné. Používejte ladicí nástroje a logování ke sledování toku provádění a identifikaci potenciálních problémů.
• Kompatibilita: ALS je k dispozici v Node.js verze 14.5.0 a novějších. Před použitím se ujistěte, že vaše prostředí ALS podporuje. Pro starší verze Node.js zvažte použití alternativních řešení, jako je continuation-local storage (CLS), ačkoliv ty mohou mít odlišné výkonnostní charakteristiky a API.

Alternativy k Async Local Storage

Před zavedením ALS se vývojáři často spoléhali na jiné techniky pro správu kontextu v asynchronním JavaScriptu. Zde jsou některé běžné alternativy:

• Explicitní předávání kontextu: Předávání kontextových proměnných jako argumentů každé funkci v řetězci volání. Tento přístup je jednoduchý, ale ve složitých aplikacích se může stát zdlouhavým a náchylným k chybám. Také ztěžuje refaktoring, protože změna kontextových dat vyžaduje úpravu signatury mnoha funkcí.
• Continuation-Local Storage (CLS): CLS poskytuje podobnou funkcionalitu jako ALS, ale je založeno na jiném mechanismu. CLS používá monkey-patching k zachycení asynchronních operací a šíření kontextu. Tento přístup může být složitější a může mít dopady na výkon.
• Knihovny a frameworky: Některé knihovny a frameworky poskytují vlastní mechanismy pro správu kontextu. Například Express.js poskytuje middleware pro správu dat specifických pro požadavek.

Ačkoliv tyto alternativy mohou být v určitých situacích užitečné, ALS nabízí elegantnější a efektivnější řešení pro správu kontextu v asynchronním JavaScriptu.

Závěr

Async Local Storage (ALS) je mocný nástroj pro správu kontextu v asynchronních JavaScript aplikacích. Tím, že poskytuje způsob ukládání dat, která jsou lokální pro specifickou asynchronní operaci, ALS zjednodušuje správu kontextu, zlepšuje ladění a snižuje množství opakujícího se kódu. Ať už stavíte webový server, spravujete uživatelské relace nebo zpracováváte databázové transakce, ALS vám může pomoci psát čistší, udržitelnější a efektivnější kód.

Asynchronní programování se v JavaScriptu stává stále více všudypřítomným, což činí porozumění nástrojům jako ALS stále důležitějším. Pochopením jeho správného použití a omezení mohou vývojáři vytvářet robustnější a spravovatelnější aplikace schopné škálování a přizpůsobení se rozmanitým potřebám uživatelů po celém světě. Experimentujte s ALS ve svých projektech a objevte, jak může zjednodušit vaše asynchronní pracovní postupy a zlepšit celkovou architekturu vaší aplikace.

Další zdroje

• Dokumentace Node.js AsyncLocalStorage
• npm balíček async-local-storage (pro starší verze Node.js)
• Async Local Storage v Node.js - YouTube