【SpringBoot】27 核心功能 - Web开发原理 - Spring MVC中的定制化原理

文章目录

- 一、引言
- [二、MVC 自动配置原理和过程](#二、MVC 自动配置原理和过程)
- - - - [1. 自动配置类 WebMvcAutoConfiguration](#1. 自动配置类 WebMvcAutoConfiguration)
      - [2. 自动配置过程](#2. 自动配置过程)
- 三、自定义配置方法
- - - - [1. 修改配置文件](#1. 修改配置文件)
      - [2. 实现 WebMvcConfigurer 接口](#2. 实现 WebMvcConfigurer 接口)
      - [3. 使用 @EnableWebMvc 注解全面接管配置](#3. 使用 @EnableWebMvc 注解全面接管配置)
      - [4. 编写自定义的配置类替换或扩展组件](#4. 编写自定义的配置类替换或扩展组件)
- 四、结语

一、引言

在基于 Spring MVC 开发 Web 应用时，理解其自动配置原理以及如何进行自定义配置是至关重要的。Spring MVC 提供了自动配置机制来简化开发，但在实际项目中，往往需要根据具体需求对框架进行定制化。本文将深入探讨 Spring MVC 的自动配置原理和过程，以及实现自定义配置的方法。

二、MVC 自动配置原理和过程

1. 自动配置类 WebMvcAutoConfiguration

Spring Boot 在启动时会进行自动配置，对于 Spring MVC 而言，WebMvcAutoConfiguration 是核心的自动配置类。这个类会根据当前应用的类路径、已有的 Bean 等条件，自动配置 Spring MVC 的相关组件。例如，它会配置视图解析器、静态资源处理、消息转换器等基础功能。以下是一个简化的 WebMvcAutoConfiguration 结构示意：

java 复制代码

@Configuration
@ConditionalOnWebApplication
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, LayoutViewResolver.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
        ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {

    // 配置视图解析器相关
    @Bean
    @ConditionalOnMissingBean
    public ViewResolver mvcViewResolver() {
        // 配置并返回视图解析器
        // 省略具体实现代码...
        return new InternalResourceViewResolver();
    }

    // 配置静态资源处理相关
    @Bean
    @ConditionalOnMissingBean
    public ResourceHandlerRegistrationCustomizer staticResourceCustomizer() {
        return new ResourceHandlerRegistrationCustomizer() {
            @Override
            public void customize(ResourceHandlerRegistration registry) {
                // 配置静态资源映射路径等
                // 省略具体实现代码...
            }
        };
    }

    // 其他配置方法...
}

WebMvcAutoConfiguration 通过一系列的条件注解（如 @ConditionalOnWebApplication、@ConditionalOnClass、@ConditionalOnMissingBean 等）来决定是否进行配置以及如何配置。只有当满足所有条件时，相关的配置才会生效。

2. 自动配置过程

当 Spring Boot 应用启动时，会自动扫描并加载所有的自动配置类。对于 WebMvcAutoConfiguration，它会检查当前应用是否为 Web 应用、类路径下是否存在相关的类（如 Servlet、DispatcherServlet 等），以及是否已经存在 WebMvcConfigurationSupport 类型的 Bean。如果这些条件都满足，并且没有其他同类型的 Bean 覆盖，那么 WebMvcAutoConfiguration 就会按照其内部定义的方法进行配置。例如，它会初始化默认的视图解析器，将请求映射到对应的视图页面；配置静态资源的处理方式，使得应用能够正确访问静态资源文件。

下表总结了 WebMvcAutoConfiguration 配置过程中的关键条件和相关配置内容：

条件注解	作用	相关配置内容
`@ConditionalOnWebApplication`	判断当前应用是否为 Web 应用	如果为 Web 应用，才会进行后续的 MVC 相关配置
`@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, LayoutViewResolver.class })`	检查类路径下是否存在指定的类	只有这些类都存在，才会触发自动配置
`@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)`	检查容器中是否不存在 `WebMvcConfigurationSupport` 类型的 Bean	如果不存在，才会使用自动配置；如果存在，则自动配置不生效

三、自定义配置方法

1. 修改配置文件

修改配置文件是一种简单直接的自定义配置方式。在 Spring MVC 中，可以通过配置文件对一些基本参数进行调整。例如，在 application.properties 文件中配置静态资源的缓存时间：

properties 复制代码

# 设置静态资源缓存时间为 1 小时（3600 秒）
spring.mvc.static-resource-cache-period=3600

这种方式适用于一些简单的参数调整，但灵活性有限，无法满足复杂的定制需求。以下是对修改配置文件方式与其他自定义配置方式的部分对比：

方式	优点	缺点	适用场景
修改配置文件	简单易懂，无需编写代码	灵活性差，只能配置有限的参数	简单的参数调整，如静态资源缓存时间、视图解析器的前缀后缀等

2. 实现 WebMvcConfigurer 接口

通过实现 WebMvcConfigurer 接口，可以对 Spring MVC 进行更全面的定制。开发者可以在实现类中覆盖各种方法，如添加拦截器、配置视图控制器、设置跨域请求等。以下是一个简单的实现示例：

java 复制代码

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    // 添加拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()) // 假设 MyInterceptor 是自定义的拦截器
               .addPathPatterns("/**");
    }

    // 配置视图控制器
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/home").setViewName("home");
    }
}

这种方式相较于修改配置文件更加灵活，能够满足大多数常见的定制需求。以下是对实现 WebMvcConfigurer 接口与其他方式的对比：

方式	优点	缺点	适用场景
实现 WebMvcConfigurer 接口	灵活性较高，能满足多种常见的定制需求	对于一些非常底层的组件定制可能不够直接	添加拦截器、配置视图控制器、设置跨域请求等常见需求

3. 使用 @EnableWebMvc 注解全面接管配置

当需要全面接管 Spring MVC 的配置时，可以使用 @EnableWebMvc 注解。这个注解会导入 DelegatingWebMvcConfiguration 类，该类会将所有实现了 WebMvcConfigurer 接口的类收集起来，使它们的配置一起生效。同时，它会自动配置一些底层的组件。以下是一个使用 @EnableWebMvc 的示例配置类：

java 复制代码

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

@Configuration
@EnableWebMvc
public class FullControlWebMvcConfig {
    // 可以在这里进一步进行定制配置，或者通过实现 WebMvcConfigurer 接口的方法进行配置
    // 例如，可以添加更多的拦截器、修改消息转换器等
}

使用 @EnableWebMvc 注解后，默认的 WebMvcAutoConfiguration 将不再生效，开发者可以完全按照自己的需求对 Spring MVC 进行配置。这种方式适用于对框架有特殊要求，需要全面定制的场景。以下是对使用 @EnableWebMvc 注解与其他方式的对比：

方式	优点	缺点	适用场景
使用 @EnableWebMvc 注解	能够全面接管配置，满足特殊的定制需求	需要开发者对 Spring MVC 的配置有深入了解，配置过程相对复杂	对框架有特殊要求，需要全面定制的场景，如修改请求处理流程、更换底层的组件实现等

4. 编写自定义的配置类替换或扩展组件

开发者还可以通过编写自定义的配置类，使用 @Bean 注解替换或扩展 Spring 容器中的默认组件。例如，自定义一个消息转换器：

java 复制代码

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;

@Configuration
public class CustomMessageConverterConfig {

    @Bean
    public MappingJackson2HttpMessageConverter customMappingJackson2HttpMessageConverter() {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        // 可以对转换器进行自定义配置，如设置日期格式等
        // 省略具体配置代码...
        return converter;
    }
}

这种方式可以对特定的组件进行精细的定制，满足一些特殊的业务需求。以下是对编写自定义配置类与其他方式的对比：

方式	优点	缺点	适用场景
编写自定义的配置类替换或扩展组件	能够对特定组件进行精细定制，满足特殊业务需求	需要针对每个组件单独配置，代码量可能较多	对某个特定组件有特殊要求，如自定义消息转换器、处理器映射器等

四、结语

理解 Spring MVC 的自动配置原理和过程，以及掌握各种自定义配置方法，对于开发高效、稳定的 Web 应用至关重要。在实际开发中，开发者应根据具体的需求场景，选择合适的自定义配置方式。通过合理地运用这些方法，可以充分发挥 Spring MVC 的灵活性，构建出符合业务需求的 Web 应用。深入掌握这些知识，将有助于提升开发者在 Web 开发领域的技术水平和解决问题的能力。