#ResourceManager Quản lý tài nguyên

Tính năng quản lý tài nguyên của NocoBase có thể tự động chuyển đổi các bảng dữ liệu (bộ sưu tập) và các liên kết (association) hiện có thành tài nguyên. NocoBase cũng tích hợp sẵn nhiều loại thao tác, giúp nhà phát triển nhanh chóng xây dựng các thao tác tài nguyên REST API. Khác một chút so với REST API truyền thống, các thao tác tài nguyên của NocoBase không phụ thuộc vào phương thức yêu cầu HTTP mà xác định thao tác cụ thể cần thực hiện thông qua việc định nghĩa :action một cách rõ ràng.

#Tự động tạo tài nguyên

NocoBase sẽ tự động chuyển đổi các bộ sưu tập và association được định nghĩa trong cơ sở dữ liệu thành tài nguyên. Ví dụ, khi định nghĩa hai bộ sưu tập là posts và tags:

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

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

Điều này sẽ tự động tạo ra các tài nguyên sau:

• Tài nguyên posts
• Tài nguyên tags
• Tài nguyên liên kết posts.tags

Ví dụ yêu cầu:

#Các thao tác tài nguyên

NocoBase cung cấp nhiều loại thao tác tích hợp sẵn phong phú để đáp ứng các nhu cầu kinh doanh khác nhau.

#Các thao tác CRUD cơ bản

#Các thao tác liên kết

#Các tham số thao tác

Các tham số thao tác phổ biến bao gồm:

• filter: Điều kiện truy vấn
• values: Các giá trị cần đặt
• fields: Chỉ định các trường trả về
• appends: Bao gồm dữ liệu liên kết
• except: Loại trừ các trường
• sort: Quy tắc sắp xếp
• page, pageSize: Tham số phân trang
• paginate: Có bật phân trang hay không
• tree: Có trả về cấu trúc dạng cây hay không
• whitelist, blacklist: Danh sách trắng/đen các trường
• updateAssociationValues: Có cập nhật giá trị liên kết hay không

#Các thao tác tài nguyên tùy chỉnh

NocoBase cho phép đăng ký các thao tác bổ sung cho các tài nguyên hiện có. Bạn có thể sử dụng registerActionHandlers để tùy chỉnh các thao tác cho tất cả hoặc các tài nguyên cụ thể.

#Đăng ký thao tác toàn cục

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

#Đăng ký thao tác cho tài nguyên cụ thể

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

Ví dụ yêu cầu:

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

Quy tắc đặt tên: resourceName:actionName, sử dụng cú pháp dấu chấm (posts.comments) khi bao gồm các liên kết.

#Tài nguyên tùy chỉnh

Nếu bạn cần cung cấp các tài nguyên không liên quan đến các bộ sưu tập, bạn có thể sử dụng phương thức resourceManager.define để định nghĩa chúng:

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

Phương thức yêu cầu nhất quán với các tài nguyên được tạo tự động:

• GET /api/app:getInfo
• POST /api/app:getInfo (mặc định hỗ trợ cả GET/POST)

#Middleware tùy chỉnh

Sử dụng phương thức resourceManager.use() để đăng ký middleware toàn cục. Ví dụ:

Middleware ghi log toàn cục

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

#Các thuộc tính Context đặc biệt

Việc có thể truy cập vào middleware hoặc action của lớp resourceManager có nghĩa là tài nguyên đó chắc chắn tồn tại.

#ctx.action

• ctx.action.actionName: Tên thao tác
• ctx.action.resourceName: Có thể là một bộ sưu tập hoặc association
• ctx.action.params: Các tham số thao tác

#ctx.dataSource

Đối tượng nguồn dữ liệu hiện tại.

#ctx.getCurrentRepository()

Đối tượng repository hiện tại.

#Cách lấy đối tượng resourceManager cho các nguồn dữ liệu khác nhau

resourceManager thuộc về một nguồn dữ liệu và có thể đăng ký các thao tác riêng biệt cho từng nguồn dữ liệu khác nhau.

#Nguồn dữ liệu chính

Đối với nguồn dữ liệu chính, bạn có thể trực tiếp sử dụng app.resourceManager để thực hiện thao tác:

app.resourceManager.registerActionHandlers();

#Các nguồn dữ liệu khác

Đối với các nguồn dữ liệu khác, bạn có thể lấy một thể hiện nguồn dữ liệu cụ thể thông qua dataSourceManager và sử dụng resourceManager của thể hiện đó để thực hiện thao tác:

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

#Lặp qua tất cả các nguồn dữ liệu

Nếu bạn cần thực hiện các thao tác giống nhau trên tất cả các nguồn dữ liệu đã thêm, bạn có thể sử dụng phương thức dataSourceManager.afterAddDataSource để lặp qua, đảm bảo rằng resourceManager của mỗi nguồn dữ liệu đều có thể đăng ký các thao tác tương ứng:

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