Apache Camel源码研究之集成到SpingBoot

迈不过友情╰ 2022-02-09 07:56 554阅读 0赞

> 本文主要就Apache Camel提供的SpringBoot支持作一些分析和深入了解，方便以后更加灵活地应用。

### 1. 概述 ###

本文主要主要关注Apache Camel集成SpringBoot时候提供的三方面功能：AutoConfig，Actuate以及其他一些细节。至于SpringBoot的初步入门相关配置，读者可以直接查阅本文底部给出的官方文档链接，这里就不多赘述了。

### 2. 自动化配置 ###

关于SpringBoot的自动化配置原理，可以参见笔者之前的一篇博客[SpringBoot源码解析之AutoConfiguration][SpringBoot_AutoConfiguration]，因此本小节接下来我们将直接切入主题，看看Apache Camel的相关处理逻辑。

通过翻阅`camel-spring-boot-2.21.3.jar`源码下的`META-INF/spring.factories`文件，我们可以定位到相关类`CamelAutoConfiguration`，下面将列出由其定义的创建核心Bean的几个方法。

##### 2.1 `camelContext()` #####

该方法负责创建在Apache Camel起着灵魂中枢作用的`CamelContext`实例（这里无疑就是`SpringCamelContext`了），对于该方法，推荐读者仔细阅读下其回调的`doConfigureCamelContext()`方法——该方法中对`CamelContext`提供的诸多扩展点进行了详尽的示例，通过阅读这些实现，你可以对`CamelContext`的扩展机制有一个全面的了解，也就能为未来的需求变更打下非常好的基础。

也正是因为此方法注册到Spring容器中的`CamelContext`实例，我们可以在需要的位置直接使用以下代码来获取其实例以完成相关需求。

@Autowired
    private CamelContext camelContext;

##### 2.2 `camelBeanPostProcessor()` #####

Apache Camel作为一款独立的框架，不可避免地定义了一些自己的IOC注解，而在Spring环境下，这些注解所声明的依赖关系的维护正是通过本方法所返回的`CamelBeanPostProcessor`实例来完成的。

被注入到Spring容器中的`CamelBeanPostProcessor`实例通过实现鼎鼎大名的`BeanPostProcessor`接口来为容器中的Bean注入Camel注解所代表的相应依赖。

注入依赖操作的实现中，`CamelBeanPostProcessor`自身只起到一个适配的作用，真正的注入操作是委托给了`camel-core-2.21.3.jar`自身实现的`DefaultCamelBeanPostProcessor`类。感兴趣的读者可以自行查阅。

##### 2.3 `propertiesParser()` 和 `properties()` #####

这两个方法之所以被合并讨论，其实光看名字就能猜到几分。没错这两个Bean的作用正是为了在Apache Camel中使用自身规定的Placeholder语法来读取Spring中存储的用户自定义配置信息，避免重复性地配置配置文件。

`propertiesParser()`方法中创建的`SpringPropertiesParser`实例，其实现的正是设计模式中的适配器模式，将对Camel配置信息读取接口的调用委托给Spring中的相关实现类去完成。

这样我们就可以用如下的方式读取`application.properties`中的配置信息：

@Autowired
    private PropertiesComponent pc;
    
    @Autowired
    private CamelContext camelContext ;
    
    camelContext.resolvePropertyPlaceholders("{ {camel.springboot.name}}");
    pc.parseUri("pc.parseUri(key)");

##### 2.4 `producerTemplate()` 和 `consumerTemplate()` #####

关于这两个方法的返回值分别为`ProducerTemplate`和`ConsumerTemplate`实例。有使用过spring-jdbc等组件的读者应该非常眼熟。没错，Apache Camel为了减轻使用者的记忆负担，保持一致性，而直接借鉴了Spring的命名规则。而且这两个Bean都属于延迟创建，只在需要的时候才会进行组装。

因为这两个方法的存在，我们就可以在需要的位置直接使用以下代码来获取其实例以完成相关需求。

@Autowired
    private ProducerTemplate pt;
    
    Object result = pt.requestBody("direct:start", "hello world");

##### 2.5 `routesCollector()` #####

对于SpringBoot环境下配置过Camel Route的朋友应该都知道，这个过程是非常简单的，只需要继承自Camel提供的`RouteBuilder`抽象类，并实现其`configure()`方法，剩下的框架将全权由框架来完成。而本小节将要讨论的`routesCollector()`方法的返回值`RoutesCollector`实例正是关键所在。

`RoutesCollector`类通过实现Spring提供的扩展接口`ApplicationListener<ContextRefreshedEvent>`，来达成**在系统初始化完毕后，将Spring容器中注册的`RoutesBuilder` Bean添加到CamelContext中**，省却了研发人员手工维护相应关系的枯燥劳动。

而且观察其实现，我们发现Camel还提供了两个相关配置`camel.springboot.javaRoutesExcludePattern`和`camel.springboot.javaRoutesIncludePattern`来更加精密地控制应该载入哪些Route到CamelContext中。

### 3. Actuator ###

在看完了Camel中自动化配置相关的细节之后，我们再来看看Camel提供的SpringBoot Actuator功能，关于SpringBoot Actuator，可以翻阅下笔者之前写过的一篇相关文章[SprinBoot源码研究之Actuator][SprinBoot_Actuator]。本小节依然不再关注SpringBoot Actuator的相关实现细节，而将目光集中到Camel做的改动上。

本小节将主要关注提供Route相关操作的`CamelRoutesEndpoint`，其他类只会做简单的说明。

关于`CamelRoutesEndpoint`，其相关的类还有如下几个：

1.  `CamelRoutesMvcEndpoint`，负责将`CamelRoutesEndpoint`使用适配器模式暴露为一个`MvcEndpoint`。
2.  `CamelRoutesEndpointAutoConfiguration`，这个看名字都能猜到又是个AutoConfig。

通观这三个类，再结合之前的博客[SprinBoot源码研究之Actuator][SprinBoot_Actuator]里的讨论，我们不难想到，Camel默认是提供了如下访问接口来让我们可以控制和知晓Route信息的：

<table> 
 <thead> 
  <tr> 
   <th>Uri</th> 
   <th>用途</th> 
   <th>用途</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>/camel/routes</code></td> 
   <td>GET</td> 
   <td>获取当前CamelContext下所有的route的相关信息</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/detail</code></td> 
   <td>GET</td> 
   <td>获取某个Route的详情</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/dump</code></td> 
   <td>GET</td> 
   <td>获取某个Route的XML格式定义</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/info</code></td> 
   <td>GET</td> 
   <td>获取某个Route的大致信息</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/reset</code></td> 
   <td>POST</td> 
   <td>重置某个Route</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/resume</code></td> 
   <td>POST</td> 
   <td>恢复运行某个Route</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/start</code></td> 
   <td>POST</td> 
   <td>启动某个Route</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/stop</code></td> 
   <td>POST</td> 
   <td>停止某个Route</td> 
  </tr> 
  <tr> 
   <td><code>/camel/routes/{id}/suspend</code></td> 
   <td>POST</td> 
   <td>挂起某个Route</td> 
  </tr> 
 </tbody> 
</table>

最后让我们来看看以上这些对外接口的后台相应代码的位置——除了`/camel/routes` 之外，其他的接口相应代码都位于`CamelRoutesMvcEndpoint`类中。

而对于`/camel/routes` 的响应，笔者这里额外提及一下，因为稍微有些绕：

1.  `CamelRoutesMvcEndpoint`的基类`AbstractCamelMvcEndpoint<T extends Endpoint>`在其构造函数中约定了子类实例化时候必须传入访问路径，也就是这里的`/camel/routes`。
2.  对于`AbstractCamelMvcEndpoint<T extends Endpoint>`，其直接继承自SpringBoot Actuator中的 `EndpointMvcAdapter`，而`EndpointMvcAdapter` 通过覆写基类的`invoke()`方法，将该方法和SpringMVC进行了关联——注解方式标注必须使用Get访问方式，方法实现则是简单地回调基类`AbstractEndpointMvcAdapter<E extends Endpoint<?>>`的`invoke()`实现。
3.  而在`AbstractEndpointMvcAdapter<E extends Endpoint<?>>.invoke()`的实现中，也只是简单地回调了`Endpoint<T>`类型的delegate字段的同名`invoke()`方法。所以实际的逻辑是由delegate来完成的。
4.  而在本场景下，这个delegate为`CamelRoutesEndpoint`实例，所以这个`invoke()`方法也就是`CamelRoutesEndpoint`中实现的了。

### 4. 其他细节 ###

1.  在源码阅读过程中，笔者发现了两个比较有意思的工具类：
    
     *  `ModelHelper.dumpModelAsXml()` ，其作用是将内存的中的Route定义以XML字符串的形式打印出来，这就给与了我们一个思路——使用Java DSL来定义Route以享受Java语言强类型的福利，后期转入维护阶段之后使用该方法将Route定义转移到Spring中，一举两得。
     *  `MessageHelper.dumpMessageHistoryStacktrace()`，这个方法的主要作用是打印出当前Exchange的Message History。实乃后期进行问题追溯，统计报表生成等需求实现的强力辅助工具。
2.  通过`camel.springboot.useMdcLogging=true`我们可以开启SLF4J的MDC功能，这样我们就可以在日志信息中使用Camel提供的一些信息，可选的KEY值可以参见`MDCUnitOfWork`类中的常量字段。另外可参见官方文档：[mdc-logging][]。

### 5. Links ###

1.  [Office Document][]
2.  [Apache Camel MDC add field from Body][]

[SpringBoot_AutoConfiguration]: https://blog.csdn.net/lqzkcx3/article/details/82807888
[SprinBoot_Actuator]: https://blog.csdn.net/lqzkcx3/article/details/89737579
[mdc-logging]: http://camel.apache.org/mdc-logging.html
[Office Document]: http://camel.apache.org/spring-boot.html
[Apache Camel MDC add field from Body]: https://stackoverflow.com/questions/29045419/apache-camel-mdc-add-field-from-body