SpringMVC源码系列之自定义WebMvcConfigurer

最新推荐文章于 2024-05-15 17:36:01 发布
最新推荐文章于 2024-05-15 17:36:01 发布
阅读量2.2k 收藏
点赞数
分类专栏： Spring Spring源码讲解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Crabime/article/details/98207697
版权

Spring MVC中所有组件集中注册中心

组件集中注册中心是什么意思？说白了就是如果使用纯注解的方式启动项目，那注册在xml中的组件就转移到WebMvcConfigurer类的实现上了。
下面结合源码和实例一一解释，所有的组件的配置参见MvcConfig.java，详细源码见
当前目录下spring-mvc模块

那其中有哪些组件呢？

  1. 路径匹配转换器PathMatchConfigurer
  2. ContentNegotiationStrategy配置
路径匹配转换器PathMatchConfigurer

这里我贴出了PathMatchConfigurer配置代码

@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    // 不支持后置模糊匹配，/abc匹配正常，但/abc.*返回404
    configurer.setUseSuffixPatternMatch(true);
    // 不支持后面的正斜线，如/abc匹配正常，/abc/返回404
    configurer.setUseTrailingSlashMatch(false);
    AntPathMatcher pathMatcher = new AntPathMatcher();
    // Spring MVC默认是对URL大小写敏感的，这里设置为不敏感
    pathMatcher.setCaseSensitive(false);
    configurer.setPathMatcher(pathMatcher);
}

如果不满足于spring默认对URL解析方式，如/abc/==/abc，/ABC!=/abc，这里我们可以通过配置PathMatchConfigurer来完成，当然这里要解释的
是如果这里我们不配置suffixPattern/trailingSlash等，spring会有一套自己的默认配置。如spring会在WebMvcConfigurationSupport中
获取PathMatchConfigurer中配置的PathMatcher/URLPathHelper，如果没有配置，那它会new一个新的对象并存入spring容器中。
其它选项（suffixPattern/trailingSlash）默认值配置你会发现PathMatchConfigurer中并没有设置，他们默认值设置参考RequestMappingHandlerMapping.

ContentNegotiationStrategy配置

什么是ContentNegotiationStrategy？它在Spring MVC中起到什么作用呢？
为了更好的看到spring报错信息，这里引入log4j框架。注意：由于spring使用的日志框架是commons-logging，这里我用的是slf4j，所以这里
需要导入如下三个包，对这块不了解可以参考java日志组件介绍（common-logging，log4j，slf4j，logback ）：

<!-- slf4j核心包 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>
<!-- commons logging与slf4j桥接库 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
</dependency>
<!-- 解决slf4j NOP问题 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>

同时记着把这些包放到tomcat classpath下，Idea为artifact中。
在IndexController中增加一个返回json格式数据的接口.
在前台页面中增加一个Ajax请求接口，用于自定义请求。
正常Ajax请求如下，URL:http://localhost:8080/mvc/grb：

$("#get-random-json").click(function () {
    $.ajax({
        url: "${pageContext.servletContext.contextPath}/grb",
        type: "GET",
        success: function (data) {
            var name = data.name;
            var age = data.age;
            $("#random-json-text").text("name:" + name + ", age:" + age);
        }
    })
})

返回结果如下图：

注意：上面请求的URL没有带任何尾缀。
URL:http://localhost:8080/mvc/grb.xml。
返回结果如下图：

可以看出，spring这个时候已经报错了，那这个URL是如何解析的呢？这里是spring mvc请求流程堆栈：

org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:184)  // 使用MessageConverter将返回值转换为Accept格式
	  at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.handleReturnValue(RequestResponseBodyMethodProcessor.java:174)
	  at org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite.handleReturnValue(HandlerMethodReturnValueHandlerComposite.java:81) //处理RequestMapping注解对应HandlerMethod返回值
	  at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:113)
	  at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:827)
	  at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:738)
	  at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)
	  at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:967)
	  at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:901)
	  at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:970)
	  at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:861)
	  at javax.servlet.http.HttpServlet.service(HttpServlet.java:622)
	  at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:846)
	  at javax.servlet.http.HttpServlet.service(HttpServlet.java:729)
	  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:292)
	  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:207)
	  at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)
	  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:240)
	  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:207)
	  at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:212)
	  at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:94)
	  at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:504)
	  at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:141)
	  at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:79)
	  at org.apache.catalina.valves.AbstractAccessLogValve.invoke(AbstractAccessLogValve.java:620)
	  at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:88)
	  at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:502)
	  at org.apache.coyote.http11.AbstractHttp11Processor.process(AbstractHttp11Processor.java:1132)
	  at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:684)
	  at org.apache.tomcat.util.net.AprEndpoint$SocketProcessor.doRun(AprEndpoint.java:2521)
	  at org.apache.tomcat.util.net.AprEndpoint$SocketProcessor.run(AprEndpoint.java:2510)
	  - locked <0x1710> (a org.apache.tomcat.util.net.AprEndpoint$AprSocketWrapper)
	  at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	  at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	  at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
	  at java.lang.Thread.run(Thread.java:748)

上述栈顶就是spring mvc对请求结果处理逻辑，下面是处理RequestMapping返回值解析核心代码：

protected <T> void writeWithMessageConverters(T value, MethodParameter returnType,
			ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage)
			throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {

    Object outputValue;
    Class<?> valueType;
    Type declaredType;

    if (value instanceof CharSequence) {
        outputValue = value.toString();
        valueType = String.class;
        declaredType = String.class;
    }
    else {
        outputValue = value;
        valueType = getReturnValueType(outputValue, returnType);
        declaredType = getGenericType(returnType);
    }

    HttpServletRequest request = inputMessage.getServletRequest();
    // 获取HttpServletRequest中请求头中Accept或requestParameter中接收的返回值类型
    List<MediaType> requestedMediaTypes = getAcceptableMediaTypes(request);
    // 获取当前spring mvc环境中可以解析的所有数据类型
    List<MediaType> producibleMediaTypes = getProducibleMediaTypes(request, valueType, declaredType);

    if (outputValue != null && producibleMediaTypes.isEmpty()) {
        throw new IllegalArgumentException("No converter found for return value of type: " + valueType);
    }

    Set<MediaType> compatibleMediaTypes = new LinkedHashSet<MediaType>();
    // 如果请求的Accept数据类型为"application/xml"而spring mvc只能解析"application/json"，返回的compatibleMediaTypes就为空
    for (MediaType requestedType : requestedMediaTypes) {
        for (MediaType producibleType : producibleMediaTypes) {
            if (requestedType.isCompatibleWith(producibleType)) {
                compatibleMediaTypes.add(getMostSpecificMediaType(requestedType, producibleType));
            }
        }
    }
    // 如果没有注册合适的解析器就会抛出HttpMediaTypeNotAcceptableException异常
    if (compatibleMediaTypes.isEmpty()) {
        if (outputValue != null) {
            throw new HttpMediaTypeNotAcceptableException(producibleMediaTypes);
        }
        return;
    }
    ...
}

上面代码中getAcceptableMediaTypes(request)实现逻辑如下：

private List<MediaType> getAcceptableMediaTypes(HttpServletRequest request) throws HttpMediaTypeNotAcceptableException {
    // 使用contentNegotiationManager解析传过来的请求
    List<MediaType> mediaTypes = this.contentNegotiationManager.resolveMediaTypes(new ServletWebRequest(request));
    return (mediaTypes.isEmpty() ? Collections.singletonList(MediaType.ALL) : mediaTypes);
}

上面contentNegotiationManager调用ContentNegotiationStrategy来解析http请求，从HttpServletRequest中获取它想要返回的数据格式，
spring mvc默认的解析策略有如下两个：

  1. ServletPathExtensionContentNegotiationStrategy:根据尾缀如：.xml或请求中携带format参数指定使用什么格式如：?format=xml
  2. HeaderContentNegotiationStrategy:根据请求头中的Accept参数来判断

接着往下讲，那返回的数据格式又是怎么定的呢？看getProducibleMediaTypes方法调用过程：

protected List<MediaType> getProducibleMediaTypes(HttpServletRequest request, Class<?> valueClass, Type declaredType) {
    Set<MediaType> mediaTypes = (Set<MediaType>) request.getAttribute(HandlerMapping.PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE);
    if (!CollectionUtils.isEmpty(mediaTypes)) {
        return new ArrayList<MediaType>(mediaTypes);
    }
    else if (!this.allSupportedMediaTypes.isEmpty()) {
        List<MediaType> result = new ArrayList<MediaType>();
        // 获取到spring mvc中注册的所有message converter
        for (HttpMessageConverter<?> converter : this.messageConverters) {
            // GenericHttpMessageConverter将请求结果转化为目标对象并写入到http response中
            if (converter instanceof GenericHttpMessageConverter && declaredType != null) {
                if (((GenericHttpMessageConverter<?>) converter).canWrite(declaredType, valueClass, null)) {
                    result.addAll(converter.getSupportedMediaTypes());
                }
            }
            else if (converter.canWrite(valueClass, null)) {
                result.addAll(converter.getSupportedMediaTypes());
            }
        }
        return result;
    }
    else {
        return Collections.singletonList(MediaType.ALL);
    }
}

那这里的核心问题是spring mvc默认的message converter有哪些呢？由于我们在应用中并没有配置任何转换器，spring mvc怎么知道转换请求需要的数据格式，
这个时候可以看spring mvc默认converter注册地方：WebMvcConfigurationSupport#addDefaultHttpMessageConverters方法，代码如下：

protected final void addDefaultHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
    StringHttpMessageConverter stringConverter = new StringHttpMessageConverter();
    stringConverter.setWriteAcceptCharset(false);

    messageConverters.add(new ByteArrayHttpMessageConverter());
    messageConverters.add(stringConverter);
    messageConverters.add(new ResourceHttpMessageConverter());
    messageConverters.add(new SourceHttpMessageConverter<Source>());
    messageConverters.add(new AllEncompassingFormHttpMessageConverter());

    if (romePresent) {
        messageConverters.add(new AtomFeedHttpMessageConverter());
        messageConverters.add(new RssChannelHttpMessageConverter());
    }

    // 如果classpath中包含jackson-dataformat-xml依赖，则加载xml格式转换器
    if (jackson2XmlPresent) {
        ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.xml().applicationContext(this.applicationContext).build();
        messageConverters.add(new MappingJackson2XmlHttpMessageConverter(objectMapper));
    }
    else if (jaxb2Present) {
        messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
    }

    // 如果classpath中有jackson-databind依赖，则注册MappingJackson2HttpMessageConverter转换器，如果有gson依赖，则注册gson转换器
    if (jackson2Present) {
        ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json().applicationContext(this.applicationContext).build();
        messageConverters.add(new MappingJackson2HttpMessageConverter(objectMapper));
    }
    else if (gsonPresent) {
        messageConverters.add(new GsonHttpMessageConverter());
    }
}

综上所述：tomcat 406错误体现就是spring mvc中没有xml对应转换器，换句话说没有jackson-dataformat-xml依赖，这个时候将该依赖添加到pom.xml中，
并添加到tomcat classpath中，redeploy后会发现，接口又返回成功了，前面Ajax返回结果如下：

那ContentNegotiationConfigurer能做哪些自定义配置呢？这里我写了一个自定义消息转换器DEMO，源码及解释参考两一篇文章：
Spring MVC实现yaml格式交换

Crabime
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springmvc 配置fastjson
06-10
public class WebConfig implements WebMvcConfigurer { @Override public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { converters.add(new FastjsonHttpMessageConverter())...
springmvc配置
08-02
在servlet-context.xml中，我们定义视图解析器、拦截器、bean的扫描路径、以及自定义的处理器映射和适配器。 3. **HandlerMapping**：这个组件负责将请求映射到相应的处理器（Controller）。可以是基于注解的映射，...
PathMatchConfigurer 的作用
2201_75808326的博客
06-13 628
设置URL路径匹配器 PathMatchConfigurer可以设置URL路径匹配器，自定义实现方式。默认情况下使用Ant风格的路径匹配器（AntPathMatcher），但也可以通过实现了UrlPathMatcher接口的其他类来覆盖其行为。通过配置 PathMatchConfigurer 对象，我们可以灵活地控制Spring MVC框架对URL请求路径和Handler Method之间的匹配逻辑，并且实现更加精细化和高效的请求处理过程，提升Web应用程序性能和用户体验。否则不会考虑该部分内容。
WebMvcConfigurer 配置类
qq_44113347的博客
03-30 346
接口进行配置的好处是，可以通过编写自定义的配置类来覆盖框架默认的配置，从而实现更加灵活和个性化的配置。同时，这种方式也符合 Spring 框架的约定大于配置的设计理念。是一个自定义的配置类，实现了 Spring MVC 框架中的。接口，用于配置 Spring MVC 的相关参数和功能。这些配置都可以根据具体的需求进行自定义和修改。在这个配置类中，可以通过实现。
使用WebMvcConfigurer配置SpringMVC
最新发布
weixin_38687619的博客
05-15 1351
配置类是使用Java代码代替传统的xml配置文件,对SpirngMvc进行配置的一种方式，需要创建一个并推荐。
SpringBoot狂神08-(实现WebMvcConfigurer扩展配置)
Java后端技术栈
07-29 2283
官网阅读 在进行项目编写前，我们还需要知道一个东西，就是SpringBoot对我们的SpringMVC还做了哪些配置，包括如何扩展，如何定制。 只有把这些都搞清楚了，我们在之后使用才会更加得心应手。途径一：源码分析，途径二：官方文档！ 地址 ：https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/#boot-features-spring-mvc-auto-configuration
SpringBoot中的WebMvcConfigurer配置接口的详解
pan_junbiao的博客
09-01 3174
1. 简介 WebMvcConfigurer 配置接口其实是 Spring 内部的一种配置方式，采用 JavaBean 的形式来代替传统的 XML 配置文件形式进行针对框架个性化定制，可以自定义一些 Handler，Interceptor，ViewResolver，MessageConverter。基于 java-based 方式的 Spring MVC 配置，需要创建一个配置类并实现 WebMvcConfigurer接口。
WebMvcConfigurer接口详解及使用方式（Spring-WebMvc）
一只程序员的博客
12-19 957
WebMvcConfigurer接口提供了常用的web应用拦截方法。通过实现该接口可以实现添加自定义拦截器，跨域设置、页面跳转和静态资源访问等功能。
SpringMVC源码总结(九)HandlerMethodArgumentResolver介绍.pdf
11-28
除了这些内置的Resolver，我们还可以通过向Spring MVC的`WebMvcConfigurer`接口注册自定义的ArgumentResolver来扩展其功能。例如： ```java @Configuration public class MyWebConfig implements WebMvcConfigurer ...
注解式springMVC的demo
06-01
当然，也可以通过`WebMvcConfigurer`接口自定义配置。 12. **单元测试** 使用`MockMvc`工具，我们可以编写测试用例来测试Spring MVC控制器的行为，模拟HTTP请求并验证响应结果。 以上就是关于“注解式Spring MVC...
SpringMVC中使用Interceptor拦截器
08-06
public class WebConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/api/**...
SpringBoot之WebMvcConfigurer拦截器的常用使用详解
weixin 19953181360
10-23 1万+
目录1.引入pom依赖2. 启动类配置3.自定义拦截器配置 1.引入pom依赖 因为用到拦截器的 几乎都是web项目,引入下web包 拦截器对象也在web包里 <!--引入springboot父工程依赖--> <!--引入依赖作用： 可以省去version标签来获得一些合理的默认配置 --> <parent> <groupId>org.springframework.boot</group
WebMvcConfigurer的介绍以及两种配置方式
damokelisijian866的博客
08-12 3394
前言 公司的“僵尸项目”（好几年没维护和升级），昨天突然诈尸，出现了一个问题，需要解决，打开代码时，发现项目中用到的WebMvcConfigurerAdapter过期，需要用WebMvcConfigurer来做替换，今天就趁着说一下关于WebMvcConfigurer的两种配置方式。 WebMvcConfigurer介绍 WebMvcConfigurer是一个接口，提供很多自定义的拦截器，例如跨域设置、类型转化器等等。可以说此接口为开发者提前想到了很多拦截层面的需求，方便开发者自由选择使用。由于Spring
《Spring篇》---WebMvcConfigurer
CSDN_zcy_my的博客
11-24 2465
Spring---WebMvcConfigurer简介WebMvcConfigurer 配合HandlerInterceptor 拦截器配置校验服务Spring拦截器分类HandlerInterceptor例子简单描述@Order()注解@Order的注解源码解读Ordered接口类结论总结 简介 WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，V
WebMvcConfigurerAdapter与WebMvcConfigurer与WebMvcConfigurationSupport与WebMvcAutoConfiguration添加拦截器
zwj1030711290的CSDN
04-02 1221
首先以上4个类都是springboot中mvc的支持类 WebMvcConfigurer 为接口 WebMvcConfigurerAdapter 是 WebMvcConfigurer 的实现类大部分为空方法 ， 已经废除 WebMvcConfigurationSupport 是mvc的基本实现并包含了WebMvcConfigurer接口中的方法 WebMvcAutoConfiguration 是...
springmvc源码学习(一)RequestMappingHandlerMapping
码易的博客
07-18 953
目录前言一、RequestMappingHandlerMapping实例化二、使用步骤1.引入库2.读入数据总结 前言 RequestMappingHandlerMapping用于。 提示：以下是本篇文章正文内容，下面案例可供参考 一、RequestMappingHandlerMapping实例化 （1）WebMvcRequestHandlerProvider 在servlet的web环境下会加载该配置类，在类构造方法执行时，会初始化三个参数，其中一个参数是handlerMappings，此时对应的..
springmvc实用篇 -- WebMvcConfigurer
菜 头笔记
04-13 2547
WebMvcConfigurer这个接口干什么用，文字上的描述我就不再说了，我们直接从功能入手就知道这玩意能帮我们做些什么事 首先我们打开这个接口所定义的那些方法 public interface WebMvcConfigurer { default void configurePathMatch(PathMatchConfigurer configurer) {} default vo...
WebMvcConfigurer
weixin_47414034的博客
10-27 1032
我们常常会创建一个config包 ，在这个包里面新建一个MyMvcConfig类，这个类实现WebMvcConfigurer接口，并且重写这个接口里面的方法。常用来实现效果：用户想访问一个页面，先检查用户是否已经登录，如果没有登陆，就会提示你还没有登录，需要先登录，并返回登陆页面。
java 方式配置spring mvc 继承WebMvcConfigurerAdapter和继承WebMvcConfigurationSupport
热门推荐
miniy
08-30 1万+
使用 java 的方式配置 sping mvc 时遇到一个疑问，在spring in action 这本书中 配置 mvc 时 采用 继承 WebMvcConfigurerAdapter 类 @Configuration @EnableWebMvc @ComponentScan( basePackages = Constants.MVC_PACKAGE_PATH, u
SpringMVC源码解析：参数解析与自定义处理器详解
本篇文章是SpringMVC源码分析系列的一部分，主要针对Spring MVC框架中Controller方法参数解析的深入探讨。SpringMVC作为当前Web MVC架构的流行选择，其灵活性体现在Controller方法支持各种类型的参数，如Integer、...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值