#ResourceManager Správa zdrojů

Funkce správy zdrojů v NocoBase dokáže automaticky převádět existující databázové tabulky (kolekce) a asociace na zdroje. Obsahuje vestavěné typy operací, které vývojářům pomáhají rychle vytvářet operace se zdroji REST API. Na rozdíl od tradičních REST API se operace se zdroji v NocoBase nespoléhají na metody HTTP požadavků, ale určují konkrétní operaci k provedení prostřednictvím explicitních definic :action.

#Automatické generování zdrojů

NocoBase automaticky převádí kolekce a asociace definované v databázi na zdroje. Například, pokud definujete dvě kolekce, posts a tags:

db.defineCollection({
  name: 'posts',
  fields: [
    { type: 'belongsToMany', name: 'tags' },
  ],
});

db.defineCollection({
  name: 'tags',
  fields: [],
});

Tím se automaticky vygenerují následující zdroje:

• posts zdroj
• tags zdroj
• posts.tags asociační zdroj

Příklady požadavků:

#Operace se zdroji

NocoBase nabízí bohaté vestavěné typy operací, které splňují různé obchodní potřeby.

#Základní CRUD operace

#Relační operace

#Parametry operací

Mezi běžné parametry operací patří:

• filter: Podmínky dotazu
• values: Hodnoty k nastavení
• fields: Určení vrácených polí
• appends: Zahrnout asociovaná data
• except: Vyloučit pole
• sort: Pravidla řazení
• page, pageSize: Parametry stránkování
• paginate: Zda povolit stránkování
• tree: Zda vrátit stromovou strukturu
• whitelist, blacklist: Whitelist/blacklist polí
• updateAssociationValues: Zda aktualizovat asociované hodnoty

#Vlastní operace se zdroji

NocoBase umožňuje registrovat dodatečné operace pro existující zdroje. Můžete použít registerActionHandlers k přizpůsobení operací pro všechny nebo specifické zdroje.

#Registrace globálních operací

resourceManager.registerActionHandlers({
  customAction: async (ctx) => {
    ctx.body = { resource: ctx.action.resourceName };
  },
});

#Registrace operací pro konkrétní zdroje

resourceManager.registerActionHandlers({
  'posts:publish': async (ctx) => publishPost(ctx),
  'posts.comments:pin': async (ctx) => pinComment(ctx),
});

Příklady požadavků:

POST /api/posts:customAction
POST /api/posts:publish
POST /api/posts/1/comments:pin

Pravidlo pojmenování: resourceName:actionName, při zahrnutí asociací použijte tečkovou syntaxi (posts.comments).

#Vlastní zdroje

Pokud potřebujete poskytovat zdroje, které nesouvisí s kolekcemi, můžete je definovat pomocí metody resourceManager.define:

resourceManager.define({
  name: 'app',
  actions: {
    getInfo: async (ctx) => {
      ctx.body = { version: 'v1' };
    },
  },
});

Metody požadavků jsou konzistentní s automaticky generovanými zdroji:

• GET /api/app:getInfo
• POST /api/app:getInfo (standardně podporuje GET/POST)

#Vlastní middleware

Použijte metodu resourceManager.use() k registraci globálního middleware. Například:

Globální logovací middleware

resourceManager.use(async (ctx, next) => {
  const start = Date.now();
  await next();
  const duration = Date.now() - start;
  console.log(`${ctx.method} ${ctx.path} - ${duration}ms`);
});

#Speciální vlastnosti Contextu

Možnost vstoupit do middleware nebo akce vrstvy resourceManager znamená, že daný zdroj musí existovat.

#ctx.action

• ctx.action.actionName: Název operace
• ctx.action.resourceName: Může být kolekce nebo asociace
• ctx.action.params: Parametry operace

#ctx.dataSource

Aktuální objekt zdroje dat.

#ctx.getCurrentRepository()

Aktuální objekt repozitáře.

#Jak získat objekty resourceManager pro různé zdroje dat

resourceManager patří ke zdroji dat a operace lze registrovat samostatně pro různé zdroje dat.

#Hlavní zdroj dat

Pro hlavní zdroj dat můžete přímo použít app.resourceManager:

app.resourceManager.registerActionHandlers();

#Ostatní zdroje dat

Pro ostatní zdroje dat můžete získat konkrétní instanci zdroje dat prostřednictvím dataSourceManager a použít resourceManager této instance:

const dataSource = dataSourceManager.get('external');
dataSource.resourceManager.registerActionHandlers();

#Iterace přes všechny zdroje dat

Pokud potřebujete provést stejné operace na všech přidaných zdrojích dat, můžete použít metodu dataSourceManager.afterAddDataSource k iteraci, čímž zajistíte, že resourceManager každého zdroje dat bude moci registrovat odpovídající operace:

dataSourceManager.afterAddDataSource((dataSource) => {
  dataSource.resourceManager.registerActionHandlers();
});