出站网关

JPA 入站通道适配器允许您轮询数据库以检索一个或多个 JPA 实体。检索到的数据随后用于启动一个 Spring Integration 流，该流使用检索到的数据作为消息有效负载。

此外，您可以在流的末尾使用 JPA 出站通道适配器来持久化数据，实质上是在持久化操作结束时停止流。

但是，如何在流的中间执行 JPA 持久化操作？例如，您可能有一些正在 Spring Integration 消息流中处理的业务数据，并且您希望持久化这些数据，但您仍然需要在后续使用其他组件。或者，您无需使用轮询器轮询数据库，而是需要执行 JPQL 查询并主动检索数据，然后在流中的后续组件中处理这些数据。

这就是 JPA 出站网关发挥作用的地方。它们使您能够持久化数据以及检索数据。为了促进这些用途，Spring Integration 提供了两种类型的 JPA 出站网关

  • 更新出站网关

  • 检索出站网关

每当使用出站网关执行保存、更新或仅删除数据库中某些记录的操作时，您都需要使用更新出站网关。例如，如果您使用 entity 持久化它，则会返回合并和持久化的实体作为结果。在其他情况下，将返回受影响的记录数（更新或删除）。

从数据库检索（选择）数据时，我们使用检索出站网关。使用检索出站网关，我们可以使用 JPQL、命名查询（基于本机或 JPQL）或本机查询（SQL）来选择数据并检索结果。

更新出站网关在功能上类似于出站通道适配器，不同之处在于更新出站网关在执行 JPA 操作后将结果发送到网关的回复通道。

检索出站网关类似于入站通道适配器。

我们建议您首先阅读本章前面部分的 出站通道适配器 部分和 入站通道适配器 部分，因为大多数常见概念都在那里进行了说明。

这种相似性是使用中心 JpaExecutor 类尽可能统一通用功能的主要因素。

对于所有 JPA 出站网关以及类似于 outbound-channel-adapter，我们可以使用它来执行各种 JPA 操作

  • 实体类

  • JPA 查询语言 (JPQL)

  • 原生查询

  • 命名查询

有关配置示例，请参见 JPA 出站网关示例。

通用配置参数

JPA 出站网关始终可以访问 Spring Integration Message 作为输入。因此，以下参数可用

parameter-source-factory

o.s.i.jpa.support.parametersource.ParameterSourceFactory 的一个实例，用于获取 o.s.i.jpa.support.parametersource.ParameterSource 的实例。ParameterSource 用于解析查询中提供的参数的值。如果您使用 JPA 实体执行操作，则会忽略 parameter-source-factory 属性。parameter 子元素与 parameter-source-factory 互斥，并且必须在提供的 ParameterSourceFactory 上配置它们。可选。

use-payload-as-parameter-source

如果设置为 true，则 Message 的有效负载用作参数的来源。如果设置为 false，则整个 Message 都可用作参数的来源。如果没有传递 JPA 参数，则此属性默认为 true。这意味着，如果您使用默认的 BeanPropertyParameterSourceFactory，则有效负载的 bean 属性将用作 JPA 查询参数值的来源。但是，如果传递了 JPA 参数，则此属性默认情况下将评估为 false。原因是 JPA 参数允许您提供 SpEL 表达式。因此，访问整个 Message（包括标头）非常有益。可选。

更新出站网关

以下列表显示了您可以在更新出站网关上设置的所有属性，并描述了关键属性

<int-jpa:updating-outbound-gateway request-channel=""  (1)
    auto-startup="true"
    entity-class=""
    entity-manager=""
    entity-manager-factory=""
    id=""
    jpa-operations=""
    jpa-query=""
    named-query=""
    native-query=""
    order=""
    parameter-source-factory=""
    persist-mode="MERGE"
    reply-channel=""  (2)
    reply-timeout=""  (3)
    use-payload-as-parameter-source="true">

    <int:poller/>
    <int-jpa:transactional/>

    <int-jpa:parameter name="" type="" value=""/>
    <int-jpa:parameter name="" expression=""/>
</int-jpa:updating-outbound-gateway>
1 出站网关从中接收用于执行所需操作的消息的通道。此属性类似于 outbound-channel-adapter 的 channel 属性。可选。
2 网关在执行所需的 JPA 操作后将响应发送到的通道。如果未定义此属性，则请求消息必须具有 replyChannel 标头。可选。
3 指定网关等待将结果发送到回复通道的时间。仅当回复通道本身可能会阻止发送操作（例如，当前已满的有界 QueueChannel）时才适用。该值以毫秒为单位指定。可选。

其余属性在本节前面已进行了描述。请参阅 配置参数参考 和 配置参数参考。

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置出站适配器的示例

@SpringBootApplication
@EntityScan(basePackageClasses = StudentDomain.class)
@IntegrationComponentScan
public class JpaJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(JpaJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Autowired
    private EntityManagerFactory entityManagerFactory;

    @MessagingGateway
    interface JpaGateway {

       @Gateway(requestChannel = "jpaUpdateChannel")
       @Transactional
       void updateStudent(StudentDomain payload);

    }

    @Bean
    @ServiceActivator(channel = "jpaUpdateChannel")
    public MessageHandler jpaOutbound() {
        JpaOutboundGateway adapter =
               new JpaOutboundGateway(new JpaExecutor(this.entityManagerFactory));
        adapter.setOutputChannelName("updateResults");
        return adapter;
    }

}

使用 Java DSL 进行配置

以下 Spring Boot 应用程序显示了如何使用 Java DSL 配置出站适配器的示例

@SpringBootApplication
@EntityScan(basePackageClasses = StudentDomain.class)
public class JpaJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(JpaJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Autowired
    private EntityManagerFactory entityManagerFactory;

    @Bean
    public IntegrationFlow updatingGatewayFlow() {
        return f -> f
                .handle(Jpa.updatingGateway(this.entityManagerFactory),
                        e -> e.transactional(true))
                .channel(c -> c.queue("updateResults"));
    }

}

检索出站网关

以下示例演示了如何配置检索出站网关

  • Java DSL

  • Kotlin DSL

  • Java

  • XML

@SpringBootApplication
@EntityScan(basePackageClasses = StudentDomain.class)
public class JpaJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(JpaJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Autowired
    private EntityManagerFactory entityManagerFactory;

    @Bean
    public IntegrationFlow retrievingGatewayFlow() {
        return f -> f
                .handle(Jpa.retrievingGateway(this.entityManagerFactory)
                       .jpaQuery("from Student s where s.id = :id")
                       .expectSingleResult(true)
                       .parameterExpression("id", "payload"))
                .channel(c -> c.queue("retrieveResults"));
    }

}
@Bean
fun retrievingGatewayFlow() =
    integrationFlow {
        handle(Jpa.retrievingGateway(this.entityManagerFactory)
                .jpaQuery("from Student s where s.id = :id")
                .expectSingleResult(true)
                .parameterExpression("id", "payload"))
        channel { queue("retrieveResults") }
    }
@SpringBootApplication
@EntityScan(basePackageClasses = StudentDomain.class)
public class JpaJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(JpaJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Autowired
    private EntityManagerFactory entityManagerFactory;


    @Bean
    public JpaExecutor jpaExecutor() {
        JpaExecutor executor = new JpaExecutor(this.entityManagerFactory);
        jpaExecutor.setJpaQuery("from Student s where s.id = :id");
        executor.setJpaParameters(Collections.singletonList(new JpaParameter("id", null, "payload")));
        jpaExecutor.setExpectSingleResult(true);
        return executor;
    }

    @Bean
    @ServiceActivator(channel = "jpaRetrievingChannel")
    public MessageHandler jpaOutbound() {
        JpaOutboundGateway adapter = new JpaOutboundGateway(jpaExecutor());
        adapter.setOutputChannelName("retrieveResults");
        adapter.setGatewayType(OutboundGatewayType.RETRIEVING);
        return adapter;
    }

}
<int-jpa:retrieving-outbound-gateway request-channel=""
    auto-startup="true"
    delete-after-poll="false"
    delete-in-batch="false"
    entity-class=""
    id-expression=""              (1)
    entity-manager=""
    entity-manager-factory=""
    expect-single-result="false"  (2)
    id=""
    jpa-operations=""
    jpa-query=""
    max-results=""                (3)
    max-results-expression=""     (4)
    first-result=""               (5)
    first-result-expression=""    (6)
    named-query=""
    native-query=""
    order=""
    parameter-source-factory=""
    reply-channel=""
    reply-timeout=""
    use-payload-as-parameter-source="true">
    <int:poller></int:poller>
    <int-jpa:transactional/>

    <int-jpa:parameter name="" type="" value=""/>
    <int-jpa:parameter name="" expression=""/>
</int-jpa:retrieving-outbound-gateway>
1 （从 Spring Integration 4.0 开始）确定针对 requestMessage 作为评估上下文的根对象的 EntityManager.find(Class entityClass, Object primaryKey) 方法的 primaryKey 值的 SpEL 表达式。如果存在，则 entityClass 参数由 entity-class 属性确定。否则，它由 payload 类确定。如果您使用 id-expression，则不允许使用所有其他属性。可选。
2 一个布尔标志，指示选择操作预计返回单个结果还是结果的 List。如果此标志设置为 true，则单个实体将作为消息的有效负载发送。如果返回多个实体，则会引发异常。如果为 false，则结果的 List 作为消息的有效负载发送。它默认为 false。可选。
3 此非零非负整数值告诉适配器在执行选择操作时不要选择超过指定行数的结果。默认情况下，如果未设置此属性，则通过给定查询选择所有可能记录。此属性与 max-results-expression 互斥。可选。
4 可用于查找结果集中最大结果数的表达式。它与 max-results 互斥。可选。
5 此非零非负整数值告诉适配器要从中检索结果的第一条记录的位置。此属性与 first-result-expression 互斥。版本 3.0 引入了此属性。可选。
6 此表达式针对消息进行评估，以查找结果集中第一条记录的位置。此属性与 first-result 互斥。版本 3.0 引入了此属性。可选。

当您选择在检索时删除实体，并且您已检索到实体集合时，默认情况下，实体将基于每个实体进行删除。这可能会导致性能问题。

或者，您可以将属性 deleteInBatch 设置为 true，这将执行批量删除。但是，这样做的限制是不支持级联删除。

JSR 317：Java™ Persistence 2.0 在第 4.10 章“批量更新和删除操作”中指出

“删除操作仅适用于指定类及其子类的实体。它不会级联到相关实体。”

有关更多信息，请参阅 JSR 317：Java™ Persistence 2.0
从版本 6.0 开始，当查询返回的实体不存在时，Jpa.retrievingGateway() 返回一个空列表结果。以前返回 null 以结束流程，或根据 requiresReply 抛出异常。或者，要恢复到以前的行为，请在网关之后添加一个 filter 以过滤掉空列表。它需要在空列表处理是下游逻辑一部分的应用程序中进行额外的配置。有关可能的空列表处理选项，请参阅 Splitter 丢弃通道。

JPA 出站网关示例

本节包含使用更新出站网关和检索出站网关的各种示例

使用实体类更新

在以下示例中，使用 org.springframework.integration.jpa.test.entity.Student 实体类作为 JPA 定义参数来持久化更新出站网关

<int-jpa:updating-outbound-gateway request-channel="entityRequestChannel"  (1)
    reply-channel="entityResponseChannel"  (2)
    entity-class="org.springframework.integration.jpa.test.entity.Student"
    entity-manager="em"/>
1 这是出站网关的请求通道。它类似于 outbound-channel-adapter 的 channel 属性。
2 这就是网关与出站适配器不同的地方。这是接收来自 JPA 操作的回复的通道。但是，如果您对收到的回复不感兴趣，只想执行操作，则使用 JPA outbound-channel-adapter 是合适的选择。在此示例中，我们使用实体类，回复是作为 JPA 操作结果创建或合并的实体对象。

使用 JPQL 更新

以下示例使用 Java 持久性查询语言 (JPQL) 更新实体，这需要使用更新出站网关

<int-jpa:updating-outbound-gateway request-channel="jpaqlRequestChannel"
  reply-channel="jpaqlResponseChannel"
  jpa-query="update Student s set s.lastName = :lastName where s.rollNumber = :rollNumber"  (1)
  entity-manager="em">
    <int-jpa:parameter name="lastName" expression="payload"/>
    <int-jpa:parameter name="rollNumber" expression="headers['rollNumber']"/>
</int-jpa:updating-outbound-gateway>
1 网关执行的 JPQL 查询。由于我们使用了更新出站网关，因此只有 update 和 delete JPQL 查询才是明智的选择。

当您发送一条消息，其消息体（String类型）包含名为rollNumber且值为long类型的头部时，系统会将指定学号的学生的姓氏更新为消息体中的值。当使用更新网关时，返回值始终为整数值，表示JPA QL执行所影响的记录数。

使用JPQL检索实体

以下示例使用检索出站网关和JPQL从数据库中检索（选择）一个或多个实体。

<int-jpa:retrieving-outbound-gateway request-channel="retrievingGatewayReqChannel"
    reply-channel="retrievingGatewayReplyChannel"
    jpa-query="select s from Student s where s.firstName = :firstName and s.lastName = :lastName"
    entity-manager="em">
    <int-jpa:parameter name="firstName" expression="payload"/>
    <int-jpa:parameter name="lastName" expression="headers['lastName']"/>
</int-jpa:outbound-gateway>

使用id-expression检索实体

以下示例使用带id-expression的检索出站网关从数据库中检索（查找）唯一的一个实体：primaryKey是id-expression评估的结果。entityClass是消息payload的类。

<int-jpa:retrieving-outbound-gateway
	request-channel="retrievingGatewayReqChannel"
    reply-channel="retrievingGatewayReplyChannel"
    id-expression="payload.id"
    entity-manager="em"/>

使用命名查询更新

使用命名查询与直接使用JPQL查询基本相同。区别在于使用了named-query属性，如下例所示。

<int-jpa:updating-outbound-gateway request-channel="namedQueryRequestChannel"
    reply-channel="namedQueryResponseChannel"
    named-query="updateStudentByRollNumber"
    entity-manager="em">
    <int-jpa:parameter name="lastName" expression="payload"/>
    <int-jpa:parameter name="rollNumber" expression="headers['rollNumber']"/>
</int-jpa:outbound-gateway>
您可以在此处找到一个使用Spring Integration的JPA适配器的完整示例应用程序。