#SingleRecordResource

Resource hướng đến bản ghi đơn: dữ liệu là object đơn, hỗ trợ get theo primary key, tạo/cập nhật (save) và xóa. Phù hợp với các kịch bản "bản ghi đơn" như chi tiết, form. Khác với MultiRecordResource, getData() của SingleRecordResource trả về object đơn, chỉ định primary key qua setFilterByTk(id), save() sẽ tự động gọi create hoặc update dựa trên isNewRecord.

Quan hệ kế thừa: FlowResource → APIResource → BaseRecordResource → SingleRecordResource.

Cách tạo: ctx.makeResource('SingleRecordResource') hoặc ctx.initResource('SingleRecordResource'). Trước khi sử dụng cần setResourceName('tên collection'); khi thao tác theo primary key cần setFilterByTk(id); trong RunJS, ctx.api được inject bởi môi trường runtime.

#Kịch bản áp dụng

#Định dạng dữ liệu

• getData() trả về object bản ghi đơn, tức là trường data của API get
• getMeta() trả về metadata (nếu có)

#Tên resource và primary key

#Trạng thái

#Tham số request (filter / field)

#CRUD

#Cấu hình và sự kiện

#Ví dụ

#Get và update cơ bản

ctx.initResource('SingleRecordResource');
ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
await ctx.resource.refresh();
const user = ctx.resource.getData();

// 更新
await ctx.resource.save({ name: '李四' });

#Tạo bản ghi mới

const newRes = ctx.makeResource('SingleRecordResource');
newRes.setResourceName('users');
await newRes.save({ name: '王五', email: 'wangwu@example.com' });

#Xóa bản ghi

ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
await ctx.resource.destroy();
// destroy 后 getData() 为 null

#Mở rộng quan hệ và field

ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
ctx.resource.setFields(['id', 'nickname', 'email']);
ctx.resource.setAppends(['profile', 'roles']);
await ctx.resource.refresh();
const user = ctx.resource.getData();

#Resource quan hệ (như users.profile)

const res = ctx.makeResource('SingleRecordResource');
res.setResourceName('users.profile');
res.setSourceId(ctx.record?.id); // 父记录主键
res.setFilterByTk(profileId);    // 若 profile 为 hasOne 可省略 filterByTk
await res.refresh();
const profile = res.getData();

#save không tự động refresh

await ctx.resource.save({ status: 'active' }, { refresh: false });
// 保存后不触发 refresh，getData() 保持旧值

#Lắng nghe sự kiện refresh / saved

ctx.resource?.on?.('refresh', () => {
  const data = ctx.resource.getData();
  ctx.render(<div>用户: {data?.nickname}</div>);
});
ctx.resource?.on?.('saved', (savedData) => {
  ctx.message.success('保存成功');
});
await ctx.resource?.refresh?.();

#Lưu ý

• setResourceName bắt buộc: Trước khi sử dụng phải gọi setResourceName('tên collection'), nếu không sẽ không thể xây dựng URL request.
• filterByTk và isNewRecord: Khi chưa đặt setFilterByTk, isNewRecord là true, refresh() sẽ không gửi request; save() sẽ đi qua create.
• Resource quan hệ: Khi tên resource là parent.child (như users.profile), cần setSourceId(primary key bản ghi cha) trước.
• getData là object: data được trả về bởi API đơn là object bản ghi, getData() trả về trực tiếp object đó; sau destroy() là null.

#Liên quan

• ctx.resource - Instance resource trong ngữ cảnh hiện tại
• ctx.initResource() - Khởi tạo và bind vào ctx.resource
• ctx.makeResource() - Tạo instance resource mới, không bind
• APIResource - Resource API thông dụng, request theo URL
• MultiRecordResource - Hướng đến collection/list, hỗ trợ CRUD, phân trang