ShedLock中assertLocked方法失效问题分析与解决方案

问题背景

在使用ShedLock框架进行分布式任务锁定时，开发者可能会遇到一个常见问题：在带有@SchedulerLock注解的定时任务方法中调用LockAssert.assertLocked()方法时，会抛出IllegalStateException: The task is not locked异常。这个问题在不同版本的Spring Boot和ShedLock组合下表现不同，值得深入分析。

问题现象

当开发者编写如下代码时：

@Scheduled(...)
@SchedulerLock(name = "scheduledTaskName")
public void scheduledTask() {
   LockAssert.assertLocked();
   // 业务逻辑
}

在某些环境下会抛出异常，表明任务没有被正确锁定。这个问题在ShedLock 5.16.0与Spring Boot 3.4.0组合时出现，但通过以下任一方式可以解决：

1. 降级Spring Boot到3.3.5版本
2. 升级ShedLock到6.0.2版本

根本原因分析

这个问题与ShedLock的拦截模式(interceptMode)配置密切相关。ShedLock提供了两种拦截模式：

1. PROXY_SCHEDULER模式：通过代理Spring的调度器来实现锁定
2. PROXY_METHOD模式：直接代理被注解的方法

在PROXY_SCHEDULER模式下，锁定的上下文可能无法正确传播到LockAssert.assertLocked()调用点，特别是在测试环境中。这是因为：

• 测试环境下直接调用方法绕过了Spring的调度器代理
• 不同版本的Spring Boot对AOP代理的处理方式有细微差异
• ShedLock内部对锁状态的跟踪机制在不同版本间有所变化

解决方案

方案一：修改拦截模式

将配置改为使用PROXY_METHOD模式：

@Configuration
@EnableScheduling
@EnableSchedulerLock(interceptMode = PROXY_METHOD, defaultLockAtMostFor = "2h")
class SchedulerConfig {
    // LockProvider配置
}

这种模式能确保：

• 方法调用被直接代理
• 锁状态能正确传播
• 在测试和运行时行为一致

方案二：版本组合调整

根据实际环境选择以下版本组合之一：

1. ShedLock 5.x + Spring Boot ≤3.3.5
2. ShedLock ≥6.0.2 + Spring Boot ≥3.4.0

方案三：测试环境特殊处理

对于测试环境，可以：

1. 使用Mockito等工具模拟锁定状态
2. 在测试前手动设置锁状态：

@Test
public void testTaskExecution() {
    try {
        LockAssert.startLock();
        myJob.scheduledTask();
    } finally {
        LockAssert.endLock();
    }
}

最佳实践建议

1. 明确拦截模式：根据项目需求明确选择PROXY_SCHEDULER或PROXY_METHOD
2. 版本一致性：保持ShedLock和Spring Boot版本的兼容性
3. 测试策略：
   • 对于锁定的测试，考虑使用集成测试而非单元测试
   • 或者专门测试锁定逻辑与非锁定业务逻辑分离
4. 日志监控：添加适当的日志输出，帮助诊断锁定状态

总结

ShedLock的assertLocked方法失效问题通常源于拦截模式配置不当或版本不兼容。通过理解ShedLock的工作原理和不同拦截模式的特点，开发者可以有效地解决这一问题。PROXY_METHOD模式通常能提供更可靠的行为，特别是在测试环境中，是推荐的配置方式。