入站通道适配器

入站通道适配器用于使用 JPA QL 对数据库执行 select 查询并返回结果。消息有效负载可以是单个实体或实体的 List。以下 XML 配置了 inbound-channel-adapter

<int-jpa:inbound-channel-adapter channel="inboundChannelAdapterOne"  (1)
                    entity-manager="em"                              (2)
                    auto-startup="true"                              (3)
                    query="select s from Student s"                  (4)
                    expect-single-result="true"                      (5)
                    max-results=""                                   (6)
                    max-results-expression=""                        (7)
                    delete-after-poll="true"                         (8)
                    flush-after-delete="true">                       (9)
    <int:poller fixed-rate="2000" >
      <int:transactional propagation="REQUIRED" transaction-manager="transactionManager"/>
    </int:poller>
</int-jpa:inbound-channel-adapter>
1 inbound-channel-adapter 在执行 query 属性中的 JPA QL 后放置消息（带有有效负载）的通道。
2 用于执行所需 JPA 操作的 EntityManager 实例。
3 属性指示组件在应用程序上下文启动时是否应自动启动。该值默认为 true。
4 其结果作为消息有效负载发送的 JPA QL
5 此属性指示 JPQL 查询是否在结果中给出单个实体或实体的 List。如果该值设置为 true，则单个实体将作为消息的有效负载发送。但是，如果在将此设置为 true 后返回多个结果，则会抛出 MessagingException。该值默认为 false。
6 此非零非负整数值告诉适配器在执行选择操作时不要选择超过给定数量的行。默认情况下，如果未设置此属性，则查询将选择所有可能的记录。此属性与 max-results-expression 互斥。可选。
7 一个表达式，用于计算结果集中最大结果数。与 max-results 互斥。可选。
8 如果要删除查询执行后收到的行，请将此值设置为 true。您必须确保组件作为事务的一部分运行。否则，您可能会遇到异常，例如：java.lang.IllegalArgumentException: Removing a detached instance …​
9 如果要在删除接收到的实体后立即刷新持久化上下文，并且不想依赖于 EntityManager 的 flushMode，请将此值设置为 true。该值默认为 false。

配置参数参考

以下列表显示了可以为 inbound-channel-adapter 设置的所有值。

<int-jpa:inbound-channel-adapter
  auto-startup="true"           (1)
  channel=""                    (2)
  delete-after-poll="false"     (3)
  delete-per-row="false"        (4)
  entity-class=""               (5)
  entity-manager=""             (6)
  entity-manager-factory=""     (7)
  expect-single-result="false"  (8)
  id=""
  jpa-operations=""             (9)
  jpa-query=""                  (10)
  named-query=""                (11)
  native-query=""               (12)
  parameter-source=""           (13)
  send-timeout="">              (14)
  <int:poller ref="myPoller"/>
 </int-jpa:inbound-channel-adapter>
1 此生命周期属性指示此组件在应用程序上下文启动时是否应自动启动。此属性默认为 true。可选。
2 适配器将执行所需 JPA 操作后，将带有有效负载的消息发送到的通道。
3 一个布尔标志，指示是否在适配器轮询后删除选定的记录。默认情况下，该值为 false（即，不删除记录）。您必须确保组件作为事务的一部分运行。否则，您可能会遇到异常，例如：java.lang.IllegalArgumentException: Removing a detached instance …​。可选。
4 一个布尔标志，指示是否可以批量删除记录，或者必须一次删除一条记录。默认情况下，该值为 false（即，可以批量删除记录）。可选。
5 要从数据库中查询的实体类的完全限定名称。适配器会根据实体类名称自动构建 JPA 查询。可选。
6 用于执行 JPA 操作的 jakarta.persistence.EntityManager 实例。可选。
7 用于获取 jakarta.persistence.EntityManager 实例的 jakarta.persistence.EntityManagerFactory 实例，该实例执行 JPA 操作。可选。
8 一个布尔标志，指示选择操作预期返回单个结果还是结果的 List。如果此标志设置为 true，则将选定的单个实体作为消息的有效负载发送。如果返回多个实体，则会抛出异常。如果为 false，则将实体的 List 作为消息的有效负载发送。该值默认为 false。可选。
9 用于执行 JPA 操作的 org.springframework.integration.jpa.core.JpaOperations 实现。我们建议不要提供您自己的实现，而是使用默认的 org.springframework.integration.jpa.core.DefaultJpaOperations 实现。您可以使用任何 entity-manager、entity-manager-factory 或 jpa-operations 属性。可选。
10 此适配器要执行的 JPA QL。可选。
11 此适配器需要执行的命名查询。可选。
12 此适配器执行的原生查询。您可以使用任何 jpa-query、named-query、entity-class 或 native-query 属性。可选。
13 用于解析查询中参数值的 o.s.i.jpa.support.parametersource.ParameterSource 实现。如果 entity-class 属性有值，则忽略。可选。
14 将消息发送到通道时等待的最大时间（以毫秒为单位）。可选。

使用 Java 配置进行配置

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

@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");
        return executor;
    }

    @Bean
    @InboundChannelAdapter(channel = "jpaInputChannel",
                     poller = @Poller(fixedDelay = "${poller.interval}"))
    public MessageSource<?> jpaInbound() {
        return new JpaPollingChannelAdapter(jpaExecutor());
    }

    @Bean
    @ServiceActivator(inputChannel = "jpaInputChannel")
    public MessageHandler handler() {
        return message -> System.out.println(message.getPayload());
    }

}

使用 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 pollingAdapterFlow() {
        return IntegrationFlow
            .from(Jpa.inboundAdapter(this.entityManagerFactory)
                        .entityClass(StudentDomain.class)
                        .maxResults(1)
                        .expectSingleResult(true),
                e -> e.poller(p -> p.trigger(new OnlyOnceTrigger())))
            .channel(c -> c.queue("pollingResults"))
            .get();
    }

}