#ResourceManager 리소스 관리

NocoBase의 리소스 관리 기능은 기존의 컬렉션(데이터 테이블)과 연관(association)을 자동으로 리소스로 변환하며, 다양한 내장 작업 유형을 제공하여 개발자가 REST API 리소스 작업을 빠르게 구축할 수 있도록 돕습니다. 기존 REST API와는 조금 다르게, NocoBase의 리소스 작업은 HTTP 요청 메서드에 의존하지 않고, 명시적인 :action 정의를 통해 실행할 특정 작업을 결정합니다.

#리소스 자동 생성

NocoBase는 데이터베이스에 정의된 컬렉션과 association을 자동으로 리소스로 변환합니다. 예를 들어, 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`);
});

#Context의 특수 속성

resourceManager 레이어의 미들웨어 또는 액션에 진입할 수 있다는 것은 해당 리소스가 반드시 존재한다는 것을 의미합니다.

#ctx.action

• ctx.action.actionName: 작업 이름
• ctx.action.resourceName: 컬렉션 또는 association일 수 있습니다.
• ctx.action.params: 작업 파라미터

#ctx.dataSource

현재 데이터 소스 객체입니다.

#ctx.getCurrentRepository()

현재 repository 객체입니다.

#다양한 데이터 소스의 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();
});