1.4. Endpoints

概述

Apache Camel 端点是路由中消息的源和接收器。端点是一个非常通用的构建块类型：它必须满足的唯一要求是它充当消息源（生产者端点）或消息接收器（消费者端点）。因此，Apache Camel 支持各种不同的端点类型，范围从协议支持端点（如 HTTP）到简单的计时器端点，如 Quartz，它会定期生成 dummy 消息。Apache Camel 的主要优势之一是添加实施新端点类型的自定义组件相对简单。

端点 URI

端点通过 端点 URI 来标识，其具有以下通用形式：

scheme:contextPath[?queryOptions]

URI 方案标识了协议，如 http，而 contextPath 提供协议解释的 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

使用 Long Endpoint 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 组件都有选项，其值是一个时间段（例如，指定超时值等）。默认情况下，此类时间段选项通常指定为纯数字，它被解释为毫秒的时间段。但是 Apache Camel 还支持更易读的语法，用于按小时、分钟和秒表示周期。正式来说，人类可读的时间段是一个符合以下语法的字符串：

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

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

例如，您可以使用 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 编码。在某些情况下，这是不必要的行为。例如，在设置 password 选项时，最好在 没有 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 值、INFO、WARN、ERROR 等。这个类型转换是不区分大小写的，因此以下任意一种替代方法可用于设置 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）可以使用 ref: 作为前缀从 Registry 中加载资源文件。

例如，myvelocityscriptbean 和 mysimplescriptbean 是 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
direct
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 被 username 字符串的值替换，第二个出现的 %s 将被密码字符串替代。这个字符串格式化机制通过 String.format （） 实施，它与 C printf （） 函数提供的格式类似。详情请参阅 java.util.Formatter。

制作者端点

producer 端点 是出现在中间或路由 末尾的 端点（例如，在 to （） DSL 命令中）。换句话说，生成者端点接收现有的交换对象，并将交换内容发送到指定的端点。

例如，以下 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。