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

为了提供一些运行时生成的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必须已经知道所有这些,并且必须有更快的方法来获取它们的列表。 但是怎么样?

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

 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()); } 

您也可以使用控制器执行此类操作。

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

我喜欢@Japs建议的方法,但也想推荐一种替代方法。 这是基于您观察到Spring已经扫描了类路径,并且配置了控制器和请求映射方法,此映射在handlerMapping组件中维护。 如果您正在使用Spring 3.1, handlerMapping组件是RequestMappingHandlerMapping的一个实例,您可以查询这些实例,以查找handlerMappedMethods和相关控制器(如果您使用的是旧版本的Spring,则应该可以使用类似的方法):

 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()); } } 

我在这个url上提供了更多详细信息http://biju-allandsundry.blogspot.com/2012/03/endpoint-documentation-controller-for.html

这是基于Spring Source的Rossen Stoyanchev在Spring 3.1上的演示。