2.12. Camel Maven 插件

Camel Maven 插件运行目标支持下列选项，它们可以从命令行（使用 -D 语法）配置，或者在 < configuration > 标签中的 pom.xml 文件中定义。

camel:run 插件还支持运行 Blueprint 应用程序，默认情况下，它会扫描 OSGI-INF/blueprint ldapsearch.xml 中的 OSGi 蓝图文件。您需要通过将 useBlueprint 设置为 true 来配置 camel:run 插件以使用蓝图，如下所示：

<plugin>
  <groupId>org.jboss.redhat-fuse</groupId>
  <artifactId>camel-maven-plugin</artifactId>
  <configuration>
    <useBlueprint>true</useBlueprint>
  </configuration>
</plugin>

这可让您引导您想要的任何蓝图服务，无论它们是否与 Camel 相关，还是任何其他蓝图。camel:run 目标可以自动检测 camel-blueprint 是否在类路径上，或者项目中是否有蓝图 XML 文件，因此您不必配置 useBlueprint 选项。

我们使用 Felix Connector 项目作为蓝图容器。此项目不是完整的蓝图容器。为此，您可以使用 Apache Karaf 或 Apache ServiceMix。您可以使用 applicationContextUri 配置来指定明确的蓝图 XML 文件，例如：

<plugin>
  <groupId>org.jboss.redhat-fuse</groupId>
  <artifactId>camel-maven-plugin</artifactId>
  <configuration>
    <useBlueprint>true</useBlueprint>
    <applicationContextUri>myBlueprint.xml</applicationContextUri>
    <!-- ConfigAdmin options which have been added since Camel 2.12.0 -->
    <configAdminPid>test</configAdminPid>
    <configAdminFileName>/user/test/etc/test.cfg</configAdminFileName>
  </configuration>
</plugin>

applicationContextUri 从 classpath 加载文件，因此，在上面的示例中，myBlueprint.xml 文件必须位于 classpath 的 root 中。configAdminPid 是 pid 名称，在加载持久性属性文件时，用作配置 admin 服务的 pid 名称。configAdminFileName 是用于加载配置 admin 服务属性文件的文件名。

camel:run 插件还支持运行 CDI 应用程序。这可让您引导所需的任何 CDI 服务，无论它们是否与 Camel 相关，还是其它启用了 CDI 的服务。您应该将您选择的 CDI 容器（如 Weld 或 OpenWebBeans）添加到 camel-maven-plugin 的依赖项中，如本例中。在 Camel 源中，您可以运行 CDI 示例，如下所示：

cd examples/camel-example-cdi
mvn compile camel:run

您可以配置在 camel:run 执行时是否应该记录 classpath。您可以使用以下方法在配置中启用：

<plugin>
  <groupId>org.jboss.redhat-fuse</groupId>
  <artifactId>camel-maven-plugin</artifactId>
  <configuration>
    <logClasspath>true</logClasspath>
  </configuration>
</plugin>

您可以配置插件来扫描 XML 文件更改，并触发在这些 XML 文件中所含的 Camel 路由重新加载。

<plugin>
  <groupId>org.jboss.redhat-fuse</groupId>
  <artifactId>camel-maven-plugin</artifactId>
  <configuration>
    <fileWatcherDirectory>src/main/resources/META-INF/spring</fileWatcherDirectory>
  </configuration>
</plugin>

然后，插件会监视此目录。这可让您从编辑器中编辑源代码并保存文件，并让运行的 Camel 应用程序使用这些更改。请注意，只有 Camel 路由的更改，如 < routes&gt; , 或 <route >。您无法更改 Spring 或 OSGi Blueprint < bean> 元素。

您还可以在任何 Maven 项目中运行 validate 目标，而无需将插件添加到 pom.xml 文件中。这样做需要使用其完全限定名称来指定插件。例如，要在 Apache Camel 的 camel-example-cdi 上运行目标，您可以运行

$cd camel-example-cdi
$mvn org.apache.camel:camel-maven-plugin:2.20.0:validate

然后运行并输出以下内容：

[INFO] ------------------------------------------------------------------------
[INFO] Building Camel :: Example :: CDI 2.20.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- camel-maven-plugin:2.20.0:validate (default-cli) @ camel-example-cdi ---
[INFO] Endpoint validation success: (4 = passed, 0 = invalid, 0 = incapable, 0 = unknown components)
[INFO] Simple validation success: (0 = passed, 0 = invalid)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

验证通过，并且验证了 4 个端点。现在，假设我们在源代码中的 Camel 端点 URI 中进行了拼写错误，例如：

@Uri("timer:foo?period=5000")

被修改为在 句点 选项中包含拼写错误

@Uri("timer:foo?perid=5000")

当再次运行 validate 目标时，会报告以下内容：

[INFO] ------------------------------------------------------------------------
[INFO] Building Camel :: Example :: CDI 2.20.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- camel-maven-plugin:2.20.0:validate (default-cli) @ camel-example-cdi ---
[WARNING] Endpoint validation error at: org.apache.camel.example.cdi.MyRoutes(MyRoutes.java:32)

	timer:foo?perid=5000

	                   perid    Unknown option. Did you mean: [period]


[WARNING] Endpoint validation error: (3 = passed, 1 = invalid, 0 = incapable, 0 = unknown components)
[INFO] Simple validation success: (0 = passed, 0 = invalid)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

Camel Maven 插件 验证 目标支持以下选项，可从命令行配置（使用 -D 语法），或者在 < configuration > 标签中的 pom.xml 文件中定义。

例如，要忽略命令行中已弃用选项的使用，您可以运行：

$mvn camel:validate -Dcamel.ignoreDeprecated=false

请注意，您必须使用 camel. 为 -D 命令参数添加前缀，例如 camel.ignore 已弃用。

如果您有 Maven 项目，则您可以运行插件来验证单元测试源代码中的端点。您可以使用 -D 风格传递选项，如下所示：

$cd myproject
$mvn org.apache.camel:camel-maven-plugin:2.20.0:validate -DincludeTest=true

您可以在运行单元测试时启用路由覆盖：

您可以打开 JVM 系统属性 CamelTestRouteCoverage，以启用所有测试案例的路由覆盖。这可以在 maven-surefire-plugin 的配置中完成：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <configuration>
    <systemPropertyVariables>
      <CamelTestRouteCoverage>true</CamelTestRouteCoverage>
    </systemPropertyVariables>
  </configuration>
</plugin>

在运行测试时，从命令行中：

mvn clean test -DCamelTestRouteCoverage=true

如果您使用 camel-test-spring 测试，您可以通过在测试类中添加 @EnableRouteCoverage 注解来启用单元测试类中的路由覆盖：

@RunWith(CamelSpringBootRunner.class)
@SpringBootTest(classes = SampleCamelApplication.class)
@EnableRouteCoverage
public class FooApplicationTest {

但是，如果您使用 camel-test，且您的单元测试正在扩展 CamelTestSupport，您可以打开路由覆盖，如下所示：

@Override
public boolean isDumpRouteCoverage() {
    return true;
}

在 RouteCoverage 方法下覆盖的路由必须具有唯一的 id，换句话说，您无法使用匿名路由。您可以使用 Java DSL 中的 routeId 完成此操作：

from("jms:queue:cheese").routeId("cheesy")
  .to("log:foo")
  ...

在 XML DSL 中，您只需通过 id 属性分配路由 ID

<route id="cheesy">
  <from uri="jms:queue:cheese"/>
  <to uri="log:foo"/>
  ...
</route>

TO 生成路由覆盖报告，运行单元测试：

mvn test

然后，您可以运行目标来报告路由覆盖，如下所示：

mvn camel:route-coverage

这会报告哪些路由缺少路由覆盖和精确的源代码行报告：

[INFO] --- camel-maven-plugin:2.21.0:route-coverage (default-cli) @ camel-example-spring-boot-xml ---
[INFO] Discovered 1 routes
[INFO] Route coverage summary:

File:	src/main/resources/my-camel.xml
RouteId:	hello

  Line #      Count   Route
  ------      -----   -----
      28          1   from
      29          1     transform
      32          1     filter
      34          0       to
      36          1     to

Coverage: 4 out of 5 (80.0%)

在这里，我们可以看到，第 2 行 排在 count 列中具有 0， 因此未涵盖。我们还可以看到这是源代码文件中的 34 行，它位于 my-camel.xml XML 文件中。

Camel Maven 插件 覆盖 目标支持下列选项，它们可以从命令行（使用 -D 语法）配置，或者在 < configuration > 标签中的 pom.xml 文件中定义。