#ResourceManager (Resourcebeheer)

De resourcebeheerfunctie van NocoBase kan bestaande collecties en associaties automatisch omzetten in resources. Het biedt ingebouwde bewerkingstypen om ontwikkelaars te helpen snel REST API-resourcebewerkingen te bouwen. In tegenstelling tot traditionele REST API's zijn NocoBase-resourcebewerkingen niet afhankelijk van HTTP-aanvraagmethoden, maar bepalen ze de specifieke uit te voeren bewerking via expliciete :action-definities.

#Automatisch genereren van resources

NocoBase zet automatisch collecties en associaties die in de database zijn gedefinieerd om in resources. Stel dat u bijvoorbeeld twee collecties definieert, posts en tags:

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

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

Dit genereert automatisch de volgende resources:

• posts resource
• tags resource
• posts.tags associatie resource

Aanvraagvoorbeelden:

#Resourcebewerkingen

NocoBase biedt een breed scala aan ingebouwde bewerkingstypen om aan diverse bedrijfsbehoeften te voldoen.

#Basis CRUD-bewerkingen

#Relatiebewerkingen

#Bewerkingparameters

Veelvoorkomende bewerkingparameters zijn:

• filter: Zoekvoorwaarden
• values: In te stellen waarden
• fields: Op te geven velden voor retour
• appends: Gekoppelde gegevens opnemen
• except: Velden uitsluiten
• sort: Sorteerregels
• page, pageSize: Paginatieparameters
• paginate: Paginatie inschakelen
• tree: Boomstructuur retourneren
• whitelist, blacklist: Whitelist/blacklist voor velden
• updateAssociationValues: Associatiewaarden bijwerken

#Aangepaste resourcebewerkingen

NocoBase maakt het mogelijk om extra bewerkingen te registreren voor bestaande resources. U kunt registerActionHandlers gebruiken om bewerkingen aan te passen voor alle of specifieke resources.

#Globale bewerkingen registreren

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

#Resource-specifieke bewerkingen registreren

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

Aanvraagvoorbeelden:

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

Naamgevingsregel: resourceName:actionName. Gebruik de puntnotatie (posts.comments) wanneer associaties zijn inbegrepen.

#Aangepaste resources

Als u resources wilt aanbieden die niet gerelateerd zijn aan collecties, kunt u deze definiëren met de methode resourceManager.define:

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

Aanvraagmethoden komen overeen met automatisch gegenereerde resources:

• GET /api/app:getInfo
• POST /api/app:getInfo (ondersteunt standaard zowel GET als POST)

#Aangepaste middleware

Gebruik de methode resourceManager.use() om globale middleware te registreren. Bijvoorbeeld:

Globale logging-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`);
});

#Speciale Context-eigenschappen

Wanneer u de middleware of actie van de resourceManager-laag kunt betreden, betekent dit dat de resource gegarandeerd bestaat.

#ctx.action

• ctx.action.actionName: Naam van de bewerking
• ctx.action.resourceName: Kan een collectie of associatie zijn
• ctx.action.params: Parameters van de bewerking

#ctx.dataSource

Het huidige gegevensbron-object.

#ctx.getCurrentRepository()

Het huidige repository-object.

#Hoe u resourceManager-objecten voor verschillende gegevensbronnen krijgt

resourceManager behoort tot een gegevensbron, en bewerkingen kunnen afzonderlijk voor verschillende gegevensbronnen worden geregistreerd.

#Hoofdgegevensbron

Voor de hoofdgegevensbron kunt u direct app.resourceManager gebruiken om bewerkingen uit te voeren:

app.resourceManager.registerActionHandlers();

#Andere gegevensbronnen

Voor andere gegevensbronnen kunt u via dataSourceManager een specifieke gegevensbron-instantie ophalen en de resourceManager van die instantie gebruiken om bewerkingen uit te voeren:

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

#Alle gegevensbronnen doorlopen

Als u dezelfde bewerkingen op alle toegevoegde gegevensbronnen wilt uitvoeren, kunt u de methode dataSourceManager.afterAddDataSource gebruiken om deze te doorlopen. Dit zorgt ervoor dat de resourceManager van elke gegevensbron de bijbehorende bewerkingen kan registreren:

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