搭建 Spring MVC

引入依赖

pom.xml

<!--
    ======================== Spring ========================
-->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.14.2</version>
</dependency>

<!--
    ======================== Swagger ========================
-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-mvc</artifactId>
    <version>2.0.5</version>
</dependency>
<dependency>
    <groupId>com.fasterxml</groupId>
    <artifactId>classmate</artifactId>
    <version>1.5.1</version>
</dependency>

<!--
    ======================== Servlet ========================
-->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

配置 DispatcherServlet

扩展 AbstractAnnotationConfigDispatcherServletInitializer 的任意类都会自动地配置DispatcherServlet 和 Spring应用上下文，Spring 的应用上下文会位于应用程序的 Servlet 上下文之中。

在 Servlet 3.0 环境中，容器会在类路径中查找实现了 javax.servlet.ServletContainerInitializer 接口的类，如果能发现的话，就会用它来配置 Servlet 容器。
Spring 提供了这个接口的实现，名为 SpringServletContainerInitializer，这个类反过来又会查找实现 WebApplicationInitializer 的类并将配置的任务交给它来完成。Spring 3.2 引入了一个便利的WebApplicationInitializer 的基础实现：AbstractAnnotationConfigDispatcherServletInitializer。

StudyWebAppInitializer

package com.study.spring.config;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

/**
 * @author Zhang B H
 * @create 2023-10-02 15:39
 */
public class StudyWebAppInitializer 
         extends AbstractAnnotationConfigDispatcherServletInitializer {

    /**
     * 创建Spring应用上下文。
     * 加载包含Web组件的bean，如控制器、视图解析器以及处理映射器。
     *
     * @return 无论返回的数组是否为空，都会创建应用上下文
     */
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[] {ServletConfig.class};
    }

    /**
     * 在Spring Web应用中，通常还会有另一个应用上下文，该上下文交由ContextLoaderListener创建。
     * 加载应用中的其他bean，这些bean通常是驱动应用后端的中间层和数据层组件的。
     *
     * @return 如果返回的数组为空，并不会创建应用上下文
     */
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{RootConfig.class};
    }

    /**
     * 将一个或多个路径映射到 DispatcherServlet上。
     * @return
     */
    @Override
    protected String[] getServletMappings() {
        return new String[] { "/study" };
    }
}

当 DispatcherServlet 启动的时候，它会创建 Spring 应用上下文，并加载配置文件或配置类中所申明的bean。此时，会使用由 getServletConfigClasses() 方法返回的 ServletConfig 配置类来加载 Spring 应用上下文。
在 Spring Web 应用中，通常还会有另一个应用上下文，该上下文交由 ContextLoaderListener 创建。此上下文所使用的配置类由 getRootConfigClasses() 方法返回的 RootConfig 配置类进行配置。

AbstractAnnotationConfigDispatcherServletInitializer 会同时创建 DispatcherServlet 和 ContextLoaderListener。
getServletConfigClasses() 方法返回的类将会用来定义 DispatcherServlet 应用上下文中的 bean。
getRootConfigClasses() 方法返回的类将会用来配置 ContextLoaderListener 创建的应用上下文中的 bean。

For many applications, having a single WebApplicationContext is simple and suffices. It is also possible to have a context hierarchy where one root WebApplicationContext is shared across multiple DispatcherServlet (or other Servlet) instances, each with its own child WebApplicationContext configuration.
The root WebApplicationContext typically contains infrastructure beans, such as data repositories and business services that need to be shared across multiple Servlet instances. Those beans are effectively inherited and can be overridden (that is, re-declared) in the Servlet-specific child WebApplicationContext, which typically contains beans local to the given Servlet.

我们希望 DispatcherServlet 加载包含 Web 组件的 bean，如控制器、视图解析器以及处理映射器，而 ContextLoaderListener 则加载应用中的其他 bean，这些 bean 通常是驱动应用后端的中间层和数据层组件的。

按照传统的方式，DispatcherServlet 会配置在 web.xml 文件中，这个文件会放到应用的 war 包里面。
通过 AbstractAnnotationConfigDispatcherServletInitializer 来配置 DispatcherServlet 是传统 web.xml 方式的替代方案。如果你愿意的话，可以同时包含 web.xml 和 AbstractAnnotationConfigDispatcherServletInitializer，但这其实并没有必要。

如果按照这种方式配置 DispatcherServlet，而不是使用 web.xml 的话，那唯一问题在于它只能部署到支持 Servlet 3.0 的服务器中才能正常工作，如 Tomcat 7 或更高版本。

启动Spring MVC

ServletConfig

package com.study.spring.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @author Zhang B H
 * @create 2023-10-02 15:40
 */
@EnableWebMvc
@Configuration
@Import(SwaggerConfig.class)
@ComponentScan("com.study.spring.controller")
public class ServletConfig implements WebMvcConfigurer {

    @Override
    public void configureDefaultServletHandling(
      DefaultServletHandlerConfigurer configurer) {
        // 要求DispatcherServlet将对静态资源的请求转发到默认的Servlet上
        configurer.enable(); 
    }
}

在上述代码中：

通过 @EnableWebMvc 注解来启用 Spring MVC；
通过实现 WebMvcConfigurer 接口，覆盖接口中的方法 configureDefaultServletHandling 来“配置对静态资源的处理”。若不包含此配置，DispatcherServlet 会映射为应用的默认 Servlet，所以它会处理所有的请求，包括对静态资源的请求，如图片和样式表。

RootConfig

package com.study.spring.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

/**
 * @author Zhang B H
 * @create 2023-10-02 15:39
 */
@Configuration
@ComponentScan(
    basePackages = "com.study.spring",
    excludeFilters = {
         @ComponentScan.Filter(
              type = FilterType.ANNOTATION, value = EnableWebMvc.class
         ),
         @ComponentScan.Filter(
              type = FilterType.ANNOTATION, value = EnableSwagger2.class
         ),
         @ComponentScan.Filter(
              type = FilterType.ANNOTATION, value = Controller.class
         )
    }
)
public class RootConfig {
}

实际上，RootConfig 和 ServletConfig 都不需要 @Configuration 注解，之所以在不需要的情况下添加该注解，是为了利用 IDEA 能够查看 Spring Bean 的功能，如下图所示：

配置 Swagger （knife4j）

SwaggerConfig

package com.study.spring.config;

import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author Zhang B H
 * @create 2023-10-03 19:01
 */
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                .build();
    }
}

猜想
在上述的 spring mvc 配置中，存在两个应用上下文，分别由 DispatcherServlet 和ContextLoaderListener 所拥有。
要想 swagger 能够正确运行，需要保证 Swagger 的配置位于 DispatcherServlet 所拥有的应用上下文之中，且不会出现在 ContextLoaderListener 所拥有的应用上下文中。

编写一个简单的控制器

package com.study.spring.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Zhang B H
 * @create 2023-10-02 16:23
 */
@RestController
public class HomeController {

    @GetMapping("home")
    public String home() {
        return "home";
    }
}

测试

从 Spring 3.2 开始，可以按照控制器的方式来测试 Spring MVC 中的控制器了，而不仅仅是作为 POJO 进行测试。Spring 包含了一种 mock Spring MVC 并针对控制器执行 HTTP 请求的机制。这样的话，在测试控制器的时候，就没有必要再启动 Web 服务器和 Web 浏览器了。

mockMvc

package com.study.spring.controller;

import com.study.spring.config.ServletConfig;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.junit.jupiter.web.SpringJUnitWebConfig;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

/**
 * @author Zhang B H
 * @create 2023-10-02 17:15
 */
private MockMvc mockMvc;

    @Before
    public void setUp() {
        mockMvc = MockMvcBuilders.standaloneSetup(new HomeController())
                .build();
    }

    @Test
    public void home() throws Exception {
        mockMvc.perform(
                MockMvcRequestBuilders.get("/home")
        ).andExpect(MockMvcResultMatchers.content().string("home"));
    }
}

访问swagger页面

knife4j的首页是doc.html。

PreviousSpring MVC请求的处理流程 NextSpring MVC 高级配置

Last updated 8 months ago