为了提供一些运行时生成的API文档,我想遍历所有Spring MVC控制器。所有控制器都使用Spring @Controller注释进行注释。目前我是这样的:
for (final Object bean: this.context.getBeansWithAnnotation( Controller.class).values()) { ...Generate controller documentation for the bean... }
但是这个代码的第一个电话是EXTREMELY缓慢。我想知道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()); }
你也可以使用控制器执行类似的操作。
更新了代码段。删除了不必要的代码,仅显示了控制器的类名,以更好地理解。希望这对你有帮助。干杯。
Spring已经扫描了类路径,并且配置了控制器和请求映射的方法,该映射在handlerMapping组件中维护。如果你使用的是Spring 3.1,则此handlerMapping组件是RequestMappingHandlerMapping的一个实例,你可以查询这些实例以查找handlerMappedMethods和关联的控制器(遵循这些原则(如果你使用的是Spring的较旧版本,则应该能够使用类似的方法) ):
handlerMapping
RequestMappingHandlerMapping
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()); } }