Apache Camel路由中configure()方法未被调用的问题排查

问题描述 #

在SpringBoot项目中使用Apache Camel路由，创建了继承RouteBuilder的CamelFileRoute类，构造函数内的日志能正常打印，但configure()方法内的日志无输出，说明该方法未被调用。

代码示例 #

package com.reet.camel.route;

import org.apache.camel.builder.RouteBuilder;
import org.springframework.stereotype.Component;

import lombok.extern.java.Log;

@Component
public class CamelFileRoute extends RouteBuilder{
    
    public CamelFileRoute() {
        System.out.println("Inside constructor");
    }

    @Override
    public void configure() {
        System.out.println("Inside configure");
        
        from("file:files/input")
        .log("${body}")
        .to("file:files/output")
        .log("${body}");
    }
}

输出情况 #

预期输出：

Inside constructor
Inside configure

实际输出：

Inside constructor

可能原因及解决方法 #

1. 缺少Apache Camel Spring Boot Starter依赖 #

SpringBoot无法自动初始化Camel上下文，导致RouteBuilder子类不会被识别和加载，自然不会调用configure()方法。

解决：在项目依赖中添加Camel Spring Boot Starter：

• Maven（pom.xml）：

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-spring-boot-starter</artifactId>
    <version>匹配你的SpringBoot版本</version> <!-- 例如SpringBoot 3.x对应Camel 4.x -->
</dependency>

• Gradle（build.gradle）：

implementation 'org.apache.camel.springboot:camel-spring-boot-starter:匹配你的SpringBoot版本'

2. 组件扫描范围不匹配 #

SpringBoot默认只扫描主类所在包及其子包的@Component类，如果CamelFileRoute所在的com.reet.camel.route不在主类的扫描范围内，会导致该bean无法被加载。

解决：在SpringBoot主类上添加@ComponentScan指定扫描路径：

@SpringBootApplication
@ComponentScan(basePackages = "com.reet")
public class YourSpringBootApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourSpringBootApplication.class, args);
    }
}

3. Camel上下文未正确初始化 #

若依赖和扫描都没问题，可手动验证Camel上下文是否加载了路由：

@SpringBootApplication
@ComponentScan(basePackages = "com.reet")
public class YourSpringBootApplication {

    @Autowired
    private CamelContext camelContext;

    public static void main(String[] args) {
        SpringApplication.run(YourSpringBootApplication.class, args);
    }

    @PostConstruct
    public void checkLoadedRoutes() {
        System.out.println("已加载的路由数量：" + camelContext.getRoutes().size());
        camelContext.getRoutes().forEach(route -> System.out.println("路由ID：" + route.getId()));
    }
}

如果输出路由数量为0，说明上下文未加载你的路由，需重新检查上述依赖和扫描配置。

内容的提问来源于stack exchange，提问作者Abhinandan Kushwaha