32.4. 配置选项


Camel 组件在两个独立级别上配置:

  • 组件级别
  • 端点级别

32.4.1. 配置组件选项

组件级别是最高级别,它包含端点继承的常规配置。例如,一个组件可能具有安全设置、用于身份验证的凭证、用于网络连接的 url 等等。

某些组件只有几个选项,其他组件可能会有许多选项。由于组件通常已配置了常用的默认值,因此通常只需要在组件上配置几个选项,或者根本不需要配置任何选项。

可以在配置文件(application.properties|yaml)中使用 组件 DSL 配置组件,也可直接使用 Java 代码完成。

32.4.2. 配置端点选项

您发现自己在端点上配置了一个,因为端点通常有许多选项,允许您配置您需要的端点。这些选项被分别分类为:端点作为消费者(来自)被使用,和作为生成者(到)使用,或被两者使用。

配置端点通常在端点 URI 中作为路径和查询参数直接进行。您还可以使用 Endpoint DSL 作为配置端点的安全方法。

在配置选项时,最好使用 Property Placeholders,它不允许硬编码 URL、端口号、敏感信息和其他设置。换句话说,占位符允许从您的代码外部配置,并提供更多灵活性和重复使用。

以下两节列出了所有选项,首为于组件,后跟端点。

32.4.3. 组件选项

JPA 组件支持 9 个选项,如下所列。

Name描述默认值类型

alias (common)

将别名映射到 JPA 实体类。然后可在端点 URI 中使用别名(而不是完全限定的类名称)。

 

Map

entityManagerFactory (common)

使用 EntityManagerFactory。强烈建议您进行配置。

 

EntityManagerFactory

加入事务 (common)

camel-jpa 组件默认将加入事务。您可以使用此选项关闭此选项,例如,如果您使用 LOCAL_RESOURCE 并加入事务无法与您的 JPA 供应商一起使用。这个选项也可以在 JpaComponent 上全局设置,而不必在所有端点上设置它。

true

布尔值

sharedEntityManager (common)

是否将 Spring 的 SharedEntityManager 用于 consumer/producer。请注意,在大多数情况下,加入事务应设为 false,因为这不是 EXTENDED EntityManager。

false

布尔值

transactionManager (common)

使用 PlatformTransactionManager 管理事务。

 

PlatformTransactionManager

transactionStrategy (common)

使用 TransactionStrategy 在事务中运行操作。

 

TransactionStrategy

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。

false

布尔值

lazyStartProducer (producer)

生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。

false

布尔值

autowiredEnabled (advanced)

是否启用自动关闭。这用于自动关闭选项(选项必须标记为 autowired),方法是在 registry 中查找查找是否有单个匹配类型实例,然后在组件上配置。这可以用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。

true

布尔值

32.4.4. 端点选项

JPA 端点使用 URI 语法进行配置:

jpa:entityType

使用以下路径和查询参数:

32.4.4.1. 路径参数(1 参数)

Name描述默认值类型

entityType (common)

所需的 实体类名称。

 

32.4.4.2. 查询参数(44 参数)

Name描述默认值类型

加入事务 (common)

camel-jpa 组件默认将加入事务。您可以使用此选项关闭此选项,例如,如果您使用 LOCAL_RESOURCE 并加入事务无法与您的 JPA 供应商一起使用。这个选项也可以在 JpaComponent 上全局设置,而不必在所有端点上设置它。

true

布尔值

maximumResults (common)

设置在 Query 上检索的最大结果数。

-1

int

namedQuery (common)

使用命名的查询:

 

字符串

nativeQuery (common)

使用自定义原生查询。在使用原生查询时,您可能还希望使用 resultClass 选项。

 

字符串

persistenceUnit (common)

必需 默认使用的 JPA 持久性单元。

camel

字符串

query (common)

使用自定义查询,请执行以下操作:

 

字符串

resultClass (common)

定义返回的有效负载的类型(we will call entityManager.createNativeQuery (nativeQuery, resultClass)而不是 entityManager.createNativeQuery (nativeQuery)。如果没有这个选项,我们将返回对象数组。在消耗数据时,仅与原生查询结合使用时才有影响。

 

consumeDelete (consumer)

如果为 true,实体会在被使用后删除;如果为 false,则不会删除实体。

true

布尔值

consumeLockEntity (consumer)

指定在处理轮询结果时,是否在每个实体 bean 上设置专用锁定。

true

布尔值

deleteHandler (consumer)

使用自定义 DeleteHandler 在消费者处理交换后删除行。

 

DeleteHandler

lockModeType (consumer)

在消费者上配置锁定模式。

Enum 值:

  • READ
  • OPTIMISTIC
  • OPTIMISTIC_FORCE_INCREMENT
  • PESSIMISTIC_READ
  • PESSIMISTIC_WRITE
  • PESSIMISTIC_FORCE_INCREMENT
  • NONE

PESSIMISTIC_WRITE

LockModeType

maxMessagesPerPoll (consumer)

整数值,用于定义每个轮询要收集的最大消息数。默认情况下,不会设置最大值。可用于避免在启动服务器时轮询许多数千个消息。将值设为 0 或负数设置为 disable。

 

int

preDeleteHandler (consumer)

使用自定义 Pre-DeleteHandler 在消费者读取实体后删除行。

 

DeleteHandler

sendEmptyMessageWhenIdle (consumer)

如果轮询使用者没有轮询任何文件,您可以启用此选项来发送空消息(无正文)。

false

布尔值

skipLockedEntity (consumer)

要配置是否在锁定时使用 NOWAIT,并静默跳过实体。

false

布尔值

Transacted (consumer)

是否以转换模式运行消费者,在处理整个批处理时,所有消息都将提交或回滚。默认行为(false)是提交所有之前成功处理的消息,仅回滚最后的消息。

false

布尔值

bridgeErrorHandler (consumer (advanced))

允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。

false

布尔值

exceptionHandler (consumer (advanced))

要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。

 

ExceptionHandler

exchangePattern (consumer (advanced))

在消费者创建交换时设置交换模式。

Enum 值:

  • InOnly
  • InOut
  • InOptionalOut
 

ExchangePattern

参数 (consumer (advanced))

此键/值映射用于构建查询参数。它应该是通用类型 java.util.Map,其中键是给定 JPA 查询的命名参数,值是您要选择它们的对应有效值。当它用于制作者时,可将简单表达式用作参数值。它允许您从消息正文、标头等检索参数值。

 

Map

pollStrategy (consumer (advanced))

可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理,然后再创建交换并在 Camel 中路由。

 

PollingConsumerPollStrategy

findEntity (producer)

如果启用,则制作者将使用消息正文作为 key 和 entityType 作为类类型来查找单个实体。这可用而不是查询来查找单个实体。

false

布尔值

flushOnSend (producer)

在实体 Bean 保留后清除 EntityManager。

true

布尔值

remove (producer)

表示使用 entityManager.remove (entity)。

false

布尔值

useExecuteUpdate (producer)

配置在制作者执行查询时使用 executeUpdate ()。当使用 INSERT、UPDATE 或 DELETE 语句作为命名查询时,您需要将这个选项指定为 'true'。

 

布尔值

usePersist (producer)

表示使用 entityManager.persist (entity)而不是 entityManager.merge (entity)。注意: EntityManager.persist (entity)不适用于分离实体(其中 EntityManager 必须执行 UPDATE 而不是 INSERT 查询)!。

false

布尔值

lazyStartProducer (producer (advanced))

生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。

false

布尔值

usePassedInEntityManager (producer (advanced))

如果设置为 true,则 Camel 将使用标头 JpaConstants.ENTITY_MANAGER 中的 EntityManager,而不是组件/端点上配置的实体管理器。这允许最终用户控制将使用哪些实体管理器。

false

布尔值

entityManagerProperties (advanced)

要使用的实体管理器的其他属性。

 

Map

sharedEntityManager (advanced)

是否将 Spring 的 SharedEntityManager 用于 consumer/producer。请注意,在大多数情况下,加入事务应设为 false,因为这不是 EXTENDED EntityManager。

false

布尔值

backoffErrorThreshold (scheduler)

在 backoffMultipler 应该 kick-in 之前发生的后续错误轮询(因为某些错误)的数量。

 

int

backoffIdleThreshold (scheduler)

在 backoffMultipler 应该 kick-in 之前应该发生的后续空闲轮询数量。

 

int

backoffMultiplier (scheduler)

如果一行中有很多后续空闲/errors,则让调度的轮询消费者避退。然后,倍数是在下一次实际尝试再次发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。

 

int

delay (scheduler)

下一次轮询前的时间(毫秒)。

500

long

greedy (scheduler)

如果启用了 greedy,如果上一个运行轮询 1 或更多消息,则 ScheduledPollConsumer 将立即运行。

false

布尔值

initialDelay (scheduler)

第一次轮询开始前的毫秒。

1000

long

repeatCount (scheduler)

指定触发的最大数量。因此,如果您将其设置为 1,调度程序将只触发一次。如果您将其设置为 5,它将只触发五次。值为零或负数表示会永久触发。

0

long

runLoggingLevel (scheduler)

消费者在轮询时记录 start/complete log 行。这个选项允许您为其配置日志级别。

Enum 值:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • OFF

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

允许配置用于消费者的自定义/共享线程池。默认情况下,每个使用者都有自己的单线程线程池。

 

ScheduledExecutorService

scheduler (scheduler)

要使用 camel-spring 或 camel-quartz 组件的 cron 调度程序。使用值 spring 或 quartz 用于内置在调度程序中。

none

对象

schedulerProperties (scheduler)

在使用自定义调度程序或任何基于 Spring 的调度程序时配置附加属性。

 

Map

startScheduler (scheduler)

调度程序是否应自动启动。

true

布尔值

timeUnit (scheduler)

initialDelay 和 delay 选项的时间单位。

Enum 值:

  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。

true

布尔值

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.