如何在Spring Boot自动配置库中正确集成@RestController

针对你的需求，这里提供三种可行的实现方案，既满足不依赖组件扫描的要求，又能让Spring MVC正确识别REST端点：

方案1：类级别添加@RequestMapping，通过@Bean注册 #

这种方法利用Spring MVC默认的处理器规则，无需额外配置：

• 控制器类不用加@RestController/@Controller，只在类上标注@RequestMapping（或类级别的@GetMapping等）
• 在自动配置类中通过@Bean将控制器注册为Spring Bean
• 原理：Spring MVC的RequestMappingHandlerMapping默认会检测所有带有@Controller或@RequestMapping注解的Bean，类级别的@RequestMapping足以让处理器识别到端点

代码示例：

// 控制器类
@RequestMapping("/library-api")
public class LibraryController {
    @GetMapping("/status")
    public String getStatus() {
        return "Library is running";
    }
}

// 自动配置类
@AutoConfiguration
public class LibraryAutoConfiguration {
    @Bean
    public LibraryController libraryController() {
        return new LibraryController();
    }
}

方案2：保留@RestController，通过@Bean注册并防重复 #

如果想保留@RestController注解，同时避免被组件扫描识别：

• 给控制器类添加@RestController，但将其放在用户应用不会扫描的包路径下（比如你的库内部专属包）
• 在自动配置类中用@Bean注册控制器，同时添加@ConditionalOnMissingBean，防止用户意外扫描到该类时重复注册Bean

代码示例：

// 控制器类
@RestController
public class LibraryController {
    @GetMapping("/library-api/status")
    public String getStatus() {
        return "Library is running";
    }
}

// 自动配置类
@AutoConfiguration
public class LibraryAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean
    public LibraryController libraryController() {
        return new LibraryController();
    }
}

方案3：自定义处理器映射，识别无注解控制器 #

如果不想给控制器加任何相关注解，可通过自定义处理器映射实现：

• 控制器类不添加@RestController/@Controller/@RequestMapping等注解，仅在方法上标注请求映射
• 在自动配置类中注册控制器Bean，同时自定义RequestMappingHandlerMapping，修改其识别规则以包含你的控制器类

代码示例：

// 控制器类
public class LibraryController {
    @GetMapping("/library-api/status")
    public String getStatus() {
        return "Library is running";
    }
}

// 自动配置类
@AutoConfiguration
public class LibraryAutoConfiguration {
    @Bean
    public LibraryController libraryController() {
        return new LibraryController();
    }

    @Bean
    public RequestMappingHandlerMapping customRequestMappingHandlerMapping(RequestMappingHandlerMapping defaultMapping) {
        // 扩展默认的处理器类型断言，加入我们的控制器类
        defaultMapping.setHandlerTypePredicate(
                HandlerTypePredicate.forAssignableType(LibraryController.class)
                        .or(defaultMapping.getHandlerTypePredicate())
        );
        return defaultMapping;
    }
}

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