«Применение CQRS к Spring REST API»

«1. Обзор

В этой быстрой статье мы собираемся сделать что-то новое. Мы собираемся развить существующий API REST Spring и заставить его использовать разделение ответственности команд и запросов — CQRS.

Цель состоит в том, чтобы четко разделить уровни службы и контроллера, чтобы иметь возможность отдельно обрабатывать операции чтения, запросы и записи, то есть команды, поступающие в систему.

Имейте в виду, что это всего лишь первый шаг к такой архитектуре, а не «точка прибытия». При этом – я в восторге от этого.

Наконец — пример API, который мы собираемся использовать, — это публикация пользовательских ресурсов, и он является частью нашего текущего тематического исследования приложения Reddit, чтобы проиллюстрировать, как это работает — но, конечно, подойдет любой API.

2. Сервисный уровень

Мы начнем с простого — просто идентифицируем операции чтения и записи в нашей предыдущей пользовательской службе — и разделим ее на 2 отдельные службы — UserQueryService. и UserCommandService:

public interface IUserQueryService {

    List<User> getUsersList(int page, int size, String sortDir, String sort);

    String checkPasswordResetToken(long userId, String token);

    String checkConfirmRegistrationToken(String token);

    long countAllUsers();

}

public interface IUserCommandService {

    void registerNewUser(String username, String email, String password, String appUrl);

    void updateUserPassword(User user, String password, String oldPassword);

    void changeUserPassword(User user, String password);

    void resetPassword(String email, String appUrl);

    void createVerificationTokenForUser(User user, String token);

    void updateUser(User user);

}

Читая этот API, вы можете ясно видеть, что служба запросов выполняет все операции чтения, а служба команд не считывает никаких данных — все возвращается void.

3. Уровень контроллера

Далее — уровень контроллера.

3.1. Контроллер запросов

@Controller
@RequestMapping(value = "/api/users")
public class UserQueryRestController {

    @Autowired
    private IUserQueryService userService;

    @Autowired
    private IScheduledPostQueryService scheduledPostService;

    @Autowired
    private ModelMapper modelMapper;

    @PreAuthorize("hasRole('USER_READ_PRIVILEGE')")
    @RequestMapping(method = RequestMethod.GET)
    @ResponseBody
    public List<UserQueryDto> getUsersList(...) {
        PagingInfo pagingInfo = new PagingInfo(page, size, userService.countAllUsers());
        response.addHeader("PAGING_INFO", pagingInfo.toString());
        
        List<User> users = userService.getUsersList(page, size, sortDir, sort);
        return users.stream().map(
          user -> convertUserEntityToDto(user)).collect(Collectors.toList());
    }

    private UserQueryDto convertUserEntityToDto(User user) {
        UserQueryDto dto = modelMapper.map(user, UserQueryDto.class);
        dto.setScheduledPostsCount(scheduledPostService.countScheduledPostsByUser(user));
        return dto;
    }
}

Вот наш UserQueryRestController:

Здесь интересно то, что контроллер запросов только внедряет сервисы запросов.

Еще интереснее было бы отрезать этому контроллеру доступ к службам команд, поместив их в отдельный модуль.

3.2. Командный контроллер

@Controller
@RequestMapping(value = "/api/users")
public class UserCommandRestController {

    @Autowired
    private IUserCommandService userService;

    @Autowired
    private ModelMapper modelMapper;

    @RequestMapping(value = "/registration", method = RequestMethod.POST)
    @ResponseStatus(HttpStatus.OK)
    public void register(
      HttpServletRequest request, @RequestBody UserRegisterCommandDto userDto) {
        String appUrl = request.getRequestURL().toString().replace(request.getRequestURI(), "");
        
        userService.registerNewUser(
          userDto.getUsername(), userDto.getEmail(), userDto.getPassword(), appUrl);
    }

    @PreAuthorize("isAuthenticated()")
    @RequestMapping(value = "/password", method = RequestMethod.PUT)
    @ResponseStatus(HttpStatus.OK)
    public void updateUserPassword(@RequestBody UserUpdatePasswordCommandDto userDto) {
        userService.updateUserPassword(
          getCurrentUser(), userDto.getPassword(), userDto.getOldPassword());
    }

    @RequestMapping(value = "/passwordReset", method = RequestMethod.POST)
    @ResponseStatus(HttpStatus.OK)
    public void createAResetPassword(
      HttpServletRequest request, 
      @RequestBody UserTriggerResetPasswordCommandDto userDto) 
    {
        String appUrl = request.getRequestURL().toString().replace(request.getRequestURI(), "");
        userService.resetPassword(userDto.getEmail(), appUrl);
    }

    @RequestMapping(value = "/password", method = RequestMethod.POST)
    @ResponseStatus(HttpStatus.OK)
    public void changeUserPassword(@RequestBody UserchangePasswordCommandDto userDto) {
        userService.changeUserPassword(getCurrentUser(), userDto.getPassword());
    }

    @PreAuthorize("hasRole('USER_WRITE_PRIVILEGE')")
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    @ResponseStatus(HttpStatus.OK)
    public void updateUser(@RequestBody UserUpdateCommandDto userDto) {
        userService.updateUser(convertToEntity(userDto));
    }

    private User convertToEntity(UserUpdateCommandDto userDto) {
        return modelMapper.map(userDto, User.class);
    }
}

А вот реализация нашего командного контроллера:

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

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

3.3. Отдельные представления ресурсов

public class UserQueryDto {
    private Long id;

    private String username;

    private boolean enabled;

    private Set<Role> roles;

    private long scheduledPostsCount;
}

Давайте теперь быстро рассмотрим различные представления нашего ресурса User после разделения на команды и запросы:

Вот наши DTO команд:

public class UserRegisterCommandDto {
    private String username;
    private String email;
    private String password;
}

UserRegisterCommandDto, используемые для представления данных регистрации пользователя:

public class UserUpdatePasswordCommandDto {
    private String oldPassword;
    private String password;
}

UserUpdatePasswordCommandDto используется для представления данных для обновления текущего пароля пользователя:

public class UserTriggerResetPasswordCommandDto {
    private String email;
}

UserTriggerResetPasswordCommandDto используется для представления электронной почты пользователя для запуска сброса пароля путем отправки электронного письма с токеном сброса пароля:

public class UserChangePasswordCommandDto {
    private String password;
}

UserChangePasswordCommandDto используется для представления нового пароля пользователя — эта команда вызывается после того, как пользователь использует токен сброса пароля.

public class UserUpdateCommandDto {
    private Long id;

    private boolean enabled;

    private Set<Role> roles;
}

UserUpdateCommandDto используется для представления данных нового пользователя после изменений:

4. Заключение

В этом руководстве мы заложили основу для чистой реализации CQRS для Spring REST API.