JDBC 消息存储

Spring Integration 提供了两个 JDBC 特定的消息存储实现。JdbcMessageStore 适用于聚合器和凭证检查模式。JdbcChannelMessageStore 实现提供了一个更具针对性和可扩展性的实现，专门用于消息通道。

请注意，您可以使用 JdbcMessageStore 支持消息通道，JdbcChannelMessageStore 针对此目的进行了优化。

从 5.0.11 和 5.1.2 版本开始，JdbcChannelMessageStore 的索引进行了优化。如果您的存储中包含大型消息组，您可能希望更改这些索引。此外，PriorityChannel 的索引已注释掉，因为除非您正在使用由 JDBC 支持的此类通道，否则不需要它。
当使用 OracleChannelMessageStoreQueryProvider 时，必须添加优先级通道索引，因为它包含在查询的提示中。

数据库初始化

在开始使用 JDBC 消息存储组件之前，您应该使用适当的对象预配目标数据库。

Spring Integration 附带了一些可用于初始化数据库的示例脚本。在 spring-integration-jdbc JAR 文件中，您可以在 org.springframework.integration.jdbc 包中找到脚本。它为一系列常见的数据库平台提供了一个创建示例和一个删除示例脚本。使用这些脚本的一种常见方法是在 Spring JDBC 数据源初始化程序 中引用它们。请注意，这些脚本作为示例和所需表和列名称的规范提供。您可能会发现需要增强它们以用于生产环境（例如，通过添加索引声明）。

从 6.2 版本开始，JdbcMessageStore、JdbcChannelMessageStore、JdbcMetadataStore 和 DefaultLockRepository 实现 SmartLifecycle，并在 start() 方法中对各自的表执行 SELECT COUNT 查询，以确保目标数据库中存在所需的表（根据提供的前缀）。如果所需的表不存在，则应用程序上下文将无法启动。可以通过 setCheckDatabaseOnStart(false) 禁用此检查。

通用 JDBC 消息存储

JDBC 模块提供了 Spring Integration MessageStore（在凭证检查模式中很重要）和 MessageGroupStore（在聚合器等有状态模式中很重要）的实现，这些实现由数据库支持。这两个接口都由 JdbcMessageStore 实现，并且支持在 XML 中配置存储实例，如下例所示

<int-jdbc:message-store id="messageStore" data-source="dataSource"/>

您可以指定 JdbcTemplate 而不是 DataSource。

以下示例显示了一些其他可选属性

<int-jdbc:message-store id="messageStore" data-source="dataSource"
    lob-handler="lobHandler" table-prefix="MY_INT_"/>

在前面的示例中，我们指定了一个 LobHandler 用于处理消息作为大型对象（这通常对于 Oracle 是必需的），以及查询生成器生成的表名称的前缀。表名称前缀默认为 INT_。

支持消息通道

如果您打算使用 JDBC 支持消息通道，我们建议使用 JdbcChannelMessageStore 实现。它仅与消息通道一起使用。

支持的数据库

JdbcChannelMessageStore 使用特定于数据库的 SQL 查询从数据库检索消息。因此，您必须在 JdbcChannelMessageStore 上设置 ChannelMessageStoreQueryProvider 属性。此 channelMessageStoreQueryProvider 提供您指定的特定数据库的 SQL 查询。Spring Integration 支持以下关系数据库

  • PostgreSQL

  • HSQLDB

  • MySQL

  • Oracle

  • Derby

  • H2

  • SqlServer

  • Sybase

  • DB2

如果您的数据库未列出，您可以实现 ChannelMessageStoreQueryProvider 接口并提供您自己的自定义查询。

4.0 版本在表中添加了 MESSAGE_SEQUENCE 列，以确保即使在同一毫秒内存储消息也能实现先进先出 (FIFO) 排队。

从 6.2 版本开始，ChannelMessageStoreQueryProvider 公开了 isSingleStatementForPoll 标志，其中 PostgresChannelMessageStoreQueryProvider 返回 true，并且其轮询查询现在基于单个 DELETE…​RETURNING 语句。JdbcChannelMessageStore 会查询 isSingleStatementForPoll 选项，如果仅支持单个轮询语句，则会跳过单独的 DELETE 语句。

自定义消息插入

从 5.0 版本开始，通过重载 ChannelMessageStorePreparedStatementSetter 类，您可以为 JdbcChannelMessageStore 中的消息插入提供自定义实现。您可以使用它来设置不同的列或更改表结构或序列化策略。例如，您可以将结构存储为 JSON 字符串，而不是默认序列化为 byte[]。

以下示例使用 setValues 的默认实现来存储公共列，并覆盖行为以将消息有效负载存储为 varchar

public class JsonPreparedStatementSetter extends ChannelMessageStorePreparedStatementSetter {

    @Override
    public void setValues(PreparedStatement preparedStatement, Message<?> requestMessage,
        Object groupId, String region, 	boolean priorityEnabled) throws SQLException {
        // Populate common columns
        super.setValues(preparedStatement, requestMessage, groupId, region, priorityEnabled);
        // Store message payload as varchar
        preparedStatement.setString(6, requestMessage.getPayload().toString());
    }
}

通常，我们不建议将关系数据库用于排队。相反，如果可能，请考虑改用 JMS 或 AMQP 支持的通道。有关更多参考，请参阅以下资源

如果您仍然计划将数据库用作队列，请考虑使用 PostgreSQL 及其通知机制，该机制在后续部分中进行了描述。

并发轮询

轮询消息通道时，您可以选择使用 TaskExecutor 引用配置关联的 Poller。

但是，请记住，如果您使用 JDBC 支持的消息通道，并且您计划使用多个线程轮询通道并因此轮询消息存储事务，则应确保您使用的关系数据库支持多版本并发控制(MVCC)。否则，锁定可能成为问题，并且在使用多个线程时，性能可能无法达到预期。例如，Apache Derby 在这方面存在问题。

为了获得更好的 JDBC 队列吞吐量并避免不同线程可能从队列中轮询相同 Message 时出现的问题，在使用不支持 MVCC 的数据库时，**务必**将 JdbcChannelMessageStore 的 usingIdCache 属性设置为 true。以下示例显示了如何操作

<bean id="queryProvider"
    class="o.s.i.jdbc.store.channel.PostgresChannelMessageStoreQueryProvider"/>

<int:transaction-synchronization-factory id="syncFactory">
    <int:after-commit expression="@store.removeFromIdCache(headers.id.toString())" />
    <int:after-rollback expression="@store.removeFromIdCache(headers.id.toString())"/>
</int:transaction-synchronization-factory>

<task:executor id="pool" pool-size="10"
    queue-capacity="10" rejection-policy="CALLER_RUNS" />

<bean id="store" class="o.s.i.jdbc.store.JdbcChannelMessageStore">
    <property name="dataSource" ref="dataSource"/>
    <property name="channelMessageStoreQueryProvider" ref="queryProvider"/>
    <property name="region" value="TX_TIMEOUT"/>
    <property name="usingIdCache" value="true"/>
</bean>

<int:channel id="inputChannel">
    <int:queue message-store="store"/>
</int:channel>

<int:bridge input-channel="inputChannel" output-channel="outputChannel">
    <int:poller fixed-delay="500" receive-timeout="500"
        max-messages-per-poll="1" task-executor="pool">
        <int:transactional propagation="REQUIRED" synchronization-factory="syncFactory"
        isolation="READ_COMMITTED" transaction-manager="transactionManager" />
    </int:poller>
</int:bridge>

<int:channel id="outputChannel" />

优先级通道

从 4.0 版本开始，JdbcChannelMessageStore 实现 PriorityCapableChannelMessageStore 并提供 priorityEnabled 选项，使其可作为 priority-queue 实例的 message-store 引用使用。为此，INT_CHANNEL_MESSAGE 表具有一个 MESSAGE_PRIORITY 列用于存储 PRIORITY 消息头的值。此外，新的 MESSAGE_SEQUENCE 列使我们能够实现强大的先进先出 (FIFO) 轮询机制，即使在同一毫秒内存储了多个具有相同优先级的消息也是如此。消息从数据库中轮询（选择）的顺序为 order by MESSAGE_PRIORITY DESC NULLS LAST, CREATED_DATE, MESSAGE_SEQUENCE。

我们不建议对优先级和非优先级队列通道使用相同的 JdbcChannelMessageStore bean，因为 priorityEnabled 选项适用于整个存储，并且不会为队列通道保留正确的 FIFO 队列语义。但是，相同的 INT_CHANNEL_MESSAGE 表（甚至 region）可用于这两种 JdbcChannelMessageStore 类型。要配置这种情况，您可以从另一个消息存储 bean 扩展一个消息存储 bean，如下例所示 
<bean id="channelStore" class="o.s.i.jdbc.store.JdbcChannelMessageStore">
    <property name="dataSource" ref="dataSource"/>
    <property name="channelMessageStoreQueryProvider" ref="queryProvider"/>
</bean>

<int:channel id="queueChannel">
    <int:queue message-store="channelStore"/>
</int:channel>

<bean id="priorityStore" parent="channelStore">
    <property name="priorityEnabled" value="true"/>
</bean>

<int:channel id="priorityChannel">
    <int:priority-queue message-store="priorityStore"/>
</int:channel>

对消息存储进行分区

通常将 JdbcMessageStore 用作同一应用程序中一组应用程序或节点的全局存储。为了提供一些防止名称冲突的保护并控制数据库元数据配置，消息存储允许以两种方式对表进行分区。一种方法是使用单独的表名，方法是更改前缀（如前面所述）。另一种方法是为分区数据指定一个 region 名称，以在一个表中进行。第二种方法的一个重要用例是当 MessageStore 管理支持 Spring Integration 消息通道的持久队列时。持久通道的消息数据在存储中根据通道名称进行键控。因此，如果通道名称不是全局唯一的，则通道可能会获取不属于其自己的数据。为了避免这种危险，您可以使用消息存储 region 将不同物理通道的数据分开，这些通道具有相同的逻辑名称。

PostgreSQL：接收推送通知

PostgreSQL 提供了一个侦听和通知框架，用于在数据库表操作后接收推送通知。Spring Integration 利用此机制（从 6.0 版本开始）允许在将新消息添加到 JdbcChannelMessageStore 时接收推送通知。使用此功能时，必须定义数据库触发器，该触发器可以在 schema-postgresql.sql 文件的注释中找到，该文件包含在 Spring Integration 的 JDBC 模块中。

推送通知通过 PostgresChannelMessageTableSubscriber 类接收，该类允许其订阅者在任何给定 region 和 groupId 的新消息到达时接收回调。即使在不同的 JVM 上但到同一数据库中追加了消息，也会收到这些通知。PostgresSubscribableChannel 实现使用 PostgresChannelMessageTableSubscriber.Subscription 合同从存储中提取消息，作为对来自提到的 PostgresChannelMessageTableSubscriber 通知通知的反应。

例如，可以按如下方式接收 some group 的推送通知

@Bean
public JdbcChannelMessageStore messageStore(DataSource dataSource) {
    JdbcChannelMessageStore messageStore = new JdbcChannelMessageStore(dataSource);
    messageStore.setChannelMessageStoreQueryProvider(new PostgresChannelMessageStoreQueryProvider());
    return messageStore;
}

@Bean
public PostgresChannelMessageTableSubscriber subscriber(
      @Value("${spring.datasource.url}") String url,
      @Value("${spring.datasource.username}") String username,
      @Value("${spring.datasource.password}") String password) {
    return new PostgresChannelMessageTableSubscriber(() ->
        DriverManager.getConnection(url, username, password).unwrap(PgConnection.class));
}

@Bean
public PostgresSubscribableChannel channel(
    PostgresChannelMessageTableSubscriber subscriber,
    JdbcChannelMessageStore messageStore) {
  return new PostgresSubscribableChannel(messageStore, "some group", subscriber);
}

事务支持

从 6.0.5 版本开始，在 PostgresSubscribableChannel 上指定 PlatformTransactionManager 将在事务中通知订阅者。订阅者中的异常将导致事务回滚并将消息放回消息存储中。默认情况下不会激活事务支持。

重试

从 6.0.5 版本开始，可以通过向 PostgresSubscribableChannel 提供 RetryTemplate 来指定重试策略。默认情况下，不执行任何重试。

任何活动的 PostgresChannelMessageTableSubscriber 在其活动生命周期期间都会占用一个独占的 JDBC Connection。因此，重要的是此连接不是来自池化 DataSource。此类连接池通常期望在预定义的超时窗口内关闭发出的连接。

对于此独占连接的需求，还建议 JVM 仅运行一个 PostgresChannelMessageTableSubscriber，该订阅者可用于注册任意数量的订阅。