2.10. 调度的路由策略

调度的路由策略可用于触发在运行时影响路由的事件。特别是，当前可用的实现可让您在策略指定的任何时间（或时间）启动、停止、挂起或恢复路由。

调度的路由策略能够触发以下类型的事件：

Quartz 组件是一个计时器组件，基于 Terracotta 的 Quartz，它是作业调度程序的开源实施。Quartz 组件为简单的调度路由策略和 cron 调度的路由策略提供底层实施。

简单的调度路由策略是一个路由策略，可让您启动、停止、挂起和恢复路由，通过提供初始事件的时间和日期来定义这些事件的时间和日期（可选）。要定义一个简单的调度路由策略，请创建以下类实例：

org.apache.camel.routepolicy.quartz.SimpleScheduledRoutePolicy

简单的调度路由策略依赖于 Quartz 组件 camel-quartz。例如，如果您使用 Maven 作为构建系统，则需要添加对 camel-quartz 工件的依赖项。

例 2.7 “Simple Scheduled Route 的 Java DSL 示例” 演示了如何调度路由以使用 Java DSL 启动。初始开始时间( startTime )被定义为当前时间后面的 3 秒。该策略也被配置为在初始开始时间后启动路由 3 秒，该时间通过将 routeStartRepeatCount 设置为 1，并将 routeStartRepeatInterval 设置为 3000 毫秒。

在 Java DSL 中，您可以通过调用路由中的 routePolicy （） DSL 命令将路由策略附加到路由。

// Java
SimpleScheduledRoutePolicy policy = new SimpleScheduledRoutePolicy();
long startTime = System.currentTimeMillis() + 3000L;
policy.setRouteStartDate(new Date(startTime));
policy.setRouteStartRepeatCount(1);
policy.setRouteStartRepeatInterval(3000);

from("direct:start")
   .routeId("test")
   .routePolicy(policy)
   .to("mock:success");

例 2.8 “Simple Scheduled Route 的 XML DSL 示例” 演示了如何调度路由以使用 XML DSL 启动。

在 XML DSL 中，您可以通过设置 route 元素上的 routePolicyRef 属性将 路由 策略附加到路由。

<bean id="date" class="java.util.Data"/>

<bean id="startPolicy" class="org.apache.camel.routepolicy.quartz.SimpleScheduledRoutePolicy">
    <property name="routeStartDate" ref="date"/>
    <property name="routeStartRepeatCount" value="1"/>
    <property name="routeStartRepeatInterval" value="3000"/>
</bean>

<camelContext xmlns="http://camel.apache.org/schema/spring">
    <route id="myroute" routePolicyRef="startPolicy">
        <from uri="direct:start"/>
        <to uri="mock:success"/>
    </route>
</camelContext>

简单调度路由策略中使用的触发器的初始时间使用 java.util.Date 类型指定。定义 Date 实例的最灵活的方法是通过 java.util.GregorianCalendar 类。使用 GregorianCalendar 类的方便构造器和方法来定义日期，然后通过调用 GregorianCalendar.getTime （） 获取 日期 实例。

例如，要定义 2011 年 1 月 1 日的时间和日期，请致电 GregorianCalendar 结构，如下所示：

// Java
import java.util.GregorianCalendar;
import java.util.Calendar;
...
GregorianCalendar gc = new GregorianCalendar(
    2011,
    Calendar.JANUARY,
    1,
    12,  // hourOfDay
    0,   // minutes
    0    // seconds
);

java.util.Date triggerDate = gc.getTime();

GregorianCalendar 类也支持在不同时区中定义时间。默认情况下，它使用您计算机上的本地时区。

当您配置一个简单的调度路由策略来停止路由时，路由停止算法会自动与安全关闭流程集成（请参阅 第 2.9 节 “控制路由启动和关闭”）。这意味着，该任务在关闭路由前等待当前交换完成处理。您可以设置超时，它会强制路由在指定时间后停止，无论路由是否完成处理交换。

如果安全关闭无法在给定超时时间内完全关闭，则 Apache Camel 会执行更积极的关闭。它强制路由、threadpools 等关闭。

超时后，Apache Camel 会记录有关当前动态交换的信息。它记录交换的来源和当前的交换路由。

例如，以下日志显示有一个 inflight 交换，来自 route1 的来源，目前位于 delay1 节点的同一 route1 中。

在安全关闭过程中，如果您在 org.apache.camel.impl.DefaultShutdownStrategy 上启用 DEBUG 日志记录级别，则它会记录相同的 inflight Exchange 信息。

2015-01-12 13:23:23,656 [- ShutdownTask] INFO DefaultShutdownStrategy - There are 1 inflight exchanges:
InflightExchange: [exchangeId=ID-davsclaus-air-62213-1421065401253-0-3, fromRouteId=route1, routeId=route1, nodeId=delay1, elapsed=2007, duration=2017]

如果您不想查看这些日志，您可以通过将 logInflightExchangesOnTimeout 选项设置为 false 来关闭这个日志。

  context.getShutdownStrategegy().setLogInflightExchangesOnTimeout(false);

您可以使用简单的调度路由策略来定义以下一个或多个调度任务：

下表列出了调度一个或多个路由启动的参数。

下表列出了调度一个或多个路由停止的参数。

下表列出了调度路由一次或多次使用的参数。

下表列出了用于调度路由一次或多次恢复的参数。

cron 调度的路由策略是一个路由策略，可让您启动、停止、挂起和恢复路由，其中这些事件的时间使用 cron 表达式指定。要定义 cron 调度的路由策略，请创建以下类实例：

org.apache.camel.routepolicy.quartz.CronScheduledRoutePolicy

简单的调度路由策略依赖于 Quartz 组件 camel-quartz。例如，如果您使用 Maven 作为构建系统，则需要添加对 camel-quartz 工件的依赖项。

例 2.9 “Cron Scheduled Route 的 Java DSL 示例” 演示了如何调度路由以使用 Java DSL 启动。该策略配置有 cron 表达式 \*/3 * * * * ??，每 3 秒触发一次启动事件。

在 Java DSL 中，您可以通过调用路由中的 routePolicy （） DSL 命令将路由策略附加到路由。

// Java
CronScheduledRoutePolicy policy = new CronScheduledRoutePolicy();
policy.setRouteStartTime("*/3 * * * * ?");

from("direct:start")
    .routeId("test")
    .routePolicy(policy)
    .to("mock:success");;

例 2.10 “Cron Scheduled Route 的 XML DSL 示例”演示了如何调度路由以使用 XML DSL 启动。

在 XML DSL 中，您可以通过设置 route 元素上的 routePolicyRef 属性将 路由 策略附加到路由。

<bean id="date" class="org.apache.camel.routepolicy.quartz.SimpleDate"/>

<bean id="startPolicy" class="org.apache.camel.routepolicy.quartz.CronScheduledRoutePolicy">
    <property name="routeStartTime" value="*/3 * * * * ?"/>
</bean>

<camelContext xmlns="http://camel.apache.org/schema/spring">
    <route id="testRoute" routePolicyRef="startPolicy">
        <from uri="direct:start"/>
        <to uri="mock:success"/>
    </route>
</camelContext>

cron 表达式 语法在 UNIX cron 工具中包含其起源，这会调度在 UNIX 系统上在后台运行的作业。cron 表达式是通配符日期和时间的语法，可让您定期指定单个事件或多个事件。

cron 表达式由以下顺序包括 6 或 7 个字段：

Seconds Minutes Hours DayOfMonth Month DayOfWeek [Year]

Year 字段是可选的，通常会被忽略，除非您想定义仅一次和一次发生的事件。每个字段都由一个字面字符和特殊字符的组合组成。例如，以下 cron 表达式指定每天在午夜触发一次的事件：

0 0 24 * * ?

* 字符是一个通配符，与字段的每个值匹配。因此，前面的表达式与每月的每天匹配。? 字符是一个 dummy 占位符，表示 *ignore this field*。它始终会出现在 DayOfMonth 字段或 DayOfWeek 字段中，因为它无法同时指定这两个字段。例如，如果要调度一个每天触发一次的事件，但只能从 Monday 到 Friday，请使用以下 cron 表达式：

0 0 24 ? * MON-FRI

其中连字符字符指定范围 MON-FRI。您还可以使用正斜杠字符 / 指定递增。例如，要指定事件每 5 分钟触发一次，请使用以下 cron 表达式：

0 0/5 * * * ?

有关 cron 表达式语法的完整说明，请参阅 CRON 表达式 的 Wikipedia 文章。

您可以使用 cron 调度的路由策略来定义以下一个或多个调度任务：

下表列出了调度一个或多个路由启动的参数。

下表列出了调度一个或多个路由停止的参数。

下表列出了调度路由一次或多次使用的参数。

下表列出了用于调度路由一次或多次恢复的参数。

从 Camel 2.14 开始提供

如果要为每个路由使用路由策略，您可以使用 org.apache.camel.spi.RoutePolicyFactory 作为每个路由创建 RoutePolicy 实例的工厂。当您想为每个路由使用相同的路由策略时，可以使用此选项。然后，您只需要配置工厂一次，创建的每个路由都会分配策略。

CamelContext 上有 API 添加工厂，如下所示：

context.addRoutePolicyFactory(new MyRoutePolicyFactory());

从 XML DSL 中，您只能使用工厂定义 <bean >

<bean id="myRoutePolicyFactory" class="com.foo.MyRoutePolicyFactory"/>

factory 包含用于创建路由策略的 createRoutePolicy 方法。

/**
 * Creates a new {@link org.apache.camel.spi.RoutePolicy} which will be assigned to the given route.
 *
 * @param camelContext the camel context
 * @param routeId      the route id
 * @param route        the route definition
 * @return the created {@link org.apache.camel.spi.RoutePolicy}, or <tt>null</tt> to not use a policy for this route
 */
RoutePolicy createRoutePolicy(CamelContext camelContext, String routeId, RouteDefinition route);

请注意，您可以根据需要拥有多个路由策略工厂。只需再次调用 addRoutePolicyFactory，或者在 XML 中将其他工厂声明为 &lt ;bean& gt;。