将CQRS应用于Spring REST API

codingman included in REST Spring Java

2018-10-04 1225 words 3 minutes

Contents

1. 概述

在这篇快速文章中，我们将做一些新的事情。我们将改进现有的 REST Spring API 并使其使用命令查询职责分离 - CQRS 。

目标是明确区分服务层和控制器层，以分别处理进入系统的读取 - 查询和写入 - 命令。

请记住，这只是迈向这种架构的早期第一步，而不是“到达点”。话虽这么说——我对这个很兴奋。

最后——我们将要使用的示例 API 是发布User资源，并且是我们正在进行的Reddit 应用案例研究的一部分，以举例说明这是如何工作的——当然，任何 API 都可以。

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. 查询控制器

这是我们的UserQueryRestController：

@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;
    }
}

这里有趣的是查询控制器只是注入查询服务。

更有趣的是切断这个控制器对命令服务的访问——通过将它们放在一个单独的模块中。

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;
}

以下是我们的命令 DTO：

UserRegisterCommandDto用来表示用户注册数据：

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

UserUpdatePasswordCommandDto用于表示更新当前用户密码的数据：

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

UserTriggerResetPasswordCommandDto用于表示用户的电子邮件以通过发送带有重置密码令牌的电子邮件来触发重置密码：

public class UserTriggerResetPasswordCommandDto {
    private String email;
}

UserChangePasswordCommandDto用于表示新的用户密码——在用户使用密码重置令牌后调用此命令。

public class UserChangePasswordCommandDto {
    private String password;
}

UserUpdateCommandDto用于表示修改后的新用户数据：

public class UserUpdateCommandDto {
    private Long id;
    private boolean enabled;
    private Set<Role> roles;
}