如何在Spring MVC中找到所有控制器？

controller java spring spring-mvc

2022-09-03 16:32:33

为了提供一些运行时生成的API文档，我想遍历所有Spring MVC控制器。所有控制器都使用 Spring @Controller 注释进行注释。目前我这样做：

for (final Object bean: this.context.getBeansWithAnnotation(
        Controller.class).values())
{
    ...Generate controller documentation for the bean...
}

但是这个代码的第一次调用非常慢。我想知道Spring是否迭代类路径中的所有类，而不仅仅是检查定义的bean。当运行上述代码时，控制器已经加载，日志显示所有控制器及其请求映射，因此Spring MVC必须已经知道它们，并且必须有更快的方法来获取它们的列表。但是如何做到呢？

答案 1

我喜欢@Japs建议的方法，但也想推荐一种替代方法。这是基于您的观察，即Spring已经扫描了类路径，并且配置了控制器和请求映射方法，此映射保留在组件中。如果您使用的是Spring 3.1，则此组件是RequestMappingHandlerMapping的一个实例，您可以查询它以查找处理程序MappedMethods和关联的控制器，沿着以下路线（如果您使用的是较旧版本的Spring，您应该能够使用类似的方法）：handlerMappinghandlerMapping

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

@Controller
public class EndpointDocController {
 private final RequestMappingHandlerMapping handlerMapping;
 
 @Autowired
 public EndpointDocController(RequestMappingHandlerMapping handlerMapping) {
  this.handlerMapping = handlerMapping;
 }
  
 @RequestMapping(value="/endpointdoc", method=RequestMethod.GET)
 public void show(Model model) {
  model.addAttribute("handlerMethods", this.handlerMapping.getHandlerMethods());
 } 
}

我在此网址上提供了有关此的更多详细信息 http://biju-allandsundry.blogspot.com/2012/03/endpoint-documentation-controller-for.html

这是基于Spring Source的Rossen Stoyanchev对Spring 3.1的演讲。

答案 2

几个月前我也遇到过这样的要求，我使用以下代码片段实现了它。

ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false);
        scanner.addIncludeFilter(new AnnotationTypeFilter(Controller.class));
        for (BeanDefinition beanDefinition : scanner.findCandidateComponents("com.xxx.yyy.controllers")){
            System.out.println(beanDefinition.getBeanClassName());
        }

您也可以对控制器执行类似操作。

更新了代码段。删除了不必要的代码，只显示控制器的类名，以便更好地理解。希望这对您有所帮助。干杯。