此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Integration 6.5.1spring-doc.cadn.net.cn

入站通道适配器

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

<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在执行 JPA QL 后将消息(带有有效负载)放在query属性。
2 EntityManager用于执行所需 JPA作的实例。
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 将此值设置为true如果要在删除收到的实体后立即刷新持久性上下文,并且不想依赖flushModeEntityManager. 该值默认为false.

配置参数参考

以下列表显示了可以为inbound-channel-adapter:spring-doc.cadn.net.cn

<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 的实例jakarta.persistence.EntityManager用于执行 JPA作。 自选。
7 的实例jakarta.persistence.EntityManagerFactory用于获取jakarta.persistence.EntityManager执行 JPA作。 自选。
8 一个布尔标志,指示 select作是返回单个结果还是List结果。 如果此标志设置为true,则选定的单个实体将作为消息的有效负载发送。 如果返回多个实体,则会引发异常。 如果falseList的实体作为消息的有效负载发送。 该值默认为false. 自选。
9 实现org.springframework.integration.jpa.core.JpaOperations用于执行 JPA作。 我们建议不要提供自己的实现,而是使用默认的org.springframework.integration.jpa.core.DefaultJpaOperations实现。 您可以使用任何entity-manager,entity-manager-factoryjpa-operations属性。 自选。
10 要由此适配器执行的 JPA QL。 自选。
11 此适配器需要执行的命名查询。 自选。
12 此适配器执行的本机查询。 您可以使用任何jpa-query,named-query,entity-classnative-query属性。 自选。
13 实现o.s.i.jpa.support.parametersource.ParameterSource用于解析查询中参数的值。 如果entity-class属性有一个值。 自选。
14 向通道发送消息时等待的最大时间(以毫秒为单位)。 自选。

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置入站适配器的示例:spring-doc.cadn.net.cn

@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 配置入站适配器的示例:spring-doc.cadn.net.cn

@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();
    }

}