Spring Boot 3.3.0：非Web环境下如何初始化JdbcIndexedSessionRepository

问题背景 #

我们有两个Spring Boot 3.3.0应用：

• Web应用：N个实例，原本依赖spring.session.jdbc.cleanup-cron执行Session清理定时任务
• 调度应用：单实例，配置spring.main.web-application-type=none，与Web应用连接同一数据库

将清理任务移至调度应用后，发现JdbcIndexedSessionRepository无法自动创建——原因是Spring Session的SessionAutoConfiguration带有@ConditionalOnWebApplication注解，仅在Web环境下生效。当前临时方案是添加spring-boot-starter-web依赖并关闭懒加载，但这会引入不必要的Web组件。

可行解决方案：手动配置Session相关Bean #

不需要引入Web依赖，通过手动注册JdbcIndexedSessionRepository及配套组件，即可在非Web环境下启用JDBC Session存储及清理任务。

步骤1：编写自定义配置类 #

创建配置类手动初始化所需Bean：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.core.JdbcOperations;
import org.springframework.session.SessionProperties;
import org.springframework.session.jdbc.JdbcIndexedSessionRepository;
import org.springframework.session.jdbc.SessionCleanupTask;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.support.TransactionTemplate;

@Configuration
public class SessionRepositoryConfig {

    // 初始化JdbcIndexedSessionRepository
    @Bean
    public JdbcIndexedSessionRepository jdbcIndexedSessionRepository(
            JdbcOperations jdbcOperations,
            TransactionTemplate transactionTemplate,
            SessionProperties sessionProperties) {
        JdbcIndexedSessionRepository repository = new JdbcIndexedSessionRepository(jdbcOperations, transactionTemplate);
        // 设置Session默认超时时间（读取配置文件的spring.session.timeout）
        repository.setDefaultMaxInactiveInterval((int) sessionProperties.getTimeout().toSeconds());
        // 若需自定义表前缀，可取消注释
        // repository.setTableNamePrefix("SPRING_SESSION_");
        return repository;
    }

    // 提供事务模板，JdbcIndexedSessionRepository依赖此组件
    @Bean
    public TransactionTemplate transactionTemplate(PlatformTransactionManager transactionManager) {
        return new TransactionTemplate(transactionManager);
    }

    // 注册Session清理定时任务
    @Bean
    public SessionCleanupTask sessionCleanupTask(JdbcIndexedSessionRepository sessionRepository) {
        SessionCleanupTask cleanupTask = new SessionCleanupTask();
        cleanupTask.setSessionRepository(sessionRepository);
        return cleanupTask;
    }
}

步骤2：调整依赖与配置 #

• 移除不必要的依赖：删除调度应用build.gradle中的spring-boot-starter-web依赖，仅保留spring-session-jdbc及数据库相关依赖：

implementation("org.springframework.session:spring-session-jdbc")
// 保留数据库驱动、JDBC Starter等已有依赖

• 调整应用配置：在application.properties中保留Session配置，移除spring.main.lazy-initialization=false（若不需要全局关闭懒加载）：

spring.main.web-application-type=none
spring.session.store-type=jdbc
spring.session.timeout=24h
spring.session.jdbc.initialize-schema=never
# 配置清理任务执行周期，与原Web应用保持一致
spring.session.jdbc.cleanup-cron=0 * * * * ?

步骤3：启用定时任务 #

确保调度应用的启动类添加@EnableScheduling注解，让Spring能够识别并执行SessionCleanupTask定时任务：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class SchedulerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerApplication.class, args);
    }
}

方案优势 #

• 无需引入Web组件，保持应用为纯非Web调度服务，减少资源占用
• 无需全局关闭懒加载，若有其他组件需要懒加载可正常配置
• 完全复用Spring Session的原生清理逻辑，与原Web应用的行为一致

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