Spring Boot WebFlux运行时注册RouterFunction的正确方法

核心问题分析 #

你之前手动创建RouterFunctionMapping Bean的方式会和Spring Boot自动配置的实例冲突——WebFlux默认已经通过WebFluxAutoConfiguration创建了RouterFunctionMapping，它会自动收集所有RouterFunction类型的Bean并合并处理，无需重复创建。

根据路由源的加载时机，分两种场景给出实现方案：

场景1：启动阶段即可获取路由源 #

直接通过@Bean方法从动态源构建RouterFunction，Spring会自动将其纳入WebFlux的路由体系：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;

@Configuration
public class DynamicRouterConfig {

    @Bean
    public RouterFunction<ServerResponse> dynamicRouter() {
        // 从动态源加载路由规则（示例：数据库、外部配置中心、本地文件等）
        // 此处模拟构建动态路由的逻辑
        return RouterFunctions.route()
                .GET("/dynamic/hello", req -> ServerResponse.ok().bodyValue("Hello from dynamic route"))
                .POST("/dynamic/user", req -> req.bodyToMono(User.class)
                        .flatMap(user -> ServerResponse.ok().bodyValue("Received user: " + user.getName())))
                .build();
    }
}

如果需要和已有的静态路由合并，直接使用andOther()方法：

// 假设已有静态路由Bean staticRouter
return dynamicRoutes.andOther(staticRouter);

场景2：启动后才获取路由源（支持动态更新） #

如果路由源需要在应用启动后加载，或者需要动态更新路由，可以通过监听上下文事件，复用Spring自动配置的RouterFunctionMapping来更新路由：

import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctionMapping;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;

@Component
public class DynamicRouterUpdater implements ApplicationListener<ContextRefreshedEvent> {

    private final ApplicationContext ctx;

    public DynamicRouterUpdater(ApplicationContext ctx) {
        this.ctx = ctx;
    }

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        // 获取Spring自动配置的RouterFunctionMapping实例
        RouterFunctionMapping mapping = ctx.getBean(RouterFunctionMapping.class);
        
        // 从动态源构建新路由
        RouterFunction<ServerResponse> newDynamicRoutes = buildDynamicRoutes();
        
        // 合并现有路由与新路由
        RouterFunction<ServerResponse> mergedRouter = mapping.getRouterFunction().andOther(newDynamicRoutes);
        
        // 更新路由并重新初始化，确保生效
        mapping.setRouterFunction(mergedRouter);
        mapping.afterPropertiesSet();
    }

    private RouterFunction<ServerResponse> buildDynamicRoutes() {
        // 此处实现从动态源加载路由的逻辑
        return RouterFunctions.route()
                .GET("/dynamic/late-load", req -> ServerResponse.ok().bodyValue("Late loaded dynamic route"))
                .build();
    }
}

验证方式 #

启动应用后，访问动态路由的路径（如/dynamic/hello），若能正常返回响应，则说明路由已成功注册生效。

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