Шаблон CQRS и NestJS (Node.js)

@QueryHandler(ListUsersQuery)
export class ListHandler implements IQueryHandler<ListUsersQuery> {
  constructor(
    // Here we would inject what is necessary to retrieve our data
  ) { }
  public async execute(query: ListUsersQuery): Promise<User[]> {
    // Here we are going to have any necessary logic related
    // to that Query and return the requested information
    // such as a service method call
  }
}

Итак, вот как будет выглядеть наш ListUsersQuery:

export class ListQuery {
  constructor(
    public page: number = 1,
    public pageSize: number = 10
  ) { }
}
@QueryHandler(ListUsersQuery)
export class ListHandler implements IQueryHandler<ListUsersQuery> {
  constructor(
    // Here we would inject what is necessary to retrieve our data
  ) { }
  public async execute(query: ListUsersQuery): Promise<User[]> {
    // Here we are going to have any necessary logic related
    // to that Query and return the request information
    // such as a service method call
  }
}

А ниже показано, как будет выглядеть другой наш запрос, GetUserById, ; теперь добавляем пример кода доступ к репозиторию с помощью TypeORM для извлечения данных.

// All we need is the id of the user we want to retrieve the data
export class GetUserByIdQuery {
  constructor(
    public id: number
  ) { }
}
@QueryHandler(GetUserByIdQuery)
export class GetUserByIdHandler implements
  IQueryHandler<GetUserByIdQuery> {
  // We inject our TypeORM repository to fetch the user data
  constructor(
    @InjectRepository(User)
    private readonly _repository: Repository<User>
  ) { }
  public async execute(query: GetUserByIdQuery): Promise<User> {
    // We fetch user data and return it on the execute method       
    return await this._repository.findOne(query.id);
  }
}

Команды

Давайте создадим наш AddUserCommand шаг за шагом в качестве примера.
Все это очень похоже на то, как мы создавали наши запросы.
Сначала мы определяем class в качестве нашей Command, который будет содержать информацию, необходимую его Handler. Здесь нам потребуется добавить новую информацию о пользователе.

export class AddUserCommand {
  constructor(
    public name: string,
    public email: string,
    public birthdate: Date
  ) { }
}

Затем мы создаем наш Handler, который будет запускаться, когда эта Command вызывается в CommandBus.

CommandBus - это поток команд. По запросу он делегирует команды своим эквивалентным обработчикам. У каждой команды должен быть соответствующий обработчик. Эта ассоциация достигается с помощью декоратора @CommandHandler.

@CommandHandler(AddUserCommand)
export class AddUserHandler implements IQueryHandler<AddUserCommand> {}

Теперь мы создали AddUserHandler, который будет обрабатывать команду AddUserCommand, которую мы создали ранее. Позже мы увидим, как эта Command может быть вызвана с помощью CommandBus.

@CommandHandler(AddUserCommand)
export class AddUserHandler implements IQueryHandler<AddUserCommand> {
    constructor(
      // Here we would inject what is necessary to persist our data
    ) { }
    public async execute(query: ListUsersQuery): Promise<User> {
      // Here we are going to have any necessary logic related
      // to that Command and do any change operations
    }
}

Итак, вот как будет выглядеть наш AddUserCommand:

export class AddUserCommand {
  constructor(
    public name: string,
    public email: string,
    public birthdate: Date
  ) { }
}
@CommandHandler(AddUserCommand)
export class AddUserHandler implements IQueryHandler<AddUserCommand> {
    constructor(
      // Here we would inject what is necessary to persist our data
    ) { }
    public async execute(query: ListUsersQuery): Promise<User> {
      // Here we are going to have any necessary logic related
      // to that Command and do any change operations
    }
}

А ниже показано, как будут выглядеть другие наши Commands, UpdateUser и DeleteUser,, теперь добавляем пример кода для доступа к репозиторию с использованием TypeORM для внесения изменений в базу данных .

UpdateUserCommand

export class UpdateUserCommand {
  constructor(
    public id: number,
    public name?: string,
    public email?: string,
    public birthdate?: Date
  ) { }
}
@CommandHandler(UpdateUserCommand)
export class UpdateUserHandler implements IQueryHandler<UpdateUserCommand>
{
    constructor(
      @InjectRepository(User)
      private readonly _repository: Repository<User>
    ) { }
    public async execute(request: UpdateUserCommand): Promise<User>
    {
      const user = await this._repository.findOne(request.id);
      if (!user)
        throw new NotFoundException('User does not exist');
      user.name = request.name || user.name;
      user.email = request.email || user.email;
      user.birthdate = request.birthdate|| user.birthdate;
      return await this._repository.save( user );
    }
}

DeleteUserCommand

export class DeleteUserCommand {
  constructor(
    public id: number
  ) { }
}
@CommandHandler(DeleteUserCommand)
export class DeleteUserHandler implements IQueryHandler<DeleteUserCommand>
{
    constructor(
      @InjectRepository(User)
      private readonly _repository: Repository<User>
    ) { }
    public async execute(request: DeleteUserCommand):
      Promise<DeleteResult>
    {
      return await this._repository.delete({
        'id': request.id
      });
    }
}

Контроллер

Теперь, когда у нас созданы наши запросы и команды, нам нужно собрать все это воедино и создать наш UserController для конечных точек User CRUD.

Прежде всего, мы создаем наш класс UserController, используя декоратор @Controller и указав префикс маршрута 'user' для нашего контроллера. Затем мы предоставляем ему QueryBus и CommandBus в конструкторе.

@Controller('user')
export class UserController {
  constructor(
    private readonly commandBus: CommandBus,
    private readonly queryBus: QueryBus
  ) { }
}

Теперь мы можем создавать наши конечные точки, которые будут вызывать QueryBus и CommandBus соответственно.

@Controller('user')
export class UserController {
  constructor(
    private readonly commandBus: CommandBus,
    private readonly queryBus: QueryBus
  ) { }
  @Get()
  public async getAllOngs(
    @Query() request: ListUsersQuery,
    @Res() response
  ) {
  
    const users = await this.queryBus.execute(
      new ListUsersQuery(
        request.page,
        request.pageSize
      )
    );
    response.status(HttpStatus.OK).json(users);
  }
}

Мы определили декораторы @Get, @Post, @Put и @Delete, чтобы указать желаемый метод HTTP-запроса. Кроме того, мы использовали декоратор @Query для получения параметров запроса из запроса, декоратор @Param для получения маршрута Params из запроса и декоратор @Body для получения тела запроса.

Затем все, что нам нужно было сделать, это вызвать QueryBus или CommandBus в соответствии с целью конечной точки, вызвав ее метод execute, предоставив желаемый запрос или команду и передачу необходимой информации. С результатом операции мы можем затем вернуть ответ с результатом операции и любыми необходимыми данными. Готово!

Модуль

Теперь все, что осталось сделать, это зарегистрировать все это в UserModule. Сначала мы создаем индексный файл для команд и еще один для запросов. Это упростит его визуализацию и предоставление в модуле. Файлы index будут выглядеть следующим образом:

// commands > _index.ts
export const CommandHandlers = [
  AddUserHandler,
  UpdateUserHandler,
  DeleteUserHandler
];
// queries > _index.ts
export const QueryHandlers = [
  ListHandler,
  GetUserByIdHandler
];

Теперь мы можем создать наш UserModule, объявить наш UserController и предоставить наши запросы и команды. Затем мы импортируем его в наш AppModule, и все готово!

@Module({
  imports: [
    CqrsModule,
    ...
    // Here might be included other Modules, such as
    // the TypeOrmModule
  ],
  controllers: [
    UserController
  ],
  providers: [
    ...QueryHandlers,
    ...CommandHandlers
  ]
})
export class UserModule { }

Поиск событий и CQRS

Некоторые реализации CQRS используют паттерн Event Sourcing. При использовании этого шаблона состояние приложения сохраняется как последовательность событий, в которой каждое событие представляет набор изменений данных. Используя поток событий, он предотвращает конфликты обновлений и максимизирует производительность и масштабируемость. Тем не менее, Event Sourcing добавляет даже большей сложности к дизайну приложения, который и без того сложен в этом шаблоне.

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

Шаблоны проектирования, такие как CQRS, при правильном применении могут помочь нам писать и поддерживать качественный код в наших приложениях. Это очень полезный и используемый шаблон, основы которого важно знать. Кроме того, как мы уже выяснили, NestJS упрощает реализацию такого шаблона, позволяя создавать масштабируемые и эффективные приложения.

Надеюсь, это поможет! 😉

Использованная литература: