如何理解Spring@ComponentScan

Question

我正在遵循一个关于Spring MVC的教程，即使在阅读了Spring API文档后，我也无法理解@ComponentScan注释，因此以下是示例代码：

配置视图控制器

package com.apress.prospringmvc.bookstore.web.config;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
// Other imports ommitted
@Configuration
@EnableWebMvc
@ComponentScan(basePackages = { "com.apress.prospringmvc.bookstore.web" })
public class WebMvcContextConfiguration extends WebMvcConfigurerAdapter {
    // Other methods ommitted
    @Override
    public void addViewControllers(final ViewControllerRegistry registry) {
        registry.addViewController("/index.htm").setViewName("index");
    }
}

基于注释的控制器

package com.apress.prospringmvc.bookstore.web;    
import org.springframework.stereotype.Controller;    
import org.springframework.web.bind.annotation.RequestMapping;    
import org.springframework.web.servlet.ModelAndView;    
@Controller    
public class IndexController {    
@RequestMapping(value = "/index.htm")    
    public ModelAndView indexPage() {     
        return new ModelAndView("index");    
    }    
}     

我的问题是，对于视图控制器，通过添加@Configuration和@ComponentScan（basePackages={“com.apress.prospringmvc.bookstore.web}），在后台会做什么？软件包com。按一下。prospringmvc。书店web为这些视图控制器提供了什么？

Answer 1

简单地说，@ComponentScan告诉Spring哪些包中有应该由Spring管理的注释类。因此，例如，如果您有一个用@Controller注释的类，它在一个包中，没有被Spring扫描，那么您将无法将其用作Spring控制器。

用@Configance注释的类是一种使用注释而不是XML文件（称为Java配置）来配置Spring的新方法。Spring需要知道哪些包包含Spring bean，否则您必须单独注册每个bean。这就是@ComponentScan的用途。

在您的示例中，您告诉Spring这个包com。按一下。prospringmvc。书店web包含应该由Spring处理的类。Spring然后找到一个用@Controller注释的类，并对其进行处理，这将导致所有请求都到达/index。htm被控制器截获。

当请求被拦截时，Spring需要知道向调用方发送什么响应。由于您返回了ModelAndView的实例，它将尝试在您的项目中找到一个名为index的视图（JSP页面）（详细信息取决于配置的视图解析器），并将其呈现给用户。

如果@Controller注释不存在，或者该包没有被Spring扫描，所有这些都将是不可能的。