Apache Camel 2 升级 3 配置迁移指南

在将Apache Camel项目从2.x版本升级到3.x版本时，开发者常会遇到一些API和配置上的变化。其中一个常见的问题是，在Camel 2中用于加载Spring应用上下文的Main.setApplicationContextUri()方法在升级到Camel 3后似乎“消失”了。这主要是因为Camel 3对Spring集成模块进行了重构和拆分。本文将详细阐述这一变化的原因，并提供两种解决此问题的方案，包括继续使用Spring XML配置以及更推荐的现代化Java配置方式。

1. 理解 Main 类与 Spring 集成的变化

在Camel 2中，org.apache.camel.Main类通常直接提供了与Spring框架集成的能力，例如通过setApplicationContextUri()方法加载Spring XML配置文件。然而，从Camel 3.2版本开始，为了更好地模块化和解耦，将Main类中与Spring ApplicationContext相关的支持功能迁移到了独立的camel-spring-main模块中。这意味着，如果你在Camel 3项目中仍然希望通过Main类来加载Spring XML配置文件，你需要显式地引入这个新的模块，并使用其中提供的Main类。

2. 解决方案一：引入 camel-spring-main 模块继续使用 Spring XML 配置

如果你希望在升级到Camel 3后仍然沿用现有的camel-context.xml等Spring XML配置文件来定义Camel上下文和路由，那么你需要引入camel-spring-main依赖，并使用其提供的Main类。

2.1 添加 Maven 依赖

首先，确保你的pom.xml文件中包含了camel-spring-main的依赖。请注意，Camel 3.14.x 是支持 Java 8 的最新版本之一，因此以下示例将基于此版本。

    org.apache.camel
    camel-spring-main
    3.14.6 


    org.apache.camel
    camel-spring 
    3.14.6


    org.springframework
    spring-context
    5.3.20 

2.2 使用 org.apache.camel.spring.Main 类

引入依赖后，你就可以使用org.apache.camel.spring.Main类来加载你的Spring XML配置文件了。这个类提供了与Camel 2中Main.setApplicationContextUri()类似的功能。

import org.apache.camel.spring.Main; // 注意这里是 camel-spring-main 包下的 Main

public class MySpringCamelApp {

    public static void main(String[] args) throws Exception {
        Main main = new Main();
        // 设置要加载的Spring应用上下文配置文件
        main.setApplicationContextUri("classpath:camel-context.xml");
        // 如果有多个配置文件，可以设置多个
        // main.setApplicationContextUri("classpath:app-context.xml,classpath:camel-context.xml");

        // 启动Camel
        main.run();
    }
}

注意事项：

• 确保你的camel-context.xml文件位于类路径下。
• 如果你的项目同时有app-context.xml（用于基础Spring配置）和camel-context.xml，并且app-context.xml引用了camel-context.xml，那么你可以将所有相关的Spring XML文件都列在setApplicationContextUri()中，或者确保它们能被Spring正确加载。通常，如果app-context.xml已经包含了对camel-context.xml的引用（例如通过），那么你可能只需要加载app-context.xml即可。

3. 解决方案二：现代化配置——从 XML 到 Java/注解

鉴于XML配置的复杂性和维护成本，Apache Camel 3强烈推荐使用Java代码、注解和外部属性文件进行配置。这不仅简化了配置，还提供了更好的类型安全和IDE支持。

3.1 核心思想

• Java 配置 Camel Context: 使用Spring的@Configuration和@Bean注解来定义SpringCamelContext。
• Java 定义路由: 通过继承RouteBuilder类并将其注册为Spring Bean来定义Camel路由。
• 外部属性配置: 利用Spring的属性源机制（如application.properties或application.yml）来管理配置参数。

3.2 迁移示例

假设你有一个camel-context.xml如下：

    
        
        com.blah.listener
    

    
        
    
    
    
    

迁移步骤：

1. 移除 camel-context.xml 引用： 如果你的app-context.xml引用了camel-context.xml，请移除该引用。camel-context.xml文件本身也可以被移除。

2. 创建 Camel Java 配置类： 创建一个Spring配置类，用于定义SpringCamelContext和相关的Camel Bean。

   import org.apache.camel.CamelContext;
   import org.apache.camel.spring.SpringCamelContext;
   import org.apache.camel.component.sql.SqlComponent;
   import org.springframework.context.ApplicationContext;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   import org.springframework.context.annotation.ComponentScan;
   import org.springframework.context.annotation.PropertySource;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.core.env.Environment;
   import javax.sql.DataSource; // 假设你的DataSource已定义
   
   @Configuration
   @ComponentScan(basePackages = "com.blah.listener") // 替代 
   @PropertySource("classpath:lib/queries.properties") // 替代 
   public class CamelConfig {
   
       @Autowired
       private ApplicationContext applicationContext;
   
       @Autowired
       private Environment env; // 用于访问 properties 文件中的属性
   
       // 假设 dataSource bean 已在其他Spring配置中定义
       @Autowired
       private DataSource dataSource;
   
       @Bean
       public CamelContext camelContext() throws Exception {
           SpringCamelContext camelContext = new SpringCamelContext(applicationContext);
           camelContext.setName("camel"); // 设置CamelContext ID
           camelContext.setTracing(false); // 对应 trace="false"
   
           // 如果需要手动添加路由，可以在这里添加
           // camelContext.addRoutes(new MyRouteBuilder());
   
           // 替代 ，Spring会自动处理 @PropertySource
           // 如果需要将 properties 文件中的属性注入到 Camel Context，可以使用 PropertyConfigurer
           // 但通常，通过Spring的Environment或@Value注解直接在Java路由中使用更方便。
   
           return camelContext;
       }
   
       // 替代 
       @Bean(name = "sqlComponent")
       public SqlComponent sqlComponent() {
           SqlComponent sql = new SqlComponent();
           sql.setDataSource(dataSource);
           return sql;
       }
   
       // 替代 
       @Bean(name = "bean1")
       public com.foo.OurThing bean1() {
           return new com.foo.OurThing();
       }
   
       // 替代 
       @Bean(name = "bean2")
       public com.bar.OtherThing bean2() {
           return new com.bar.OtherThing();
       }
   }

3. 创建 Java 路由类： 对于com.blah.listener，Spring的@ComponentScan会自动扫描指定包下的RouteBuilder实现类，并将其注册到CamelContext中。

   package com.blah.listener;
   
   import org.apache.camel.builder.RouteBuilder;
   import org.springframework.stereotype.Component;
   import org.springframework.beans.factory.annotation.Value; // 用于访问属性
   
   @Component // 确保Spring能够发现并注册这个路由
   public class MyRouteBuilder extends RouteBuilder {
   
       @Value("${my.queue.name}") // 从 lib/queries.properties 或其他属性源获取
       private String queueName;
   
       @Override
       public void configure() throws Exception {
           // 示例路由，假设你的 queries.properties 中有 my.queue.name=myQueue
           from("timer:hello?period=5s")
               .log("Hello from Camel! Queue name: ${body}")
               .to("direct:processMessage");
   
           from("direct:processMessage")
               .log("Processing message for queue: " + queueName)
               .to("mock:output");
       }
   }

4. 创建 lib/queries.properties 文件： 在src/main/resources/lib/queries.properties（或你的类路径下的相应位置）创建文件：

   my.queue.name=myQueueFromProperties

5. 启动应用： 如果你使用Spring Boot，只需运行主应用类即可。如果是非Spring Boot应用，你需要使用AnnotationConfigApplicationContext来加载你的Java配置。

   import org.springframework.context.annotation.AnnotationConfigApplicationContext;
   
   public class MyJavaCamelApp {
   
       public static void main(String[] args) {
           // 加载Spring配置类
           AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(CamelConfig.class);
           context.start(); // 启动Spring上下文，CamelContext也会随之启动
   
           // 保持应用运行，直到手动关闭
           // 或者通过其他机制（如Spring Boot的WebServer）保持运行
           Runtime.getRuntime().addShutdownHook(new Thread(context::close));
       }
   }

4. 迁移注意事项与最佳实践

• 版本兼容性： 确保你的Java版本（例如Java 8）与Camel 3.x版本（例如3.14.x）兼容。查阅Camel官方文档获取详细的兼容性矩阵。
• 逐步迁移： 如果项目庞大，可以考虑分阶段迁移。先确保camel-spring-main方案能正常工作，再逐步将XML配置转换为Java配置。
• 外部化配置： 充分利用application.properties、application.yml或环境变量来管理配置，避免硬编码。
• Spring Boot 集成： 如果可能，考虑将项目迁移到Spring Boot。Spring Boot提供了对Camel的自动配置，可以极大地简化设置和部署。
• CXF 配置迁移： 原始camel-context.xml中包含CXF相关配置。CXF组件在Camel 3中依然存在，但其配置方式也应倾向于Java Bean或Spring Boot的配置属性。例如，CXF端点可以通过cxf:bean:myCxfEndpoint引用，其中myCxfEndpoint是一个在Spring配置中定义的CXF Bean。

总结

从Apache Camel 2升级到3，Main.setApplicationContextUri()方法的变化是Spring集成模块重构的结果。对于希望继续使用Spring XML配置的用户，引入camel-spring-main模块并使用org.apache.camel.spring.Main是直接的解决方案。然而，更推荐的现代化方法是完全拥抱Java配置、注解和外部属性文件，这不仅能解决当前问题，还能显著提升代码的清晰度、可维护性和开发效率。通过将XML配置逐步迁移到Java，你的Camel应用将更加适应未来的开发趋势和云原生环境。