Spring Cloud Gateway如何程序化合并配置文件与环境变量中的路由？

在Spring Boot环境中，环境变量默认优先级高于application.properties，导致后者的路由配置被覆盖。要程序化合并两者，可按以下步骤操作：

1. 分别获取两个配置源的路由数据 #

通过Environment对象读取原始配置：

• 遍历PropertySources找到application.properties对应的配置源，提取其中的路由配置（避免被环境变量覆盖）
• 直接通过Environment.getProperty()获取环境变量中的路由（Spring已自动完成环境变量键名的转换，比如APP_ROUTES对应app.routes）

2. 合并并去重路由列表 #

将两个来源的路由拆分后合并，按需去重，最终得到完整的路由集合。

示例代码：路由合并工具类 #

import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertySource;
import org.springframework.stereotype.Component;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

@Component
public class RouteConfigMerger {
    private final List<String> mergedRoutes;

    public RouteConfigMerger(Environment environment) {
        // 读取application.properties中的路由
        String appRoutes = null;
        for (PropertySource<?> source : ((ConfigurableEnvironment) environment).getPropertySources()) {
            if (source.getName().startsWith("classpath:/application.properties")) {
                appRoutes = (String) source.getProperty("app.routes");
                break;
            }
        }

        // 读取环境变量中的路由
        String envRoutes = environment.getProperty("app.routes");

        // 拆分并合并路由
        List<String> appRouteList = appRoutes != null ? Arrays.asList(appRoutes.split(",")) : new ArrayList<>();
        List<String> envRouteList = envRoutes != null ? Arrays.asList(envRoutes.split(",")) : new ArrayList<>();

        mergedRoutes = new ArrayList<>(appRouteList);
        mergedRoutes.addAll(envRouteList);
        
        // 可选：去重+去除空格处理
        mergedRoutes.replaceAll(String::trim);
        mergedRoutes = mergedRoutes.stream().distinct().collect(Collectors.toList());
    }

    public List<String> getMergedRoutes() {
        return mergedRoutes;
    }
}

3. 应用合并后的路由 #

根据你使用的路由框架（如Spring Cloud Gateway、Spring MVC），将合并后的路由注册到系统中：

示例：Spring Cloud Gateway中注册路由 #

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class CustomRouteConfig {
    private final RouteConfigMerger routeMerger;

    public CustomRouteConfig(RouteConfigMerger routeMerger) {
        this.routeMerger = routeMerger;
    }

    @Bean
    public RouteLocator mergedRouteLocator(RouteLocatorBuilder builder) {
        RouteLocatorBuilder.Builder routes = builder.routes();
        for (String routeStr : routeMerger.getMergedRoutes()) {
            // 假设路由格式为 "path=/api/**,uri=http://example.com"
            String[] routeParts = routeStr.split(",uri=");
            if (routeParts.length == 2) {
                String path = routeParts[0].replace("path=", "").trim();
                String uri = routeParts[1].trim();
                routes.route(r -> r.path(path).uri(uri));
            }
        }
        return routes.build();
    }
}

注意事项 #

• 调整配置键名：如果你的路由配置键不是app.routes，需对应修改代码中的键名
• 适配分隔符：如果路由用分号或其他符号分隔，修改split()的参数
• PropertySource名称：如果使用多环境配置（如application-dev.properties），调整startsWith()的匹配字符串

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