存储过程

在某些情况下，普通的 JDBC 支持是不够的。也许您正在处理遗留的关系数据库模式，或者您有复杂的数据处理需求，但最终，您必须使用存储过程或存储函数。从 Spring Integration 2.1 开始，我们提供了三个组件来执行存储过程或存储函数

存储过程入站通道适配器
存储过程出站通道适配器
存储过程出站网关

支持的数据库

为了启用对存储过程和存储函数的调用，存储过程组件使用 org.springframework.jdbc.core.simple.SimpleJdbcCall 类。因此，以下数据库完全支持执行存储过程

Apache Derby
DB2
MySQL
Microsoft SQL Server
Oracle
PostgreSQL
Sybase

如果您想执行存储函数，以下数据库完全支持

MySQL
Microsoft SQL Server
Oracle
PostgreSQL

即使您的特定数据库可能没有完全支持，您仍然可以使用存储过程 Spring Integration 组件，只要您的 RDBMS 支持存储过程或存储函数。

事实上，一些提供的集成测试使用 H2 数据库。但是，彻底测试这些使用场景非常重要。

配置

存储过程组件提供完整的 XML 命名空间支持，配置组件与前面讨论的通用 JDBC 组件类似。

通用配置属性

所有存储过程组件共享某些配置参数

auto-startup: 生命周期属性，指示此组件是否应在应用程序上下文启动期间启动。默认为 true。可选。
data-source: 对 javax.sql.DataSource 的引用，用于访问数据库。必需。
id: 标识底层 Spring bean 定义，它是一个 EventDrivenConsumer 或 PollingConsumer 的实例，具体取决于出站通道适配器的 channel 属性引用的是 SubscribableChannel 还是 PollableChannel。可选。
ignore-column-meta-data: 对于完全支持的数据库，底层 SimpleJdbcCall 类可以自动从 JDBC 元数据中检索存储过程或存储函数的参数信息。

但是，如果数据库不支持元数据查找，或者您需要提供自定义参数定义，则可以将此标志设置为 true。默认为 false。可选。
is-function: 如果为 true，则调用 SQL 函数。在这种情况下，stored-procedure-name 或 stored-procedure-name-expression 属性定义调用函数的名称。默认为 false。可选。
stored-procedure-name: 此属性指定存储过程的名称。如果 is-function 属性设置为 true，则此属性指定函数名称。必须指定此属性或 stored-procedure-name-expression。
stored-procedure-name-expression: 此属性使用 SpEL 表达式指定存储过程的名称。使用 SpEL，您可以访问完整的消息（如果可用），包括其标头和有效负载。您可以使用此属性在运行时调用不同的存储过程。例如，您可以提供要执行的存储过程名称作为消息标头。表达式必须解析为 String。

如果is-function属性设置为true，则此属性指定一个存储函数。必须指定此属性或stored-procedure-name。
jdbc-call-operations-cache-size：定义缓存的SimpleJdbcCallOperations实例的最大数量。基本上，对于每个存储过程名称，都会创建一个新的SimpleJdbcCallOperations实例，该实例会被缓存。

Spring Integration 2.2 添加了stored-procedure-name-expression属性和jdbc-call-operations-cache-size属性。

默认缓存大小为10。值为0表示禁用缓存。不允许使用负值。

如果启用 JMX，有关jdbc-call-operations-cache的统计信息将作为 MBean 公开。有关更多信息，请参见MBean 导出器。
sql-parameter-source-factory：（对于存储过程入站通道适配器不可用。）SqlParameterSourceFactory 的引用。默认情况下，传递的Message有效负载的 bean 属性将使用BeanPropertySqlParameterSourceFactory作为存储过程输入参数的来源。

这可能足以满足基本用例。对于更复杂的选择，请考虑传入一个或多个ProcedureParameter值。请参见定义参数源。可选。
use-payload-as-parameter-source：（对于存储过程入站通道适配器不可用。）如果设置为true，则Message的有效负载将用作提供参数的来源。但是，如果设置为false，则整个Message将可用作参数的来源。

如果没有传入过程参数，则此属性默认为true。这意味着，通过使用默认的BeanPropertySqlParameterSourceFactory，有效负载的 bean 属性将用作存储过程或存储函数的参数值的来源。

但是，如果传入过程参数，则此属性（默认情况下）将评估为false。ProcedureParameter允许提供 SpEL 表达式。因此，访问整个Message非常有益。在底层的StoredProcExecutor上设置的属性。可选。

通用配置子元素

存储过程组件共享一组通用的子元素，您可以使用这些元素来定义和传递参数到存储过程或存储函数。以下元素可用

parameter
returning-resultset
sql-参数定义
轮询器

parameter: 提供了一种机制来提供存储过程参数。参数可以是静态的，也可以通过使用 SpEL 表达式来提供。

<int-jdbc:parameter name=""         (1)
                    type=""         (2)
                    value=""/>      (3)

<int-jdbc:parameter name=""
                    expression=""/> (4)

1	要传递到存储过程或存储函数的参数的名称。必需的。
2	此属性指定值的类型。如果未提供任何内容，则此属性默认为 `java.lang.String`。此属性仅在使用 `value` 属性时使用。可选的。
3	参数的值。您必须提供此属性或 `expression` 属性。可选的。
4	您可以指定一个 SpEL 表达式来传递参数的值，而不是 `value` 属性。如果您指定 `expression`，则不允许使用 `value` 属性。可选的。可选的。

returning-resultset: 存储过程可能返回多个结果集。通过设置一个或多个 returning-resultset 元素，您可以指定 RowMappers 将每个返回的 ResultSet 转换为有意义的对象。可选的。
```
<int-jdbc:returning-resultset name="" row-mapper="" />
```

sql-parameter-definition: 如果您使用的是完全支持的数据库，通常不必指定存储过程参数定义。相反，这些参数可以从 JDBC 元数据自动推断。但是，如果您使用的是不支持的数据库，则必须使用 sql-parameter-definition 元素显式设置这些参数。

您也可以选择通过使用 ignore-column-meta-data 属性来关闭通过 JDBC 获取的参数元数据信息的任何处理。

<int-jdbc:sql-parameter-definition
                                   name=""                           (1)
                                   direction="IN"                    (2)
                                   type="STRING"                     (3)
                                   scale="5"                         (4)
                                   type-name="FOO_STRUCT"            (5)
                                   return-type="fooSqlReturnType"/>  (6)

1	指定 SQL 参数的名称。必需的。
2	指定 SQL 参数定义的方向。默认为 `IN`。有效值为：`IN`、`OUT` 和 `INOUT`。如果您的过程正在返回结果集，请使用 `returning-resultset` 元素。可选的。
3	用于此 SQL 参数定义的 SQL 类型。转换为一个整数值，如 `java.sql.Types` 定义的那样。或者，您也可以提供整数值。如果此属性未显式设置，则默认为 'VARCHAR'。可选的。
4	SQL 参数的比例。仅用于数字和十进制参数。可选的。
5	用于用户命名的类型的 `typeName`，例如：`STRUCT`、`DISTINCT`、`JAVA_OBJECT` 和命名数组类型。此属性与 `scale` 属性互斥。可选的。
6	对复杂类型的自定义值处理器的引用。`SqlReturnType` 的实现。此属性与 `scale` 属性互斥，仅适用于 OUT 和 INOUT 参数。可选。 `poller`：如果此端点是 `PollingConsumer`，则允许您配置消息轮询器。可选。

定义参数源

参数源控制将 Spring Integration 消息属性检索和映射到相关存储过程输入参数的技术。

存储过程组件遵循某些规则。默认情况下，Message 负载的 bean 属性用作存储过程输入参数的来源。在这种情况下，使用 BeanPropertySqlParameterSourceFactory。这可能足以满足基本用例。以下示例说明了该默认行为。

为了使使用 BeanPropertySqlParameterSourceFactory 自动查找 bean 属性起作用，您的 bean 属性必须以小写定义。这是因为在 org.springframework.jdbc.core.metadata.CallMetaDataContext（Java 方法是 matchInParameterValuesWithCallParameters()）中，检索到的存储过程参数声明被转换为小写。因此，如果您有驼峰式 bean 属性（例如 lastName），则查找将失败。在这种情况下，请提供显式的 ProcedureParameter。

假设我们有一个负载，它包含一个具有以下三个属性的简单 bean：id、name 和 description。此外，我们有一个简单的存储过程，名为 INSERT_COFFEE，它接受三个输入参数：id、name 和 description。我们还使用一个完全支持的数据库。在这种情况下，以下存储过程出站适配器的配置就足够了

<int-jdbc:stored-proc-outbound-channel-adapter data-source="dataSource"
    channel="insertCoffeeProcedureRequestChannel"
    stored-procedure-name="INSERT_COFFEE"/>

对于更复杂的选择，请考虑传入一个或多个 ProcedureParameter 值。

如果您确实显式地提供了 ProcedureParameter 值，则默认情况下，将使用 ExpressionEvaluatingSqlParameterSourceFactory 进行参数处理，以启用 SpEL 表达式的全部功能。

如果您需要对参数检索方式进行更多控制，请考虑使用 sql-parameter-source-factory 属性传入 SqlParameterSourceFactory 的自定义实现。

存储过程入站通道适配器

以下列表列出了对存储过程入站通道适配器重要的属性

<int-jdbc:stored-proc-inbound-channel-adapter
                                   channel=""                                    (1)
                                   stored-procedure-name=""
                                   data-source=""
                                   auto-startup="true"
                                   id=""
                                   ignore-column-meta-data="false"
                                   is-function="false"
                                   skip-undeclared-results=""                    (2)
                                   return-value-required="false"                 (3)
    <int:poller/>
    <int-jdbc:sql-parameter-definition name="" direction="IN"
                                               type="STRING"
                                               scale=""/>
    <int-jdbc:parameter name="" type="" value=""/>
    <int-jdbc:parameter name="" expression=""/>
    <int-jdbc:returning-resultset name="" row-mapper="" />
</int-jdbc:stored-proc-inbound-channel-adapter>

1	发送轮询消息的通道。如果存储过程或函数不返回任何数据，则 `Message` 的负载为 null。必需。
2	如果将此属性设置为 `true`，则将绕过存储过程调用中所有没有相应 `SqlOutParameter` 声明的结果。例如，存储过程可以返回更新计数值，即使您的存储过程只声明了一个结果参数。确切的行为取决于数据库实现。该值设置在底层的 `JdbcTemplate` 上。该值默认为 `true`。可选。
3	指示是否应包含此过程的返回值。自 Spring Integration 3.0 以来。可选。

存储过程出站通道适配器

以下列表列出了存储过程出站通道适配器的重要属性。

<int-jdbc:stored-proc-outbound-channel-adapter channel=""                        (1)
                                               stored-procedure-name=""
                                               data-source=""
                                               auto-startup="true"
                                               id=""
                                               ignore-column-meta-data="false"
                                               order=""                          (2)
                                               sql-parameter-source-factory=""
                                               use-payload-as-parameter-source="">
    <int:poller fixed-rate=""/>
    <int-jdbc:sql-parameter-definition name=""/>
    <int-jdbc:parameter name=""/>

</int-jdbc:stored-proc-outbound-channel-adapter>

1	此端点的接收消息通道。必需。
2	指定此端点作为订阅者连接到通道时调用的顺序。当该通道使用 `failover` 分派策略时，这一点尤其重要。当此端点本身是具有队列的通道的轮询消费者时，它没有影响。可选。

存储过程出站网关

以下列表列出了存储过程出站通道适配器的重要属性。

<int-jdbc:stored-proc-outbound-gateway request-channel=""                        (1)
                                       stored-procedure-name=""
                                       data-source=""
                                   auto-startup="true"
                                   id=""
                                   ignore-column-meta-data="false"
                                   is-function="false"
                                   order=""
                                   reply-channel=""                              (2)
                                   reply-timeout=""                              (3)
                                   return-value-required="false"                 (4)
                                   skip-undeclared-results=""                    (5)
                                   sql-parameter-source-factory=""
                                   use-payload-as-parameter-source="">
<int-jdbc:sql-parameter-definition name="" direction="IN"
                                   type=""
                                   scale="10"/>
<int-jdbc:sql-parameter-definition name=""/>
<int-jdbc:parameter name="" type="" value=""/>
<int-jdbc:parameter name="" expression=""/>
<int-jdbc:returning-resultset name="" row-mapper="" />

1	此端点的接收消息通道。必需。
2	接收数据库响应后应将回复发送到的消息通道。可选。
3	允许您指定此网关在抛出异常之前等待回复消息成功发送的时间。请记住，当发送到 `DirectChannel` 时，调用发生在发送者的线程中。因此，发送操作失败可能是由下游的其他组件引起的。该值以毫秒为单位指定。可选。
4	指示是否应包含此过程的返回值。可选。
5	如果 `skip-undeclared-results` 属性设置为 `true`，则将绕过存储过程调用中没有相应 `SqlOutParameter` 声明的所有结果。例如，存储过程可能会返回更新计数值，即使您的存储过程只声明了一个结果参数。确切的行为取决于数据库。该值在底层的 `JdbcTemplate` 上设置。该值默认为 `true`。可选。

示例

本节包含两个调用 Apache Derby 存储过程的示例。第一个过程调用一个返回 ResultSet 的存储过程。通过使用 RowMapper，数据被转换为域对象，然后成为 Spring Integration 消息的有效负载。

在第二个示例中，我们调用一个使用输出参数来返回数据的存储过程。

查看 Spring Integration 示例项目。

该项目包含此处引用的 Apache Derby 示例，以及有关如何运行它的说明。Spring Integration 示例项目还提供了一个示例，说明如何使用 Oracle 存储过程。

在第一个示例中，我们调用一个名为 FIND_ALL_COFFEE_BEVERAGES 的存储过程，该过程没有定义任何输入参数，但返回一个 ResultSet。

在 Apache Derby 中，存储过程是在 Java 中实现的。以下列表显示了方法签名

public static void findAllCoffeeBeverages(ResultSet[] coffeeBeverages)
            throws SQLException {
    ...
}

以下列表显示了相应的 SQL

CREATE PROCEDURE FIND_ALL_COFFEE_BEVERAGES() \
PARAMETER STYLE JAVA LANGUAGE JAVA MODIFIES SQL DATA DYNAMIC RESULT SETS 1 \
EXTERNAL NAME 'o.s.i.jdbc.storedproc.derby.DerbyStoredProcedures.findAllCoffeeBeverages';

在 Spring Integration 中，您现在可以使用例如 stored-proc-outbound-gateway 来调用此存储过程，如下面的示例所示

<int-jdbc:stored-proc-outbound-gateway id="outbound-gateway-storedproc-find-all"
                                       data-source="dataSource"
                                       request-channel="findAllProcedureRequestChannel"
                                       expect-single-result="true"
                                       stored-procedure-name="FIND_ALL_COFFEE_BEVERAGES">
<int-jdbc:returning-resultset name="coffeeBeverages"
    row-mapper="org.springframework.integration.support.CoffeBeverageMapper"/>
</int-jdbc:stored-proc-outbound-gateway>

在第二个示例中，我们调用了一个名为FIND_COFFEE的存储过程，它有一个输入参数。它不返回ResultSet，而是使用输出参数。以下示例显示了方法签名

public static void findCoffee(int coffeeId, String[] coffeeDescription)
            throws SQLException {
    ...
}

以下列表显示了相应的 SQL

CREATE PROCEDURE FIND_COFFEE(IN ID INTEGER, OUT COFFEE_DESCRIPTION VARCHAR(200)) \
PARAMETER STYLE JAVA LANGUAGE JAVA EXTERNAL NAME \
'org.springframework.integration.jdbc.storedproc.derby.DerbyStoredProcedures.findCoffee';

在 Spring Integration 中，您现在可以使用例如stored-proc-outbound-gateway来调用此存储过程，如下例所示

<int-jdbc:stored-proc-outbound-gateway id="outbound-gateway-storedproc-find-coffee"
                                       data-source="dataSource"
                                       request-channel="findCoffeeProcedureRequestChannel"
                                       skip-undeclared-results="true"
                                       stored-procedure-name="FIND_COFFEE"
                                       expect-single-result="true">
    <int-jdbc:parameter name="ID" expression="payload" />
</int-jdbc:stored-proc-outbound-gateway>