#ResourceManager

Функция управления ресурсами NocoBase позволяет автоматически преобразовывать существующие таблицы данных (коллекции) и связи (ассоциации) в ресурсы. Она включает встроенные типы операций, которые помогают разработчикам быстро создавать операции с ресурсами REST API. В отличие от традиционных REST API, операции с ресурсами NocoBase не зависят от методов HTTP-запросов. Вместо этого они определяют конкретную операцию для выполнения через явное определение :action.

#Автоматическая генерация ресурсов

NocoBase автоматически преобразует коллекции и ассоциации, определённые в базе данных, в ресурсы. Например, если вы определите две коллекции, posts и tags:

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

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

Это автоматически сгенерирует следующие ресурсы:

• ресурс posts
• ресурс tags
• ресурс ассоциации posts.tags

Примеры запросов:

#Операции с ресурсами

NocoBase предоставляет обширный набор встроенных типов операций для удовлетворения различных бизнес-требований.

#Базовые CRUD-операции

#Операции со связями

#Параметры операций

К распространённым параметрам операций относятся:

• filter: Условия запроса
• values: Устанавливаемые значения
• fields: Указанные возвращаемые поля
• appends: Включение связанных данных
• except: Исключаемые поля
• sort: Правила сортировки
• page, pageSize: Параметры пагинации
• paginate: Включить ли пагинацию
• tree: Возвращать ли древовидную структуру
• whitelist, blacklist: Белый/чёрный список полей
• updateAssociationValues: Обновлять ли значения связей

#Пользовательские операции с ресурсами

NocoBase позволяет регистрировать дополнительные операции для существующих ресурсов. Вы можете использовать registerActionHandlers для настройки операций как для всех, так и для конкретных ресурсов.

#Регистрация глобальных операций

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

#Регистрация операций для конкретных ресурсов

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

Примеры запросов:

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

Правило именования: resourceName:actionName. При включении связей используйте точечную нотацию (posts.comments).

#Пользовательские ресурсы

Если вам нужно предоставить ресурсы, не связанные с коллекциями, вы можете определить их с помощью метода resourceManager.define:

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

Методы запросов соответствуют автоматически сгенерированным ресурсам:

• GET /api/app:getInfo
• POST /api/app:getInfo (по умолчанию поддерживает как GET, так и POST)

#Пользовательское промежуточное ПО

Используйте метод resourceManager.use() для регистрации глобального промежуточного ПО. Например:

Глобальное промежуточное ПО для логирования

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

#Специальные свойства контекста

Возможность использования промежуточного ПО или действий на уровне resourceManager означает, что ресурс обязательно существует.

#ctx.action

• ctx.action.actionName: Название операции
• ctx.action.resourceName: Может быть коллекцией или ассоциацией
• ctx.action.params: Параметры операции

#ctx.dataSource

Текущий объект источника данных.

#ctx.getCurrentRepository()

Текущий объект репозитория.

#Как получить объекты resourceManager для разных источников данных

resourceManager принадлежит к источнику данных, и операции могут быть зарегистрированы отдельно для каждого источника данных.

#Основной источник данных

Для основного источника данных вы можете напрямую использовать app.resourceManager:

app.resourceManager.registerActionHandlers();

#Другие источники данных

Для других источников данных вы можете получить конкретный экземпляр источника данных через dataSourceManager и использовать resourceManager этого экземпляра:

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

#Итерация по всем источникам данных

Если вам нужно выполнить одни и те же операции для всех добавленных источников данных, вы можете использовать метод dataSourceManager.afterAddDataSource для итерации, гарантируя, что resourceManager каждого источника данных сможет зарегистрировать соответствующие операции:

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