如何为各租户独立Schema的多租户Spring应用调度任务

在多租户场景下，定时任务无法通过请求头传递租户标识，核心思路是主动遍历所有租户，手动切换租户上下文，再执行对应租户的业务逻辑。以下是具体实现步骤：

1. 提前准备：获取所有租户标识 #

首先需要从公共租户管理库（或专门的租户配置表）中获取所有有效的租户ID列表。假设你已经有一个TenantService负责租户管理：

@Service
public class TenantService {
    private final TenantRepository tenantRepository;

    public TenantService(TenantRepository tenantRepository) {
        this.tenantRepository = tenantRepository;
    }

    public List<String> getAllValidTenantIds() {
        // 查询所有状态正常的租户ID
        return tenantRepository.findAllByStatusActive().stream()
                .map(Tenant::getTenantId)
                .collect(Collectors.toList());
    }
}

2. 编写租户遍历式定时任务 #

使用Spring的@Scheduled注解创建定时任务，遍历每个租户ID，手动设置TenantContext，执行业务逻辑后立即清除上下文，避免线程污染：

@Component
@Slf4j
public class TenantScheduledTasks {
    private final TenantService tenantService;
    private final UserPasswordService userPasswordService;
    private final NotificationService notificationService;

    public TenantScheduledTasks(TenantService tenantService,
                                UserPasswordService userPasswordService,
                                NotificationService notificationService) {
        this.tenantService = tenantService;
        this.userPasswordService = userPasswordService;
        this.notificationService = notificationService;
    }

    // 每天凌晨1点执行密码过期检查任务
    @Scheduled(cron = "0 0 1 * * ?")
    public void checkTenantPasswordExpiry() {
        List<String> tenantIds = tenantService.getAllValidTenantIds();
        
        for (String tenantId : tenantIds) {
            try {
                // 手动设置租户上下文
                TenantContext.setTenantId(tenantId);
                
                // 执行当前租户的密码检查逻辑
                List<User> expiredUsers = userPasswordService.getExpiredPasswordUsers();
                for (User user : expiredUsers) {
                    // 更新密码过期状态
                    userPasswordService.markPasswordExpired(user.getId());
                    // 发送通知
                    notificationService.sendPasswordExpiryAlert(user.getEmail());
                }
                
                log.info("Password expiry check completed for tenant: {}", tenantId);
            } catch (Exception e) {
                // 单个租户任务失败不影响其他租户
                log.error("Failed to process password expiry check for tenant: {}", tenantId, e);
            } finally {
                // 必须清除租户上下文，防止线程复用导致的上下文污染
                TenantContext.clearTenantId();
            }
        }
    }
}

3. 确保TenantContext的线程安全 #

你的TenantContext需要基于ThreadLocal实现，保证每个线程的租户标识独立：

public class TenantContext {
    private static final ThreadLocal<String> CURRENT_TENANT = new ThreadLocal<>();

    public static void setTenantId(String tenantId) {
        CURRENT_TENANT.set(tenantId);
    }

    public static String getTenantId() {
        return CURRENT_TENANT.get();
    }

    public static void clearTenantId() {
        CURRENT_TENANT.remove();
    }
}

4. 关键注意事项 #

• 线程隔离：必须在finally块中清除TenantContext，因为Spring的定时任务线程池是复用的，残留的租户ID会导致后续任务路由到错误的Schema。
• 事务独立：每个租户的业务操作（如更新密码状态）要单独开启事务，避免跨租户的事务影响。可以在userPasswordService的方法上添加@Transactional注解。
• 性能优化：如果租户数量较多，可将单个租户的任务异步化（比如用@Async），避免单次定时任务执行时间过长。
• 日志追踪：所有租户相关的日志都要带上tenantId，方便后续排查问题。

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