#ResourceManager: Gestión de Recursos

La funcionalidad de gestión de recursos de NocoBase puede convertir automáticamente las colecciones (tablas de datos) y asociaciones existentes en recursos. Incluye varios tipos de operaciones para ayudar a los desarrolladores a construir rápidamente operaciones de recursos para APIs REST. A diferencia de las APIs REST tradicionales, las operaciones de recursos de NocoBase no dependen de los métodos de solicitud HTTP, sino que determinan la operación específica a ejecutar mediante la definición explícita de :action.

#Generación automática de recursos

NocoBase convierte automáticamente las colecciones y asociaciones definidas en la base de datos en recursos. Por ejemplo, si define dos colecciones, posts y tags:

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

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

Esto generará automáticamente los siguientes recursos:

• Recurso posts
• Recurso tags
• Recurso de asociación posts.tags

Ejemplos de solicitud:

#Operaciones de Recursos

NocoBase ofrece una amplia variedad de tipos de operaciones integradas para satisfacer diversas necesidades de negocio.

#Operaciones CRUD Básicas

#Operaciones de Relación

#Parámetros de Operación

Los parámetros de operación comunes incluyen:

• filter: Condiciones de consulta
• values: Valores a establecer
• fields: Campos a devolver
• appends: Incluir datos asociados
• except: Excluir campos
• sort: Reglas de ordenación
• page, pageSize: Parámetros de paginación
• paginate: Si habilitar la paginación
• tree: Si devolver una estructura de árbol
• whitelist, blacklist: Lista blanca/negra de campos
• updateAssociationValues: Si actualizar los valores de asociación

#Operaciones de Recursos Personalizadas

NocoBase permite registrar operaciones adicionales para recursos existentes. Puede usar registerActionHandlers para personalizar operaciones para todos los recursos o para recursos específicos.

#Registrar Operaciones Globales

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

#Registrar Operaciones Específicas de Recursos

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

Ejemplos de solicitud:

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

Regla de nomenclatura: resourceName:actionName. Use la sintaxis de puntos (posts.comments) cuando incluya asociaciones.

#Recursos Personalizados

Si necesita proporcionar recursos que no están relacionados con las colecciones (tablas de datos), puede definirlos utilizando el método resourceManager.define:

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

Los métodos de solicitud son consistentes con los recursos generados automáticamente:

• GET /api/app:getInfo
• POST /api/app:getInfo (admite GET/POST por defecto)

#Middleware Personalizado

Utilice el método resourceManager.use() para registrar middleware global. Por ejemplo:

Middleware de registro global

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

#Propiedades Especiales del Contexto

Poder acceder al middleware o a la acción de la capa resourceManager significa que el recurso debe existir.

#ctx.action

• ctx.action.actionName: Nombre de la operación
• ctx.action.resourceName: Puede ser una colección o una asociación
• ctx.action.params: Parámetros de la operación

#ctx.dataSource

El objeto de la fuente de datos actual.

#ctx.getCurrentRepository()

El objeto de repositorio actual.

#Cómo obtener objetos resourceManager para diferentes fuentes de datos

El resourceManager pertenece a una fuente de datos, y las operaciones se pueden registrar por separado para diferentes fuentes de datos.

#Fuente de Datos Principal

Para la fuente de datos principal, puede usar directamente app.resourceManager para operar:

app.resourceManager.registerActionHandlers();

#Otras Fuentes de Datos

Para otras fuentes de datos, puede obtener una instancia específica de fuente de datos a través de dataSourceManager y usar el resourceManager de esa instancia para operar:

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

#Iterar Todas las Fuentes de Datos

Si necesita realizar las mismas operaciones en todas las fuentes de datos añadidas, puede usar el método dataSourceManager.afterAddDataSource para iterar, asegurándose de que el resourceManager de cada fuente de datos pueda registrar las operaciones correspondientes:

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