如何理解 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");    
    }    
}     

我的问题是，对于 View Controller，通过添加 @Configuration 和 @ComponentScan(basePackages = { "com.apress.prospringmvc.bookstore.web" })，后台会做什么？ com.apress.prospringmvc.bookstore.web 包会为这些视图控制器提供一些东西吗？

Answer 1

简单地说 - @ComponentScan 告诉 Spring 你在哪些包中注释了应该由 Spring 管理的类。因此，例如，如果您有一个带有 @Controller 注释的类，该类位于 Spring 未扫描的包中，您将无法将其用作 Spring 控制器。

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

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

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

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