详解WebMvcConfigurer用法

最新推荐文章于 2024-05-15 17:36:01 发布
最新推荐文章于 2024-05-15 17:36:01 发布
阅读量1k 收藏 2
点赞数 1
分类专栏： java技能提升 文章标签： java mvc
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/TreeShu321/article/details/134983147
版权

目录

一、路径匹配规则configurePathMatch

二、配置内容协商 configureContentNegotiation

三、配置异步请求的支持configureAsyncSupport  

四、配置格式化器addFormatters 

五、注册简单的视图控制器addViewControllers

六、注册自定义的参数解析器addArgumentResolvers

七、注册自定义的返回值处理器addReturnValueHandlers  

八、配置消息转换器configureMessageConverters  

WebMvcConfigurer 是 Spring Framework 中的一个接口，它提供了一种扩展 Spring MVC 配置的方式。通过实现 WebMvcConfigurer 接口，你可以定制化 Spring MVC 的配置，例如添加拦截器、资源处理、视图解析器等。

一、路径匹配规则configurePathMatch

configurePathMatch 是 WebMvcConfigurer 接口中的一个方法，它用于配置 Spring MVC 中的路径匹配规则。主要用于配置路径匹配的选项，例如设置路径是否区分大小写、路径后缀是否匹配等。

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

@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        // 设置路径是否区分大小写，默认为 true
        configurer.setUseCaseSensitiveMatch(false);

        // 设置是否在路径匹配时忽略路径后缀，默认为 true
        configurer.setUseTrailingSlashMatch(true);
    }
}

在上述示例中，通过 configurePathMatch 方法设置了两个路径匹配的选项：

  1. setUseCaseSensitiveMatch(false)：设置路径是否区分大小写。默认情况下，路径匹配是区分大小写的。如果设置为 false，则表示路径不区分大小写。

  2. setUseTrailingSlashMatch(true)：设置是否在路径匹配时忽略路径后缀。默认情况下，路径匹配时会忽略路径后缀。如果设置为 true，则表示路径匹配时考虑路径后缀。

二、配置内容协商 configureContentNegotiation

configureContentNegotiation 是 WebMvcConfigurer 接口中的一个方法，它用于配置内容协商（Content Negotiation）的选项。内容协商是指客户端和服务器之间协商最适合的响应格式的过程。在 Spring MVC 中，可以通过 configureContentNegotiation 方法配置内容协商的相关选项。

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

@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        // 设置默认的内容类型
        configurer.defaultContentType(MediaType.APPLICATION_JSON);

        // 启用路径扩展（例如：/data.json）
        configurer.favorPathExtension(true);

        // 启用参数扩展（例如：/data?format=json）
        configurer.favorParameter(true);

        // 设置参数名称，默认是 "format"
        configurer.parameterName("mediaType");

        // 设置支持的媒体类型
        configurer.mediaType("json", MediaType.APPLICATION_JSON);
        configurer.mediaType("xml", MediaType.APPLICATION_XML);
    }
}

在上述示例中，通过 configureContentNegotiation 方法设置了以下内容协商的选项：

  1. defaultContentType(MediaType.APPLICATION_JSON)：设置默认的内容类型为 JSON。

  2. favorPathExtension(true)：启用路径扩展，例如允许 /data.json 或 /data.xml。

  3. favorParameter(true)：启用参数扩展，例如允许 /data?format=json 或 /data?format=xml。

  4. parameterName("mediaType")：设置参数名称，默认是 "format"。

  5. mediaType("json", MediaType.APPLICATION_JSON) 和 mediaType("xml", MediaType.APPLICATION_XML)：设置支持的媒体类型。

三、配置异步请求的支持configureAsyncSupport  

configureAsyncSupport 是 WebMvcConfigurer 接口中的一个方法，它用于配置异步请求的支持。异步请求指的是客户端发起的请求，服务器在处理请求的过程中可以释放对连接的占用，而不必等待请求处理完成。这使得服务器能够更有效地处理大量的并发请求。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.AsyncSupportConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.AsyncSupportConfigurer.DefaultTimeoutConfigurer;

@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void configureAsyncSupport(AsyncSupportConfigurer configurer) {
        // 设置异步请求超时时间（毫秒）
        configurer.setDefaultTimeout(30000);

        // 设置异步请求线程池
        configurer.setTaskExecutor(myAsyncTaskExecutor());

        // 配置异步请求拦截器
        configurer.registerCallableInterceptors(myAsyncCallableInterceptor());
        configurer.registerDeferredResultInterceptors(myAsyncDeferredResultInterceptor());
    }

    // 自定义异步请求线程池
    @Bean
    public AsyncTaskExecutor myAsyncTaskExecutor() {
        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        taskExecutor.setCorePoolSize(5);
        taskExecutor.setMaxPoolSize(10);
        taskExecutor.setQueueCapacity(25);
        taskExecutor.initialize();
        return taskExecutor;
    }

    // 自定义异步请求拦截器
    @Bean
    public CallableProcessingInterceptor myAsyncCallableInterceptor() {
        return new MyAsyncCallableInterceptor();
    }

    // 自定义DeferredResult拦截器
    @Bean
    public DeferredResultProcessingInterceptor myAsyncDeferredResultInterceptor() {
        return new MyAsyncDeferredResultInterceptor();
    }

    // 示例的自定义CallableProcessingInterceptor实现
    private static class MyAsyncCallableInterceptor implements CallableProcessingInterceptor {
        // 实现自定义逻辑
    }

    // 示例的自定义DeferredResultProcessingInterceptor实现
    private static class MyAsyncDeferredResultInterceptor implements DeferredResultProcessingInterceptor {
        // 实现自定义逻辑
    }
}

上述代码中，通过 configureAsyncSupport 方法配置了异步请求的一些选项：

  1. setDefaultTimeout(30000)：设置异步请求的默认超时时间为 30 秒。

  2. setTaskExecutor(myAsyncTaskExecutor())：配置自定义的异步请求线程池。

  3. registerCallableInterceptors(myAsyncCallableInterceptor())：注册自定义的 Callable 请求拦截器。

  4. registerDeferredResultInterceptors(myAsyncDeferredResultInterceptor())：注册自定义的 DeferredResult 请求拦截器。

四、配置格式化器addFormatters 

addFormatters 是 WebMvcConfigurer 接口中的一个方法，用于配置格式化器（Formatter）。格式化器在 Spring MVC 中用于将字符串表示的数据转换成实际的 Java 对象，或者反过来将 Java 对象转换成字符串。

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

@Configuration
@EnableWebMvc
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        // 添加自定义的日期格式化器
        registry.addFormatter(new MyDateFormatter());

        // 添加自定义的金额格式化器
        registry.addFormatter(new MyCurrencyFormatter());
    }

    // 示例的自定义日期格式化器
    private static class MyDateFormatter implements Formatter<Date> {
        // 实现日期格式化逻辑
    }

    // 示例的自定义金额格式化器
    private static class MyCurrencyFormatter implements Formatter<BigDecimal> {
        // 实现金额格式化逻辑
    }
}

上述代码中，通过 addFormatters 方法配置了两个自定义的格式化器：

  1. MyDateFormatter：自定义的日期格式化器，实现了 Formatter<Date> 接口。

  2. MyCurrencyFormatter：自定义的金额格式化器，实现了 Formatter<BigDecimal> 接口。

五、配置拦截器addInterceptors 

addInterceptors 是 WebMvcConfigurer 接口中的一个方法，它用于配置拦截器（Interceptor）。拦截器可以用于在请求进入处理器（controller）之前或之后执行一些逻辑，例如日志记录、权限验证等。 

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

@Configuration
@EnableWebMvc
public class MyWebMvcConfigurer implements WebMvcConfigurer {

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

    // 示例的自定义拦截器
    private static class MyInterceptor implements HandlerInterceptor {
        // 在请求处理之前调用
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            // 实现拦截器的逻辑
            return true; // 继续执行后续的拦截器或处理器
        }

        // 在请求处理之后调用
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
            // 实现拦截器的逻辑
        }

        // 在整个请求完成之后调用
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            // 实现拦截器的逻辑
        }
    }
}

上述代码中，通过 addInterceptors 方法配置了一个自定义的拦截器 MyInterceptor：

  • addPathPatterns("/api/**")：指定拦截的路径。

  • excludePathPatterns("/public/**")：指定不拦截的路径。

MyInterceptor 类实现了 HandlerInterceptor 接口，其中的三个方法分别在请求处理之前、之后以及整个请求完成之后被调用。你可以在这些方法中实现自定义的拦截逻辑，例如权限验证、日志记录等。

五、注册简单的视图控制器addViewControllers

addViewControllers 是 WebMvcConfigurer 接口中的一个方法，用于注册简单的视图控制器，从而无需编写控制器方法即可实现 URL 到视图的映射。

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

@Configuration
@EnableWebMvc
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        // 注册简单的视图控制器
        registry.addViewController("/home").setViewName("home");
        registry.addViewController("/login").setViewName("login");
        registry.addViewController("/dashboard").setViewName("dashboard");
    }
}

上述代码中，通过 addViewControllers 方法注册了三个简单的视图控制器：

  1. /home 映射到名为 "home" 的视图。
  2. /login 映射到名为 "login" 的视图。
  3. /dashboard 映射到名为 "dashboard" 的视图。

六、注册自定义的参数解析器addArgumentResolvers


addArgumentResolvers 是 WebMvcConfigurer 接口中的一个方法，用于注册自定义的参数解析器（Argument Resolvers）。参数解析器在 Spring MVC 中用于将请求中的参数映射到控制器方法的参数上，或者在处理器方法执行前进行一些额外的参数解析逻辑。 

import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
@EnableWebMvc
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        // 注册自定义的参数解析器
        argumentResolvers.add(new MyCustomArgumentResolver());
    }

    // 示例的自定义参数解析器
    private static class MyCustomArgumentResolver implements HandlerMethodArgumentResolver {
        // 实现参数解析逻辑
    }
}

上述代码中，通过 addArgumentResolvers 方法注册了一个自定义的参数解析器 MyCustomArgumentResolver。这个自定义的解析器需要实现 HandlerMethodArgumentResolver 接口，然后在接口方法中实现参数的解析逻辑。

自定义参数解析器可以用于解析控制器方法的参数，将请求中的数据转换为控制器方法所需的参数类型。这样的定制可以用于处理一些特殊的场景，例如将请求中的 JSON 数据转换为对象等。

七、注册自定义的返回值处理器addReturnValueHandlers  

addReturnValueHandlers 是 WebMvcConfigurer 接口中的一个方法，用于注册自定义的返回值处理器（Return Value Handlers）。返回值处理器在 Spring MVC 中用于将控制器方法的返回值转换为响应体的内容。 

import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
@EnableWebMvc
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) {
        // 注册自定义的返回值处理器
        returnValueHandlers.add(new MyCustomReturnValueHandler());
    }

    // 示例的自定义返回值处理器
    private static class MyCustomReturnValueHandler implements HandlerMethodReturnValueHandler {
        // 实现返回值处理逻辑
    }
}

上述代码中，通过 addReturnValueHandlers 方法注册了一个自定义的返回值处理器 MyCustomReturnValueHandler。这个自定义的处理器需要实现 HandlerMethodReturnValueHandler 接口，然后在接口方法中实现返回值的处理逻辑。

自定义返回值处理器可以用于处理控制器方法的返回值，将其转换为适当的响应格式。这样的定制可以用于处理一些特殊的场景，例如将对象转换为 JSON 数据等。

八、配置消息转换器configureMessageConverters  

configureMessageConverters 是 WebMvcConfigurer 接口中的一个方法，用于配置消息转换器（Message Converters）。消息转换器在 Spring MVC 中负责将 HTTP 请求的数据转换为 Java 对象，以及将 Java 对象转换为 HTTP 响应的数据。

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
@EnableWebMvc
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        // 注册自定义的消息转换器
        converters.add(new MyCustomMessageConverter());

        // 注册Jackson的JSON消息转换器
        converters.add(new MappingJackson2HttpMessageConverter());
    }

    // 示例的自定义消息转换器
    private static class MyCustomMessageConverter extends AbstractHttpMessageConverter<Object> {
        // 实现消息转换逻辑
    }
}

上述代码中，通过 configureMessageConverters 方法注册了两个消息转换器：

  1. MyCustomMessageConverter：自定义的消息转换器，需要继承 AbstractHttpMessageConverter 并实现相应的转换逻辑。

  2. MappingJackson2HttpMessageConverter：Jackson 框架提供的 JSON 消息转换器，用于将 JSON 数据转换为对象，以及将对象转换为 JSON 数据。

自定义消息转换器可以用于处理特殊的数据格式，例如 XML、Protocol Buffers 等。

境里婆娑
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
spring boot拦截器的使用场景示例详解
08-19
这可以通过实现`WebMvcConfigurer`接口并重写`addInterceptors`方法来完成： ```java @Configuration public class InterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors...
Spring 跨域配置请求详解
08-26
Spring 跨域配置请求详解 跨域问题在Web开发中是一个常见的挑战，它涉及到浏览器的安全策略——同源策略。同源策略限制了Web应用程序只能与相同源（协议+域名+端口）的服务器进行通信，以防止恶意网站窃取或篡改...
WebMvcConfigurer 和 WebMvcConfigurationSupport
asddasddeedd的博客
10-25 6305
使用场景：在权限场景中，通常会有要求用户登录之后才能访问的场景。对于这些问题可以多种解决方案，如：使用Cookie+Session的会话控制、使用拦截器、使用SpringSecurity或shiro等权限管理框架等。这里使用Cookie+Session处理。处理的逻辑为：用户第一次登录之后会得到一个cookie，在以后每次的访问过程中都会携带Cookie进行访问。
《Spring篇》---WebMvcConfigurer
CSDN_zcy_my的博客
11-24 2465
Spring---WebMvcConfigurer简介WebMvcConfigurer 配合HandlerInterceptor 拦截器配置校验服务Spring拦截器分类HandlerInterceptor例子简单描述@Order()注解@Order的注解源码解读Ordered接口类结论总结 简介 WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，V
使用WebMvcConfigurer配置SpringMVC
最新发布
weixin_38687619的博客
05-15 1351
配置类是使用Java代码代替传统的xml配置文件,对SpirngMvc进行配置的一种方式，需要创建一个并推荐。
WebMvcConfigurer
weixin_47414034的博客
10-27 1032
我们常常会创建一个config包 ，在这个包里面新建一个MyMvcConfig类，这个类实现WebMvcConfigurer接口，并且重写这个接口里面的方法。常用来实现效果：用户想访问一个页面，先检查用户是否已经登录，如果没有登陆，就会提示你还没有登录，需要先登录，并返回登陆页面。
Java系列 - WebMvcConfigurer详解
ifredom
05-17 2859
WebMvcConfigurer接口常用的方法： /* 拦截器配置 */ void addInterceptors(InterceptorRegistry var1); /* 视图跳转控制器 */ void addViewControllers(ViewControllerRegistry registry); /** *静态资源处理 **/ void addResourceHandlers(ResourceHandlerRegistry registry); /* 默认静态资源处理器 */ void
Spring MVC常用配置
codedot
03-06 1047
使用Spring MVC过程中，常用的一些配置。
spring mvc文档阅读笔记——02
a123123sdf的博客
01-30 572
spring mvc 超详细笔记，3w字总结。
Spring Boot Thymeleaf实现国际化的方法详解
08-25
在本文中，我们将深入探讨如何使用Spring Boot和Thymeleaf实现国际化（i18n）。 首先，我们需要在项目中添加Thymeleaf的依赖。在`pom.xml`文件中，引入以下依赖： ```xml <groupId>org.springframework.boot ...
Spring实现处理跨域请求代码详解
08-28
Spring实现处理跨域请求代码详解 Spring实现处理跨域请求代码详解是指在Spring框架中如何处理跨域请求，以便让客户端可以跨域访问服务器端的资源。本文将详细介绍跨域请求的概念、原因、解决方案，并提供实用的代码...
详解自定义SpringMVC的Http信息转换器的使用
08-28
public class WebConfig implements WebMvcConfigurer { @Override public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { converters.add(new CustomBinaryConverter()); } } ...
SpringBoot之WebMvcConfigurer拦截器的常用使用详解
weixin 19953181360
10-23 1万+
目录1.引入pom依赖2. 启动类配置3.自定义拦截器配置 1.引入pom依赖 因为用到拦截器的 几乎都是web项目,引入下web包 拦截器对象也在web包里 <!--引入springboot父工程依赖--> <!--引入依赖作用： 可以省去version标签来获得一些合理的默认配置 --> <parent> <groupId>org.springframework.boot</group
Springboot设置接口超时配置
zuozhiyoulaisam的专栏
12-31 1万+
Springboot设置服务超时配置方式 第一种方式 : application.yml or bootstarp.yml 设置 : spring.mvc.async.request-timeout=5000 单位: ms 超时时间 5s 第二种方式 : 重写WebMvcConfigurerAdapter 的configureAsyncSupport方法 @Configuration public class WebMvcAdapter extends WebMvcConfigurationSup
SpringBoot--使用WebMvcConfigurer配置SpringMVC
一个巨大的博客
03-05 1252
 从Spring 5开始，WebMvcConfigure接口包含了WebMvcConfigurerAdapter类中所有方法的默认实现，因此WebMvcConfigurerAdapter这个适配器就被淘汰了  所以我们现在就来看一下如何由实现WebMvcConfigure接口来配置SpringMVC 本文参考转载于https://www.cnblogs.com/cl-rr/p/9632886.ht...
Spring官网阅读（十五）Spring中的格式化（Formatter）
做一个认真的程序员
04-01 4569
在上篇文章中，我们已经学习过了Spring中的类型转换机制。现在我们考虑这样一个需求：在我们web应用中，我们经常需要将前端传入的字符串类型的数据转换成指定格式或者指定数据类型来满足我们调用需求，同样的，后端开发也需要将返回数据调整成指定格式或者指定类型返回到前端页面。这种情况下，Converter已经没法直接支撑我们的需求了。这个时候，格式化的作用就很明显了，这篇文章我们就来介绍Spring中...
SpringBoot---WebMvcConfigurer详解
热门推荐
zhangpower1993的博客
04-04 18万+
目录 1. 简介 2. WebMvcConfigurer接口 2.1 addInterceptors：拦截器 2.2addViewControllers：页面跳转 2.3addResourceHandlers：静态资源 2.4configureDefaultServletHandling：默认静态资源处理器 2.5configureViewResolvers：视图解析器...
webmvcconfigurer详解
04-06
WebMvcConfigurer是一个接口，可以使用它来配置Spring MVC的行为。它包含许多可重写的方法，例如配置静态资源映射，注册拦截器，添加视图解析器等。通过实现或扩展WebMvcConfigurer接口，可以对Spring MVC进行更多的自定义配置。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

境里婆娑

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值