JDBC

Spring Session JDBC 是一个模块，它使用 JDBC 作为数据存储来实现会话管理。

将 Spring Session JDBC 添加到您的应用程序

要使用 Spring Session JDBC，您必须将 org.springframework.session:spring-session-jdbc 依赖添加到您的应用程序中

  • Gradle

  • Maven

implementation 'org.springframework.session:spring-session-jdbc'
<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-jdbc</artifactId>
</dependency>

如果您正在使用 Spring Boot，它将负责启用 Spring Session JDBC，更多详情请参阅其文档。否则，您需要在配置类中添加 @EnableJdbcHttpSession

  • Java

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {
    //...
}

就这样，您的应用程序现在应该已配置为使用 Spring Session JDBC。

理解会话存储详情

默认情况下，实现使用 SPRING_SESSION 和 SPRING_SESSION_ATTRIBUTES 表来存储会话。请注意，当您自定义表名时，用于存储属性的表将使用提供的表名并加上 _ATTRIBUTES 后缀命名。如果需要进一步自定义，您可以自定义仓库使用的 SQL 查询。

由于各种数据库供应商之间的差异，尤其是在存储二进制数据方面，请确保使用特定于您的数据库的 SQL 脚本。大多数主要数据库供应商的脚本打包在 org/springframework/session/jdbc/schema-*.sql 中，其中 * 是目标数据库类型。

例如，对于 PostgreSQL，您可以使用以下模式脚本

CREATE TABLE SPRING_SESSION (
	PRIMARY_ID CHAR(36) NOT NULL,
	SESSION_ID CHAR(36) NOT NULL,
	CREATION_TIME BIGINT NOT NULL,
	LAST_ACCESS_TIME BIGINT NOT NULL,
	MAX_INACTIVE_INTERVAL INT NOT NULL,
	EXPIRY_TIME BIGINT NOT NULL,
	PRINCIPAL_NAME VARCHAR(100),
	CONSTRAINT SPRING_SESSION_PK PRIMARY KEY (PRIMARY_ID)
);

CREATE UNIQUE INDEX SPRING_SESSION_IX1 ON SPRING_SESSION (SESSION_ID);
CREATE INDEX SPRING_SESSION_IX2 ON SPRING_SESSION (EXPIRY_TIME);
CREATE INDEX SPRING_SESSION_IX3 ON SPRING_SESSION (PRINCIPAL_NAME);

CREATE TABLE SPRING_SESSION_ATTRIBUTES (
	SESSION_PRIMARY_ID CHAR(36) NOT NULL,
	ATTRIBUTE_NAME VARCHAR(200) NOT NULL,
	ATTRIBUTE_BYTES BYTEA NOT NULL,
	CONSTRAINT SPRING_SESSION_ATTRIBUTES_PK PRIMARY KEY (SESSION_PRIMARY_ID, ATTRIBUTE_NAME),
	CONSTRAINT SPRING_SESSION_ATTRIBUTES_FK FOREIGN KEY (SESSION_PRIMARY_ID) REFERENCES SPRING_SESSION(PRIMARY_ID) ON DELETE CASCADE
);

自定义表名

要自定义数据库表名，您可以使用 @EnableJdbcHttpSession 注解的 tableName 属性

  • Java

@Configuration
@EnableJdbcHttpSession(tableName = "MY_TABLE_NAME")
public class SessionConfig {
    //...
}

另一种选择是将 SessionRepositoryCustomizer<JdbcIndexedSessionRepository> 的实现暴露为一个 bean，以直接在实现中更改表名

  • Java

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    @Bean
    public TableNameCustomizer tableNameCustomizer() {
        return new TableNameCustomizer();
    }

}

public class TableNameCustomizer
        implements SessionRepositoryCustomizer<JdbcIndexedSessionRepository> {

    @Override
    public void customize(JdbcIndexedSessionRepository sessionRepository) {
        sessionRepository.setTableName("MY_TABLE_NAME");
    }

}

自定义 SQL 查询

有时，能够自定义 Spring Session JDBC 执行的 SQL 查询会很有用。在某些场景下，数据库中的会话或其属性可能会发生并发修改，例如，一个请求可能尝试插入一个已存在的属性，导致重复键异常。因此，您可以应用特定于 RDBMS 的查询来处理这些场景。要自定义 Spring Session JDBC 对数据库执行的 SQL 查询，您可以使用 JdbcIndexedSessionRepository 的 set*Query 方法。

  • Java

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    @Bean
    public QueryCustomizer tableNameCustomizer() {
        return new QueryCustomizer();
    }

}

public class QueryCustomizer
        implements SessionRepositoryCustomizer<JdbcIndexedSessionRepository> {

    private static final String CREATE_SESSION_ATTRIBUTE_QUERY = """
            INSERT INTO %TABLE_NAME%_ATTRIBUTES (SESSION_PRIMARY_ID, ATTRIBUTE_NAME, ATTRIBUTE_BYTES) (1)
            VALUES (?, ?, ?)
            ON CONFLICT (SESSION_PRIMARY_ID, ATTRIBUTE_NAME)
            DO NOTHING
            """;

    private static final String UPDATE_SESSION_ATTRIBUTE_QUERY = """
		UPDATE %TABLE_NAME%_ATTRIBUTES
		SET ATTRIBUTE_BYTES = encode(?, 'escape')::jsonb
		WHERE SESSION_PRIMARY_ID = ?
		AND ATTRIBUTE_NAME = ?
		""";

    @Override
    public void customize(JdbcIndexedSessionRepository sessionRepository) {
        sessionRepository.setCreateSessionAttributeQuery(CREATE_SESSION_ATTRIBUTE_QUERY);
        sessionRepository.setUpdateSessionAttributeQuery(UPDATE_SESSION_ATTRIBUTE_QUERY);
    }

}
1 查询中的占位符 %TABLE_NAME% 将被 JdbcIndexedSessionRepository 使用的配置的表名替换。

Spring Session JDBC 提供了一些 SessionRepositoryCustomizer<JdbcIndexedSessionRepository> 的实现，它们为最常见的 RDBMS 配置了优化的 SQL 查询。

将会话属性保存为 JSON

默认情况下，Spring Session JDBC 将会话属性值保存为字节数组，该数组是属性值经过 JDK 序列化后的结果。

有时将会在话属性保存为不同的格式（例如 JSON）会很有用，因为 JSON 在 RDBMS 中可能具有原生支持，从而允许在 SQL 查询中使用更好的函数和运算符兼容性。

在此示例中，我们将使用 PostgreSQL 作为 RDBMS，并将使用 JSON 而不是 JDK 序列化来序列化会话属性值。首先，让我们创建 SPRING_SESSION_ATTRIBUTES 表，并为 attribute_values 列使用 jsonb 类型。

  • SQL

CREATE TABLE SPRING_SESSION
(
    -- ...
);

-- indexes...

CREATE TABLE SPRING_SESSION_ATTRIBUTES
(
    -- ...
    ATTRIBUTE_BYTES    JSONB        NOT NULL,
    -- ...
);

要自定义属性值的序列化方式，首先我们需要为 Spring Session JDBC 提供一个负责将 Object 转换为 byte[]，反之亦然的自定义 ConversionService。为此，我们可以创建一个名为 springSessionConversionService 的 ConversionService 类型的 bean。

  • Java

import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.core.serializer.support.DeserializingConverter;
import org.springframework.core.serializer.support.SerializingConverter;

@Configuration
@EnableJdbcHttpSession
public class SessionConfig implements BeanClassLoaderAware {

    private ClassLoader classLoader;

    @Bean("springSessionConversionService")
    public GenericConversionService springSessionConversionService(ObjectMapper objectMapper) { (1)
        ObjectMapper copy = objectMapper.copy(); (2)
        // Register Spring Security Jackson Modules
        copy.registerModules(SecurityJackson2Modules.getModules(this.classLoader)); (3)
        // Activate default typing explicitly if not using Spring Security
        // copy.activateDefaultTyping(copy.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
        GenericConversionService converter = new GenericConversionService();
        converter.addConverter(Object.class, byte[].class, new SerializingConverter(new JsonSerializer(copy))); (4)
        converter.addConverter(byte[].class, Object.class, new DeserializingConverter(new JsonDeserializer(copy))); (4)
        return converter;
    }

    @Override
    public void setBeanClassLoader(ClassLoader classLoader) {
        this.classLoader = classLoader;
    }

    static class JsonSerializer implements Serializer<Object> {

        private final ObjectMapper objectMapper;

        JsonSerializer(ObjectMapper objectMapper) {
            this.objectMapper = objectMapper;
        }

        @Override
        public void serialize(Object object, OutputStream outputStream) throws IOException {
            this.objectMapper.writeValue(outputStream, object);
        }

    }

    static class JsonDeserializer implements Deserializer<Object> {

        private final ObjectMapper objectMapper;

        JsonDeserializer(ObjectMapper objectMapper) {
            this.objectMapper = objectMapper;
        }

        @Override
        public Object deserialize(InputStream inputStream) throws IOException {
            return this.objectMapper.readValue(inputStream, Object.class);
        }

    }

}
1 注入应用程序中默认使用的 ObjectMapper。如果您愿意，也可以创建一个新的。
2 创建该 ObjectMapper 的副本，以便我们只将更改应用于副本。
3 由于我们使用 Spring Security，我们必须注册其 Jackson 模块，该模块告诉 Jackson 如何正确序列化/反序列化 Spring Security 的对象。您可能需要对存储在会话中的其他对象执行相同的操作。
4 将我们创建的 JsonSerializer/JsonDeserializer 添加到 ConversionService 中。

现在我们配置了 Spring Session JDBC 如何将属性值转换为 byte[]，我们必须自定义插入和更新会话属性的查询。自定义是必需的，因为 Spring Session JDBC 在 SQL 语句中将内容设置为字节，然而 bytea 与 jsonb 不兼容，因此我们需要将 bytea 值编码为文本，然后将其转换为 jsonb。

  • Java

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    private static final String CREATE_SESSION_ATTRIBUTE_QUERY = """
            INSERT INTO %TABLE_NAME%_ATTRIBUTES (SESSION_PRIMARY_ID, ATTRIBUTE_NAME, ATTRIBUTE_BYTES)
            VALUES (?, ?, encode(?, 'escape')::jsonb) (1)
            """;

    private static final String UPDATE_SESSION_ATTRIBUTE_QUERY = """
            UPDATE %TABLE_NAME%_ATTRIBUTES
            SET ATTRIBUTE_BYTES = encode(?, 'escape')::jsonb
            WHERE SESSION_PRIMARY_ID = ?
            AND ATTRIBUTE_NAME = ?
            """;

    @Bean
    SessionRepositoryCustomizer<JdbcIndexedSessionRepository> customizer() {
        return (sessionRepository) -> {
            sessionRepository.setCreateSessionAttributeQuery(CREATE_SESSION_ATTRIBUTE_QUERY);
            sessionRepository.setUpdateSessionAttributeQuery(UPDATE_SESSION_ATTRIBUTE_QUERY);
        };
    }

}
1 使用 PostgreSQL encode 函数将 bytea 转换为 text

就这样，您现在应该能够看到会话属性以 JSON 格式保存在数据库中。这里有一个可用的示例，您可以在其中查看完整的实现并运行测试。

如果您的UserDetails 实现扩展了 Spring Security 的 org.springframework.security.core.userdetails.User 类，那么为它注册一个自定义的反序列化器非常重要。否则，Jackson 将使用现有的 org.springframework.security.jackson2.UserDeserializer，这将不会得到预期的 UserDetails 实现。更多详情请参阅 gh-3009。

指定备用 DataSource

默认情况下，Spring Session JDBC 使用应用程序中可用的主要 DataSource bean。然而，在某些场景下，应用程序可能有多个 DataSource bean，在这种情况下，您可以通过使用 @SpringSessionDataSource 限定 bean 来告诉 Spring Session JDBC 使用哪个 DataSource

  • Java

import org.springframework.session.jdbc.config.annotation.SpringSessionDataSource;

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    @Bean
    public DataSource dataSourceOne() {
        // create and configure datasource
        return dataSourceOne;
    }

    @Bean
    @SpringSessionDataSource (1)
    public DataSource dataSourceTwo() {
        // create and configure datasource
        return dataSourceTwo;
    }

}
1 我们使用 @SpringSessionDataSource 注解 dataSourceTwo bean，以告诉 Spring Session JDBC 它应该使用该 bean 作为 DataSource。

自定义 Spring Session JDBC 使用事务的方式

所有 JDBC 操作都以事务方式执行。事务的传播行为设置为 REQUIRES_NEW，以避免与现有事务干扰（例如，在已经参与只读事务的线程中运行保存操作）而导致意外行为。要自定义 Spring Session JDBC 使用事务的方式，您可以提供一个名为 springSessionTransactionOperations 的 TransactionOperations bean。例如，如果您想完全禁用事务，您可以这样做：

  • Java

import org.springframework.transaction.support.TransactionOperations;

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    @Bean("springSessionTransactionOperations")
    public TransactionOperations springSessionTransactionOperations() {
        return TransactionOperations.withoutTransaction();
    }

}

如果您想要更多控制，您还可以提供配置的 TransactionTemplate 使用的 TransactionManager。默认情况下，Spring Session 将尝试从应用程序上下文中解析主要的 TransactionManager bean。在某些场景下，例如当有多个 DataSource 时，很可能存在多个 TransactionManager，您可以通过使用 @SpringSessionTransactionManager 限定它来告诉 Spring Session JDBC 您想要使用哪个 TransactionManager bean。

  • Java

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    @Bean
    @SpringSessionTransactionManager
    public TransactionManager transactionManager1() {
        return new MyTransactionManager();
    }

    @Bean
    public TransactionManager transactionManager2() {
        return otherTransactionManager;
    }

}

自定义过期会话清理作业

为了避免数据库被过期会话过载，Spring Session JDBC 会每分钟执行一个清理作业，删除过期会话（及其属性）。您可能希望自定义清理作业有几个原因，让我们在接下来的章节中看看最常见的原因。然而，对默认作业的自定义是有限的，这是故意的，Spring Session 并非旨在提供强大的批处理能力，因为有许多框架或库在这方面做得更好。因此，如果您想要更多的自定义能力，请考虑禁用默认作业并提供您自己的作业。一个不错的替代方案是使用 Spring Batch，它为批处理应用程序提供了强大的解决方案。

自定义过期会话清理频率

您可以使用 @EnableJdbcHttpSession 中的 cleanupCron 属性来自定义定义清理作业运行频率的cron 表达式

  • Java

@Configuration
@EnableJdbcHttpSession(cleanupCron = "0 0 * * * *") // top of every hour of every day
public class SessionConfig {

}

或者，如果您正在使用 Spring Boot，请设置 spring.session.jdbc.cleanup-cron 属性

  • application.properties

spring.session.jdbc.cleanup-cron="0 0 * * * *"

禁用作业

要禁用作业，您必须将 Scheduled.CRON_DISABLED 传递给 @EnableJdbcHttpSession 中的 cleanupCron 属性

  • Java

@Configuration
@EnableJdbcHttpSession(cleanupCron = Scheduled.CRON_DISABLED)
public class SessionConfig {

}

自定义按过期时间删除查询

您可以通过 SessionRepositoryCustomizer<JdbcIndexedSessionRepository> bean 使用 JdbcIndexedSessionRepository.setDeleteSessionsByExpiryTimeQuery 来自定义删除过期会话的查询

  • Java

@Configuration
@EnableJdbcHttpSession
public class SessionConfig {

    @Bean
    public SessionRepositoryCustomizer<JdbcIndexedSessionRepository> customizer() {
        return (sessionRepository) -> sessionRepository.setDeleteSessionsByExpiryTimeQuery("""
            DELETE FROM %TABLE_NAME%
            WHERE EXPIRY_TIME < ?
            AND OTHER_COLUMN = 'value'
            """);
    }

}