第 45 章 API 组件框架简介

对于包含少量选项的组件，实施组件(第 38 章 实施组件)的标准方法非常有效。然而，它开始成为问题，那就是您需要实施具有大量选项的组件。当涉及到企业级组件时，这个问题会变得显著，这需要您嵌套一个由 数百个 操作组成的 API。这些组件需要大量努力来创建和维护。

API 组件框架经过精确开发，以应对实施此类组件的挑战。

基于 Java API 实施 Camel 组件的经验表明，很多工作是日常工作和机械。它由使用特定的 Java 方法组成，将其映射到特定的 URI 语法，并让用户通过 URI 选项设置方法参数。这种类型的工作是自动化和代码生成候选者。

自动执行 Java API 的第一步是设计将 API 方法映射到 URI 的标准方式。对于这一点，我们需要定义一个通用 URI 格式，可用于嵌套 任何 Java API。因此，API 组件框架定义了端点 URI 的以下语法：

scheme://endpoint-prefix/endpoint?Option1=Value1&...&OptionN=ValueN

方案是组件定义的默认 URI 方案； 端点前缀 是一个简短的 API 名称，它映射到嵌套的 Java API 中的其中一个类或接口； 端点 映射到方法名称，URI 选项映射到方法参数名称。

如果 API 仅由一个 Java 类组成，则 URI 的端点 前缀 部分会变为冗余，且您可以在以下格式指定 URI：

scheme://endpoint?Option1=Value1&...&OptionN=ValueN

要将 Java 方法调用映射到 URI 语法，很明显，需要一些反射机制。但是，标准的 Java 反映了 API 遭遇一个显著限制：它不会保留方法参数名称。这是一个问题，因为我们需要方法参数名称来生成有意义的 URI 选项名称。该解决方案以其他格式提供元数据：作为 Javadoc 或方法签名文件。

javadoc 是用于 API 组件框架的理想元数据形式，因为它保留完整的方法签名，包括方法参数名称。也可以在第三方库中提供（通常使用 maven-javadoc-plugin）和 （许多情形中）生成很容易。

如果出于某种原因，Javadoc 不可用或不适合，API 组件框架也支持替代元数据源：方法签名文件。签名文件是一个简单文本文件，由 Java 方法签名列表组成。从 Java 代码中复制和粘贴，可以方便地手动创建这些文件（并简单编辑生成的文件）。

从组件开发人员的角度来看，API 组件框架由多个不同元素组成，如下所示：