如何实现Keycloak用户注册的事务回滚机制？

问题核心 #

Spring的@Transactional仅能管理本地数据库事务，Keycloak作为独立外部服务，无法被Spring事务自动纳入管理。因此需要通过手动补偿机制实现事务一致性：当流程中任意步骤抛出异常时，主动回滚已完成的外部操作（如Keycloak中创建的用户），同时依赖Spring事务回滚本地数据库操作。

具体实现步骤 #

1. 新增Keycloak用户删除方法

在KeycloakService中添加删除用户的方法，用于异常触发时的回滚操作：

public void deleteKeycloakUser(String userId) {
    try {
        var realmResource = getRealmResource();
        realmResource.users().get(userId).remove();
        log.info("已回滚Keycloak中创建的用户，ID: {}", userId);
    } catch (Exception e) {
        log.error("删除Keycloak用户失败，ID: {}", userId, e);
        // 可根据业务需求选择抛出异常或记录告警
    }
}

2. 修改注册方法，实现补偿事务

调整register方法的异常处理逻辑，用try-catch包裹所有核心操作，异常时执行回滚：

@Transactional(rollbackOn = {BadRequestException.class, UserAlreadyExistedException.class, RuntimeException.class})
public Response register(UserDTO userDTO, Tenant tenant, Channel channel) {
    String userId = null;
    try {
        String username = userDTO.getFirstName() + "_" + userDTO.getLastName() + Helper.generateCode();
        userDTO.setUserName(username.toLowerCase());
        String phone = userDTO.getCountryCode() + Helper.removeLeadingZeros(userDTO.getPhone());
        List<Role> roles = List.of(Role.valueOf(tenant.getTenant().toUpperCase()), Role.valueOf(tenant.getType().toUpperCase()));
        
        // 创建Keycloak用户
        var response = keycloakService.createKeycloakUser(userDTO, roles, Collections.singletonMap("gsm", List.of(phone)));
        userId = CreatedResponseUtil.getCreatedId(response);

        // 存储到本地数据库
        UserLoginData sys_user = loginDataMapper.toEntity(userDTO);
        sys_user.setKeycloakId(UUID.fromString(Objects.requireNonNull(userId)));
        sys_user.setPhone(phone);
        userLoginService.saveAndPublishEvent(sys_user);
        log.info("新用户已添加到本地系统数据库");

        // 发送验证消息
        if (channel != Channel.none) {
            if (channel == Channel.phone) {
                twilioService.sendOTP(phone);
            } else {
                sendVerificationMail(userDTO.getEmailId());
            }
        }

        return response;
    } catch (Exception e) {
        // 回滚Keycloak用户（如果已创建）
        if (userId != null) {
            keycloakService.deleteKeycloakUser(userId);
        }
        log.error("注册流程失败，已执行回滚操作", e);
        // 抛出异常触发Spring事务回滚本地数据库操作
        throw e;
    }
}

3. 关键注意事项

• 异常覆盖范围：调整@Transactional的rollbackOn属性，确保所有可能导致流程失败的异常都能触发本地事务回滚，包括自定义异常和运行时异常。
• 幂等性保障：如果注册请求可能重试，需确保createKeycloakUser中的手机号校验逻辑是幂等的，避免重复创建用户。
• 异常日志记录：回滚操作失败时需记录详细日志，便于后续人工排查和修复数据不一致问题。
• 事件处理：如果saveAndPublishEvent包含消息队列发送逻辑，需考虑事件的幂等性或可补偿性（比如注册失败时撤回已发送的事件）。

内容的提问来源于stack exchange，提问作者kikicoder