SpringMVC使用@EnableWebMvc自定义配置

矫情吗；* 2022-11-16 00:56 193阅读 0赞

如果不使用@EnableWebMvc注解，web项目同样能正确接收请求，只不过使用的是默认配置的一些组件，这些组件都配置在DispatcherServlet.properties文件，如果想修改这些默认的组件或者添加一些新的组件，就需要使用@EnableWebMvc注解开启自定义配置，并注入一个实现了WebMvcConfigurer接口的Bean。

# 自定义配置的使用 #

## 开启MVC配置 ##

要实现spring mvc自定义配置，需要开启MVC配置：

package com.morris.spring.mvc.config;
    
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.FilterType;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    
    // 只扫描@Controller注解
    @Configuration
    @ComponentScan(value = "com.morris.spring.mvc", useDefaultFilters = false, includeFilters = { 
    		@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class)
    })
    @EnableWebMvc
    public class WebConfig { 
    }

相当于在xml中这么配置：

<mvc:annotation-driven/>

## MVC配置API ##

通过实现WebMvcConfigurer接口重写其中的方法来实现spring mvc自定义配置。

@Configuration
    public class MVCConfig implements WebMvcConfigurer { 
    ... ...

## 配置视图解析器 ##

重写WebMvcConfigurer接口的configureViewResolvers()方法：

public void configureViewResolvers(ViewResolverRegistry registry) { 
    	registry.jsp("/jsp/", ".jsp");
    }

这样配置后所有Controller返回的请求都会加上前缀`/jsp/`和后缀`.jsp`。例如Controller如下配置：

@Controller
    @RequestMapping("hello")
    public class HelloController { 
    
        @RequestMapping("index")
        public String success() { 
            return "index";
        }
    
    }

浏览器中请求`/hello/index`，spring就会去寻找`/jsp/index.jsp`。

相当于以前在spring-mvc.xml中这样配置：

<mvc:view-resolvers>
        <mvc:jsp/>
    </mvc:view-resolvers>

## 配置视图控制器 ##

重写addViewControllers()方法。

public void addViewControllers(ViewControllerRegistry registry) { 
    	registry.addViewController("/index").setViewName("index");
    }

适用于只返回视图，没有任何业务逻辑。

等价于在Controller中这么配置：

@RequestMapping("/index")
    public String index() { 
    	return "index";
    }

## 静态资源映射器 ##

重写addResourceHandlers()方法。

public void addResourceHandlers(ResourceHandlerRegistry registry) { 
    	registry.addResourceHandler("/image/**")
    			.addResourceLocations("classpath:/static/image/");
    }

这样在浏览器输入[**http://localhost:8080/image/1.png**][http_localhost_8080_image_1.png]，会去/static/image目录下寻找1.png文件。

## 默认的Servlet ##

重写configureDefaultServletHandling()方法。

public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { 
    	configurer.enable();
    }

所有没法处理的URL最后都会被这个默认的Servlet处理，这样配置后，所有的静态资源如css、js等静态资源都能正常返回了。

相当于以前在spring-mvc.xml中这样配置：

<mvc:default-servlet-handler/>

例如在浏览器输入http://localhost:8080/static/image/1.png，会去/static/image目录下寻找1.png文件。

## 添加拦截器 ##

重写WebMvcConfigurer接口的addInterceptors方法：

public void addInterceptors(InterceptorRegistry registry) { 
    	registry.addInterceptor(new MyInterceptor());
    }

MyInterceptor需要实现HandlerInterceptor接口：

package com.morris.spring.mvc.interceptor;
    
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    public class MyInterceptor implements HandlerInterceptor { 
    
        // 目标方法运行之前执行
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
            System.out.println("preHandle" + request.getRequestURI());
            return true;
        }
    
        // 目标方法运行之后执行
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { 
            System.out.println("postHandle");
        }
    
        // 页面响应后执行
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { 
            System.out.println("afterCompletion");
        }
    }

注意: postHandle对@ResponseBody这种方法没啥用，因为在执行postHandle之前请求就已经返回给浏览器了，如果想在响应中追加一些参数，可以使用ResponseBodyAdvice。

相当于以前在spring-mvc.xml中这样配置：

<mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.morris.spring.mvc.interceptor.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

# 源码分析 #

MVCConfig中的配置是怎么加载到Spring MVC中的呢？

## @EnableWebMvc ##

@EnableWebMvc导入了DelegatingWebMvcConfiguration类。

@Import(DelegatingWebMvcConfiguration.class)
    public @interface EnableWebMvc { 
    }

## DelegatingWebMvcConfiguration ##

@Configuration(proxyBeanMethods = false)
    public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { 
    
    	private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
    
    
    	@Autowired(required = false)
    	public void setConfigurers(List<WebMvcConfigurer> configurers) { 
    		// 注入所有的WebMvcConfigurer，这里是MVCConfig类
    		if (!CollectionUtils.isEmpty(configurers)) { 
    			this.configurers.addWebMvcConfigurers(configurers);
    		}
    	}
    ... ...
    	@Override
    	protected void addViewControllers(ViewControllerRegistry registry) { 
    		this.configurers.addViewControllers(registry);
    	}

DelegatingWebMvcConfiguration持有我们实现了WebMvcConfigurer接口的类MVCConfig的引用，DelegatingWebMvcConfiguration中的所有方法的调用都会委托给MVCConfig，再来看一下DelegatingWebMvcConfiguration的方法什么时候被调用。

看父类WebMvcConfigurationSupport：

> org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport\#viewControllerHandlerMapping

@Bean
    @Nullable
    public HandlerMapping viewControllerHandlerMapping(
    		@Qualifier("mvcPathMatcher") PathMatcher pathMatcher,
    		@Qualifier("mvcUrlPathHelper") UrlPathHelper urlPathHelper,
    		@Qualifier("mvcConversionService") FormattingConversionService conversionService,
    		@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) { 
    	ViewControllerRegistry registry = new ViewControllerRegistry(this.applicationContext);
    	addViewControllers(registry);
     // 模板方法模式
    
    	AbstractHandlerMapping handlerMapping = registry.buildHandlerMapping();
    	if (handlerMapping == null) { 
    		return null;
    	}
    	handlerMapping.setPathMatcher(pathMatcher);
    	handlerMapping.setUrlPathHelper(urlPathHelper);
    	handlerMapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider));
    	handlerMapping.setCorsConfigurations(getCorsConfigurations());
    	return handlerMapping;
    }
    
    protected void addViewControllers(ViewControllerRegistry registry) { 
    }

从这里可以发现注入HandlerMapping时会调用子类的addViewControllers()，进而调用WebMvcConfigurer.addViewControllers()来实现自定义配置。

也正因为WebMvcConfigurationSupport中注入了大量的组件，所以有些组件不会再使用DispatcherServlet.properties文件中的默认值了。

[http_localhost_8080_image_1.png]: http://localhost:8080/image/1.png