Resource API
NocoBase FlowEngine предоставляет два класса Resource для работы с данными на стороне клиента: MultiRecordResource — для списков и таблиц (несколько записей), SingleRecordResource — для форм и страниц подробностей (одна запись). Они инкапсулируют вызовы REST API и обеспечивают реактивное управление данными.
Цепочка наследования: FlowResource → APIResource → BaseRecordResource → MultiRecordResource / SingleRecordResource
MultiRecordResource
Используется для списков, таблиц, канбан-досок и других сценариев с несколькими записями. Импортируется из @nocobase/flow-engine.
Операции с данными
Постраничная навигация
Выделенные строки
Пример: использование в CollectionBlockModel
При наследовании от CollectionBlockModel необходимо создать resource через createResource(), а затем читать данные в renderComponent():
import React from 'react';
import { BlockSceneEnum, CollectionBlockModel } from '@nocobase/client-v2';
import { MultiRecordResource } from '@nocobase/flow-engine';
import { tExpr } from '../locale';
export class ManyRecordBlockModel extends CollectionBlockModel {
static scene = BlockSceneEnum.many;
// Объявляем использование MultiRecordResource для управления данными
createResource() {
return this.context.makeResource(MultiRecordResource);
}
get resource() {
return this.context.resource as MultiRecordResource;
}
renderComponent() {
const data = this.resource.getData(); // TDataItem[]
const count = this.resource.getCount(); // Общее количество записей
return (
<div>
<h3>Всего {count} записей (страница {this.resource.getPage()})</h3>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
}
}
ManyRecordBlockModel.define({
label: tExpr('Many records block'),
});
Полный пример см. в FlowEngine → Расширение Block.
Пример: вызов CRUD из кнопки действия
В обработчике registerFlow модели ActionModel через ctx.blockModel?.resource можно получить resource текущего Block и вызывать CRUD-методы:
import { ActionModel, ActionSceneEnum } from '@nocobase/client-v2';
import { MultiRecordResource } from '@nocobase/flow-engine';
import { tExpr } from '../locale';
export class NewTodoActionModel extends ActionModel {
static scene = ActionSceneEnum.collection;
defaultProps = {
type: 'primary',
children: tExpr('New todo'),
};
}
NewTodoActionModel.define({
label: tExpr('New todo'),
});
NewTodoActionModel.registerFlow({
key: 'newTodoFlow',
title: tExpr('New todo'),
on: 'click',
steps: {
openForm: {
async handler(ctx) {
// Получаем resource текущего Block
const resource = ctx.blockModel?.resource as MultiRecordResource;
if (!resource) return;
ctx.viewer.dialog({
title: ctx.t('New todo'),
content: (view) => (
<MyForm
onSubmit={async (values) => {
// Создаём запись; resource автоматически обновится после создания
await resource.create(values);
ctx.message.success(ctx.t('Created successfully'));
view.close();
}}
onCancel={() => view.close()}
/>
),
});
},
},
},
});
Полный пример см. в Создание полнофункционального плагина управления данными.
Пример: краткий справочник CRUD-операций
async handler(ctx) {
const resource = ctx.blockModel?.resource as MultiRecordResource;
// --- Создание ---
await resource.create({ title: 'New item', completed: false });
// Без автоматического обновления
await resource.create({ title: 'Draft' }, { refresh: false });
// --- Чтение ---
const items = resource.getData(); // TDataItem[]
const count = resource.getCount(); // Общее количество записей
const item = await resource.get(1); // Получение по первичному ключу
// --- Обновление ---
await resource.update(1, { title: 'Updated' });
// --- Удаление ---
await resource.destroy(1); // Удаление одной записи
await resource.destroy([1, 2, 3]); // Пакетное удаление
// --- Постраничная навигация ---
resource.setPage(2);
resource.setPageSize(50);
await resource.refresh();
// Или используйте сокращённые методы
await resource.goto(3);
await resource.next();
await resource.previous();
// --- Обновление ---
await resource.refresh();
}
SingleRecordResource
Используется для форм, страниц подробностей и других сценариев с одной записью. Импортируется из @nocobase/flow-engine.
Операции с данными
Ключевые свойства
Пример: сценарий с формой подробностей
import React from 'react';
import { BlockSceneEnum, CollectionBlockModel } from '@nocobase/client-v2';
import { SingleRecordResource } from '@nocobase/flow-engine';
import { tExpr } from '../locale';
export class DetailBlockModel extends CollectionBlockModel {
static scene = BlockSceneEnum.one;
createResource() {
return this.context.makeResource(SingleRecordResource);
}
get resource() {
return this.context.resource as SingleRecordResource;
}
renderComponent() {
const data = this.resource.getData(); // Один объект или null
if (!data) return <div>Загрузка...</div>;
return (
<div>
<h3>{data.title}</h3>
<p>{data.content}</p>
</div>
);
}
}
DetailBlockModel.define({
label: tExpr('Detail block'),
});
Пример: создание и редактирование записи
async handler(ctx) {
const resource = ctx.model.context.resource as SingleRecordResource;
// --- Создание новой записи ---
resource.isNewRecord = true;
await resource.save({ name: 'John', age: 30 });
// Внутри save вызывается action create, после чего автоматически выполняется refresh
// --- Редактирование существующей записи ---
resource.setFilterByTk(1); // Автоматически устанавливает isNewRecord = false
await resource.refresh(); // Сначала загружаем актуальные данные
const data = resource.getData();
await resource.save({ ...data, name: 'Jane' });
// Внутри save вызывается action update
// --- Удаление текущей записи ---
await resource.destroy(); // Используется ранее установленный filterByTk
}
Общие методы
Следующие методы доступны как у MultiRecordResource, так и у SingleRecordResource:
Фильтрация
Управление полями
Конфигурация ресурса
Метаданные и состояние
События
resource.on('saved', (data) => {
console.log('Запись сохранена:', data);
});
Синтаксис Filter
NocoBase использует JSON-подобный синтаксис фильтров, в котором операторы начинаются с $:
// Равно
{ status: { $eq: 'active' } }
// Не равно
{ status: { $ne: 'deleted' } }
// Больше
{ age: { $gt: 18 } }
// Содержит (нечёткий поиск)
{ name: { $includes: 'test' } }
// Составное условие
{
$and: [
{ status: { $eq: 'active' } },
{ age: { $gt: 18 } },
]
}
// Условие ИЛИ
{
$or: [
{ status: { $eq: 'active' } },
{ role: { $eq: 'admin' } },
]
}
Для управления условиями фильтрации в Resource рекомендуется использовать addFilterGroup:
// Добавляем несколько групп фильтров
resource.addFilterGroup('status', { status: { $eq: 'active' } });
resource.addFilterGroup('age', { age: { $gt: 18 } });
// getFilter() автоматически объединяет в: { $and: [...] }
// Удаляем группу фильтра
resource.removeFilterGroup('status');
// Применяем фильтрацию через обновление
await resource.refresh();
Сравнение MultiRecordResource и SingleRecordResource
Связанные ссылки
