如何从配置文件动态创建Spring Boot RestControllers？

针对你需要从配置文件读取规则、在容器启动时动态生成RestController端点的需求，可以通过直接操作Spring MVC的RequestMappingHandlerMapping实现，无需依赖注解式Controller，具体步骤如下：

1. 定义配置实体与读取配置 #

先创建封装动态端点规则的实体类，再通过配置属性绑定读取配置文件中的规则：

配置实体类 #

public record DynamicEndpoint(String regexPath, HttpMethod httpMethod, String staticUrl) {}

配置属性类 #

@Configuration
@ConfigurationProperties(prefix = "dynamic")
public class DynamicEndpointProperties {
    private List<DynamicEndpoint> endpoints = new ArrayList<>();

    public List<DynamicEndpoint> getEndpoints() {
        return endpoints;
    }

    public void setEndpoints(List<DynamicEndpoint> endpoints) {
        this.endpoints = endpoints;
    }
}

配置文件示例（application.yml） #

dynamic:
  endpoints:
    - regexPath: "/users/{id:\\d+}/ID"
      httpMethod: GET
      staticUrl: "/users/ID"
    - regexPath: "/orders/{orderId:\\d+}/DETAIL"
      httpMethod: POST
      staticUrl: "/orders/DETAIL"

注：路径正则需遵循Spring MVC规范，比如{id:\\d+}用于匹配数字类型的路径变量。

2. 实现通用请求处理器 #

创建原型作用域的Controller类，每个实例对应一个静态URL，处理对应端点的请求：

@Controller
@Scope("prototype")
public class DynamicRequestController {
    private final String staticUrl;

    public DynamicRequestController(String staticUrl) {
        this.staticUrl = staticUrl;
    }

    @ResponseBody
    public String handleRequest() {
        // 这里可根据staticUrl实现自定义逻辑，比如转发、调用内部服务等
        return "Working! Mapped to static URL: " + staticUrl;
    }
}

3. 注册动态端点到Spring MVC上下文 #

创建配置类，在容器启动完成后，遍历配置规则，将每个动态端点注册到RequestMappingHandlerMapping：

@Configuration
public class DynamicEndpointRegistrar {
    private final RequestMappingHandlerMapping handlerMapping;
    private final DynamicEndpointProperties endpointProperties;
    private final ApplicationContext applicationContext;

    public DynamicEndpointRegistrar(RequestMappingHandlerMapping handlerMapping,
                                   DynamicEndpointProperties endpointProperties,
                                   ApplicationContext applicationContext) {
        this.handlerMapping = handlerMapping;
        this.endpointProperties = endpointProperties;
        this.applicationContext = applicationContext;
    }

    @PostConstruct
    public void registerEndpoints() throws NoSuchMethodException {
        Method handlerMethod = DynamicRequestController.class.getMethod("handleRequest");

        for (DynamicEndpoint endpoint : endpointProperties.getEndpoints()) {
            // 创建RequestMapping信息，包含匹配路径、请求方法
            RequestMappingInfo mappingInfo = RequestMappingInfo
                    .paths(endpoint.regexPath())
                    .methods(endpoint.httpMethod())
                    .build();

            // 获取原型作用域的Controller实例，绑定当前规则的staticUrl
            DynamicRequestController controller = applicationContext.getBean(DynamicRequestController.class, endpoint.staticUrl());

            // 注册端点到Spring MVC
            handlerMapping.registerMapping(mappingInfo, controller, handlerMethod);
        }
    }
}

4. 验证效果 #

启动应用后，发送请求GET /users/123/ID，会返回Working! Mapped to static URL: /users/ID；发送POST /orders/456/DETAIL，会返回对应静态URL的提示，完全符合需求。

关键说明 #

• 该方案在容器启动时完成端点注册，满足“启动时动态创建”的要求，无需运行时修改。
• 若需处理更复杂的逻辑（如请求转发、参数处理），可在handleRequest方法中扩展，比如注入HttpServletRequest、HttpServletResponse对象操作请求响应。
• 配置文件中的路径规则需严格遵循Spring MVC的路径匹配语法，确保请求能被正确拦截。

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