#Resurshanteraren

NocoBase:s resurshanteringsfunktion kan automatiskt omvandla befintliga datatabeller (samlingar) och associationer till resurser, och har inbyggda operationstyper som hjälper utvecklare att snabbt bygga REST API-resursoperationer. Till skillnad från traditionella REST API:er förlitar sig NocoBase:s resursoperationer inte på HTTP-förfrågningsmetoder, utan bestämmer den specifika operationen som ska utföras genom att explicit definiera :action.

#Automatisk resursgenerering

NocoBase omvandlar automatiskt samlingar och associationer som definieras i databasen till resurser. Till exempel, om ni definierar två samlingar, posts och tags:

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

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

Detta kommer automatiskt att generera följande resurser:

• posts-resurs
• tags-resurs
• posts.tags-associationsresurs

Exempel på förfrågningar:

#Resursoperationer

NocoBase tillhandahåller ett brett utbud av inbyggda operationstyper för att möta olika affärsbehov.

#Grundläggande CRUD-operationer

#Relationsoperationer

#Operationsparametrar

Vanliga operationsparametrar inkluderar:

• filter: Sökfilter
• values: Värden att ställa in
• fields: Ange fält som ska returneras
• appends: Inkludera associerad data
• except: Exkludera fält
• sort: Sorteringsregler
• page, pageSize: Pagineringparametrar
• paginate: Om paginering ska aktiveras
• tree: Om trädstruktur ska returneras
• whitelist, blacklist: Vitlista/svartlista för fält
• updateAssociationValues: Om associerade värden ska uppdateras

#Anpassade resursoperationer

NocoBase tillåter registrering av ytterligare operationer för befintliga resurser. Ni kan använda registerActionHandlers för att anpassa operationer för alla eller specifika resurser.

#Registrera globala operationer

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

#Registrera resursspecifika operationer

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

Exempel på förfrågningar:

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

Namngivningsregel: resourceName:actionName, använd punktnotation (posts.comments) när associationer inkluderas.

#Anpassade resurser

Om ni behöver tillhandahålla resurser som är oberoende av samlingar, kan ni använda metoden resourceManager.define för att definiera dem:

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

Förfrågningsmetoderna överensstämmer med automatiskt genererade resurser:

• GET /api/app:getInfo
• POST /api/app:getInfo (stöder GET/POST som standard)

#Anpassade mellanprogram

Använd metoden resourceManager.use() för att registrera globala mellanprogram. Till exempel:

Globalt loggningsmellanprogram

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

#Specifika Context-egenskaper

Att kunna komma åt mellanprogram eller åtgärder på resourceManager-nivån innebär att resursen måste existera.

#ctx.action

• ctx.action.actionName: Operationsnamn
• ctx.action.resourceName: Kan vara en samling eller association
• ctx.action.params: Operationsparametrar

#ctx.dataSource

Det aktuella datakälleobjektet.

#ctx.getCurrentRepository()

Det aktuella repository-objektet.

#Hur man hämtar resourceManager-objekt för olika datakällor

resourceManager tillhör en datakälla, och operationer kan registreras separat för olika datakällor.

#Huvuddatakälla

För huvuddatakällan kan ni direkt använda app.resourceManager för operationer:

app.resourceManager.registerActionHandlers();

#Andra datakällor

För andra datakällor kan ni hämta en specifik datakälleinstans via dataSourceManager och använda den instansens resourceManager för operationer:

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

#Iterera över alla datakällor

Om ni behöver utföra samma operationer på alla tillagda datakällor, kan ni använda metoden dataSourceManager.afterAddDataSource för att iterera, vilket säkerställer att varje datakällas resourceManager kan registrera de motsvarande operationerna:

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