1.4. Endpoints

概述

Apache Camel 端点是路由中的信息的来源和接收器。端点是构建块的一个一般类型:它必须满足的唯一要求是充当消息源(生成者端点)或作为邮件接收器(消费者端点)。因此,Apache Camel 中支持各种不同的端点类型,范围从协议支持端点(如 HTTP)到简单的计时器端点,如 Quartz,定期生成 dummy 消息。Apache Camel 的主要优势之一是添加实施新端点类型的自定义组件相对容易。

端点 URI

端点 URI 标识,其采用以下通用形式:

scheme:contextPath[?queryOptions]

URI 方案 标识了一个协议,如 http,context Path 提供了由协议解释的 URI 详情。另外,大多数方案都允许您定义查询选项 queryOptions,它们以以下格式指定:

?option01=value01&option02=value02&...

例如,以下 HTTP URI 可用于连接到 Google 搜索引擎页面:

http://www.google.com

以下 File URI 可用于读取 C:\temp\src\data 目录中出现的所有文件:

file://C:/temp/src/data

不是每个 方案 都代表一个协议。有时,方案 只提供对有用的实用程序的访问,如计时器。例如,以下 Timer 端点 URI 会每秒生成一个交换(=1000 毫秒)。您可以使用它来调度路由中的活动。

timer://tickTock?period=1000

使用长端点 URI

有时,因为提供了所有附带的配置信息,端点 URI 可能会非常长。在 JBoss Fuse 6.2 以后,有两种方法可使您使用冗长的 URI 更易管理。

单独配置端点

您可以单独配置端点,并从路由中使用其简写 ID 指向端点。

<camelContext ...>

  <endpoint id="foo" uri="ftp://foo@myserver">
    <property name="password" value="secret"/>
    <property name="recursive" value="true"/>
    <property name="ftpClient.dataTimeout" value="30000"/>
    <property name="ftpClient.serverLanguageCode" value="fr"/>
  </endpoint>

  <route>
    <from uri="ref:foo"/>
    ...
  </route>
</camelContext>

您还可以在 URI 中配置一些选项,然后使用 property 属性指定附加选项(或覆盖 URI 中的选项)。

<endpoint id="foo" uri="ftp://foo@myserver?recursive=true">
  <property name="password" value="secret"/>
  <property name="ftpClient.dataTimeout" value="30000"/>
  <property name="ftpClient.serverLanguageCode" value="fr"/>
</endpoint>
跨新行分割端点配置

您可以使用新行分割 URI 属性。

<route>
  <from uri="ftp://foo@myserver?password=secret&amp;
           recursive=true&amp;ftpClient.dataTimeout=30000&amp;
           ftpClientConfig.serverLanguageCode=fr"/>
  <to uri="bean:doSomething"/>
</route>
注意

您可以在每行中指定一个或多个选项,每个选项都用 和 分隔

在 URI 中指定时间段

许多 Apache Camel 组件都有其值是一个时间段(例如,指定超时值等)的选项。默认情况下,此类时间段选项通常指定为纯数字,它被解释为 millisecond 时间段。但是,对于时间周期,Apache Camel 还支持更易读的语法,这可让您以小时、分钟和秒表示周期。正式来说,人类可读的时间段是符合以下语法的字符串:

[NHour(h|hour)][NMin(m|minute)][NSec(s|second)]

其中每个术语在方括号 [] 中都是可选的,且表示法是 (A|B),表示 AB 是替代方案。

例如,您可以使用 45 分钟的时间配置计时器 端点,如下所示:

from("timer:foo?period=45m")
  .to("log:foo");

您还可以使用小时、分钟和第二个单元的任意组合,如下所示:

from("timer:foo?period=1h15m")
  .to("log:foo");
from("timer:bar?period=2h30s")
  .to("log:bar");
from("timer:bar?period=3h45m58s")
  .to("log:bar");

在 URI 选项中指定原始值

默认情况下,您在 URI 中指定的选项值会自动 URI 编码。在某些情况下,这是不必要的行为。例如,在设置密码选项时,最好在 没有 URI 编码的情况下 传输原始字符字符串。

可以通过使用语法 RAW (RawValue) 指定选项值来关闭 URI 编码。例如,

from("SourceURI")
 .to("ftp:joe@myftpserver.com?password=RAW(se+re?t&23)&binary=true")

在本例中,密码值作为字面值 se+re?t&23 传输。

区分大小写的 enum 选项

有些端点 URI 选项映射到 Java enum 常数。例如,Log 组件的 level 选项可以取 enum 值、INFOWARNERROR 等。这个类型转换是区分大小写的,因此以下任何备选方法都可用于设置 Log producer 端点的日志级别:

<to uri="log:foo?level=info"/>
<to uri="log:foo?level=INfo"/>
<to uri="log:foo?level=InFo"/>

指定 URI 资源

在 Camel 2.17 中,基于资源的组件(如 XSLT),Velociy 可以使用 ref: 作为前缀从 Registry 中加载资源文件。

例如,如果myvelocityscriptbeanmysimplescriptbean 是 registry 中两个 Bean 的 ID,您可以使用这些 Bean 的内容,如下所示:

Velocity endpoint:
------------------
from("velocity:ref:myvelocityscriptbean").<rest_of_route>.

Language endpoint (for invoking a scripting language):
-----------------------------------------------------
from("direct:start")
  .to("language:simple:ref:mysimplescriptbean")
 Where Camel implicitly converts the bean to a String.

Apache Camel 组件

每个 URI 方案 都映射到 Apache Camel 组件,其中 Apache Camel 组件基本上是一个端点工厂。换句话说,要使用特定类型的端点,您必须在运行时容器中部署对应的 Apache Camel 组件。例如,若要使用 JMS 端点,您要在容器中部署 JMS 组件。

Apache Camel 提供了大量不同的组件,可让您将应用程序与各种传输协议和第三方产品集成。例如,一些较常用的组件有:file、JMS、cxf (Web 服务)、HTTP、Jetty、Direct 和 Mock。有关支持组件的完整列表,请查看 Apache Camel 组件文档

大多数 Apache Camel 组件都单独打包到 Camel 内核。如果使用 Maven 构建应用程序,只需添加相关组件工件的依赖关系,即可轻松将组件(及其第三方依赖项)添加到应用程序中。例如,要包含 HTTP 组件,您可以在项目 POM 文件中添加以下 Maven 依赖项:

<!-- Maven POM File -->
  <properties>
    <camel-version>{camelFullVersion}</camel-version>
    ...
  </properties>

  <dependencies>
    ...
    <dependency>
      <groupId>org.apache.camel</groupId>
      <artifactId>camel-http</artifactId>
      <version>${camel-version}</version>
    </dependency>
    ...
  </dependencies>

以下组件内置到 Camel 内核(在 camel-core 工件中),因此它们始终可用:

  • Bean
  • 浏览
  • dataset
  • 直接
  • File
  • Log
  • Mock
  • Properties
  • Ref
  • SEDA
  • 计时器
  • VM

消费者端点

消费者端点 是在路由 开始 时出现的端点(即,在 from () DSL 命令中)。换句话说,使用者端点负责启动路由中的处理:它会创建一个新的交换实例(通常基于它收到或获取的一些消息),并提供线程来处理其余路由中的交换。

例如,以下 JMS 消费者端点从 支付 队列拉取消息并在路由中处理它们:

from("jms:queue:payments")
  .process(SomeProcessor)
  .to("TargetURI");

或者相当于在 Spring XML 中:

<camelContext id="CamelContextID"
              xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="jms:queue:payments"/>
    <process ref="someProcessorId"/>
    <to uri="TargetURI"/>
  </route>
</camelContext>

有些组件 只能是 消费者的,它只能用于定义消费者端点。例如,Qartz 组件专门用于定义消费者端点。以下 Quartz 端点每秒生成一个事件(1000 毫秒):

from("quartz://secondTimer?trigger.repeatInterval=1000")
  .process(SomeProcessor)
  .to("TargetURI");

如果您愿意,您可以使用 fromF () Java DSL 命令将端点 URI 指定为格式化的字符串。例如,要将用户名和密码替换为 FTP 端点的 URI 中,您可以使用 Java 编写路由,如下所示:

fromF("ftp:%s@fusesource.com?password=%s", username, password)
  .process(SomeProcessor)
  .to("TargetURI");

其中第一次出现 %s用户名 字符串的值替代,第二次出现 %s 替换为 密码字符串。这个字符串格式化机制由 String.format () 实施,它类似于 C printf () 函数提供的格式。详情请参阅 java.util.Formatter

生成者端点

producer 端点 是一个端点,它出现在路由 的末尾或路由末尾 (例如,在 to () DSL 命令中)。换句话说,producer 端点接收现有的交换对象,并将交换的内容发送到指定的端点。

例如,以下 JMS producer 端点将当前交换的内容推送到指定的 JMS 队列中:

from("SourceURI")
  .process(SomeProcessor)
  .to("jms:queue:orderForms");

或者等同于 Spring XML:

<camelContext id="CamelContextID" xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="SourceURI"/>
    <process ref="someProcessorId"/>
    <to uri="jms:queue:orderForms"/>
  </route>
</camelContext>

有些组件 只是生成者 ,它只是用于定义制作者端点。例如,HTTP 端点专门用于定义制作者端点。

from("SourceURI")
  .process(SomeProcessor)
  .to("http://www.google.com/search?hl=en&q=camel+router");

如果您愿意,您可以使用 toF () Java DSL 命令将端点 URI 指定为格式化的字符串。例如,要将自定义 Google 查询替换为 HTTP URI,您可以在 Java 中写入路由,如下所示:

from("SourceURI")
  .process(SomeProcessor)
  .toF("http://www.google.com/search?hl=en&q=%s", myGoogleQuery);

如果出现 %s 被您的自定义查询字符串( myGoogleQuery )替代。详情请参阅 java.util.Formatter