Spring MVC 十一：@EnableWebMvc

weixin_446122462023-10-15 14:45

我们从两个角度研究@EnableWebMvc：

  1. @EnableWebMvc的使用
  2. @EnableWebMvc的底层原理
@EnableWebMvc的使用

@EnableWebMvc需要和java配置类结合起来才能生效，其实Spring有好多@Enablexxxx的注解，其生效方式都一样，通过和@Configuration结合、使得@Enablexxxx中的配置类（大多通过@Bean注解）注入到Spring IoC容器中。

理解这一配置原则，@EnableWebMvc的使用其实非常简单。

我们还是使用前面文章的案例进行配置。

新增配置类

在org.example.configuration包下新增一个配置类：

@Configuration
@EnableWebMvc
@ComponentScan({"org.example.controller"})
public class MvcConfiguration{
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        for(HttpMessageConverter httpMessageConverter:converters){
            if(StringHttpMessageConverter.class.isAssignableFrom(httpMessageConverter.getClass())){
                ((StringHttpMessageConverter)httpMessageConverter).setDefaultCharset(Charset.forName("UTF-8"));
            }
        }
    }
}

配置类增加controller的包扫描路径，添加@EnableWebMvc注解，其他不需要干啥。

简化web.xml

由于使用了@EnableWebMvc，所以web.xml可以简化，只需要启动Spring IoC容器、添加DispatcherServlet配置即可

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         id="WebApp_ID" version="3.1">
<!--  1、启动Spring的容器-->
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:applicationContext.xml</param-value>
  </context-param>

  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>

  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

</web-app>
applicationContext.xml

Spring IoC容器的配置文件，指定包扫描路径即可：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">

    <context:component-scan base-package="org.example">
        <context:exclude-filter type="annotation"
                                expression="org.springframework.stereotype.Controller" />
    </context:component-scan>
</beans>
Springmvc.xml

springmvc.xml文件也可以简化，只包含一个视图解析器及静态资源解析的配置即可，其他的都交给@EnableWebMvc即可：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/mvc
    http://www.springframework.org/schema/mvc/spring-mvc.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 放行静态资源 -->
    <mvc:default-servlet-handler />

    <!-- 视图解析器 -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 视图前缀 -->
        <property name="prefix" value="/" />
        <!-- 视图后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>

</beans>
测试

添加一个controller：

@Controller
public class    HelloWorldController {
    @GetMapping(value="/hello")
    @ResponseBody
    public String hello(ModelAndView model){
        return "<h1>@EnableWebMvc 你好</h1>";
    }
}

启动应用，测试：

发现有中文乱码。

解决中文乱码

参考上一篇文章，改造一下MvcConfiguration配置文件，实现WebMvcConfigurer接口、重写其extendMessageConverters方法：

@Configuration
@EnableWebMvc
@ComponentScan({"org.example.controller"})
public class MvcConfiguration implements WebMvcConfigurer{
    public MvcConfiguration(){
        System.out.println("mvc configuration constructor...");
    }
//    通过@EnableWebMVC配置的时候起作用，
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        for(HttpMessageConverter httpMessageConverter:converters){
            if(StringHttpMessageConverter.class.isAssignableFrom(httpMessageConverter.getClass())){
                ((StringHttpMessageConverter)httpMessageConverter).setDefaultCharset(Charset.forName("UTF-8"));
            }
        }
    }

}

重启系统，测试：

中文乱码问题已解决。

问题：@EnableWebMvc的作用？

上述案例已经可以正常运行可，我们可以看到web.xml、applicationContext.xml以及springmvc.xml等配置文件都还在，一个都没少。

那么@EnableWebMvc究竟起什么作用？

我们去掉@EnableWebMvc配置文件试试看：项目中删掉MvcConfiguration文件。

重新启动项目，访问localhost:8080/hello，报404！

回忆一下MvcConfiguration文件中定义了controller的包扫描路径，现在MvcConfiguration文件被我们直接删掉了，controller的包扫描路径需要以其他方式定义，我们重新修改springmvc.xml文件，把controller包扫描路径加回来。

同时，我们需要把SpringMVC的注解驱动配置加回来：

    <!-- 扫描包 -->
    <context:component-scan base-package="org.example.controller"/>

    <mvc:annotation-driven />

以上两行加入到springmvc.xml配置文件中，重新启动应用：

应用可以正常访问了，中文乱码问题请参考上一篇文章，此处忽略。

因此我们是否可以猜测：@EnableWebMvc起到的作用等同于配置文件中的： <mvc:annotation-driven /> ?

@EnableWebMvc的底层原理

其实Spring的所有@Enablexxx注解的实现原理基本一致：和@Configuration注解结合、通过@Import注解引入其他配置类，从而实现向Spring IoC容器注入Bean。

@EnableWebMvc也不例外。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}

@EnableWebMvc引入了DelegatingWebMvcConfiguration类。看一眼DelegatingWebMvcConfiguration类，肯定也加了@Configuration注解的：

@Configuration(proxyBeanMethods = false)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
   ...

DelegatingWebMvcConfiguration类扩展自WebMvcConfigurationSupport，其实DelegatingWebMvcConfiguration并没有创建bean、实际创建bean的是他的父类WebMvcConfigurationSupport。

WebMvcConfigurationSupport按顺序注册如下HandlerMappings:

  1. RequestMappingHandlerMapping ordered at 0 for mapping requests to annotated controller methods.
  2. HandlerMapping ordered at 1 to map URL paths directly to view names.
  3. BeanNameUrlHandlerMapping ordered at 2 to map URL paths to controller bean names.
  4. HandlerMapping ordered at Integer.MAX_VALUE-1 to serve static resource requests.
  5. HandlerMapping ordered at Integer.MAX_VALUE to forward requests to the default servlet.

并注册了如下HandlerAdapters:

  1. RequestMappingHandlerAdapter for processing requests with annotated controller methods.
  2. HttpRequestHandlerAdapter for processing requests with HttpRequestHandlers.
  3. SimpleControllerHandlerAdapter for processing requests with interface-based Controllers.

注册了如下异常处理器HandlerExceptionResolverComposite：

  1. ExceptionHandlerExceptionResolver for handling exceptions through org.springframework.web.bind.annotation.ExceptionHandler methods.
  2. ResponseStatusExceptionResolver for exceptions annotated with org.springframework.web.bind.annotation.ResponseStatus.
  3. DefaultHandlerExceptionResolver for resolving known Spring exception types

以及：

Registers an AntPathMatcher and a UrlPathHelper to be used by:

  1. the RequestMappingHandlerMapping,
  2. the HandlerMapping for ViewControllers
  3. and the HandlerMapping for serving resources

Note that those beans can be configured with a PathMatchConfigurer.
Both the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver are configured with default instances of the following by default:

  1. a ContentNegotiationManager
  2. a DefaultFormattingConversionService
  3. an org.springframework.validation.beanvalidation.OptionalValidatorFactoryBean if a JSR-303 implementation is available on the classpath
  4. a range of HttpMessageConverters depending on the third-party libraries available on the classpath.

因此，@EnableWebMvc确实与 <mvc:annotation-driven /> 起到了类似的作用：注册SpringWebMVC所需要的各种特殊类型的bean到Spring容器中，以便在DispatcherServlet初始化及处理请求的过程中生效！

上一篇 Spring MVC 十一：中文乱码

相关推荐
昙鱼1 分钟前
springboot创建web项目
java·前端·spring boot·后端·spring·maven
eternal__day1 分钟前
数据结构（哈希表（中）纯概念版）
java·数据结构·算法·哈希算法·推荐算法
天之涯上上6 分钟前
JAVA开发 在 Spring Boot 中集成 Swagger
java·开发语言·spring boot
2402_857583497 分钟前
“协同过滤技术实战”：网上书城系统的设计与实现
java·开发语言·vue.js·科技·mfc
白宇横流学长7 分钟前
基于SpringBoot的停车场管理系统设计与实现【源码+文档+部署讲解】
java·spring boot·后端
APP 肖提莫11 分钟前
MyBatis-Plus分页拦截器，源码的重构（重构total总数的计算逻辑）
java·前端·算法
kirito学长-Java12 分钟前
springboot/ssm太原学院商铺管理系统Java代码编写web在线购物商城
java·spring boot·后端
爱学习的白杨树13 分钟前
MyBatis的一级、二级缓存
java·开发语言·spring
Code成立24 分钟前
《Java核心技术I》Swing的网格包布局
java·开发语言·swing
中草药z29 分钟前
【Spring】深入解析 Spring 原理：Bean 的多方面剖析（源码阅读）
java·数据库·spring boot·spring·bean·源码阅读
热门推荐
0119个Web前端交互式3D JavaScript框架和库02ARM学习（31）编译器对overlay方式的支持03玄机平台应急响应—webshell查杀04RAG 实践- Ollama+RagFlow 部署本地知识库05【一文读懂】NTN（非地面网络）技术介绍06(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明07ZZ038 物联网应用与服务赛题第J套08组基轨迹建模 GBTM的介绍与实现（Stata 或 R）09Docker 夺命连环 15 问10VSCode插件 —— Cody AI （免费AI助手！）