devbox
Monodyee
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

WebMvcConfigurer 和 WebMvcConfigurationSupport

作者：Monodyee | 2024-05-16 02:35:21

赞

踩

webmvcconfigurationsupport

一、前言 

WebMvcConfigurer 是一个接口，用于配置全局的SpringMVC的相关属性，采用JAVABean的方式来代替传统的XML配置文件，提供了跨域设置、静态资源处理器、类型转化器、自定义拦截器、页面跳转等能力。

WebMvcConfigurationSupport是webmvc的配置类，如果在springboot项目中，有配置类继承了WebMvcConfigurationSupport，那么webmvc的自动配置类WebMvcAutoConfiguration就会失效。

官方推荐直接实现WebMvcConfigurer 或者 继承WebMvcConfigurationSupport，

方式一：实现WebMvcConfigurer接口（推荐），方式二：继承WebMvcConfigurationSupport（/səˈpɔːt/）类。 

二、WebMvcConfigurer 

  1. package com.syh.pdd.config.web;
  2.  
  3. import com.fasterxml.jackson.databind.DeserializationFeature;
  4. import com.fasterxml.jackson.databind.ObjectMapper;
  5. import org.springframework.beans.factory.annotation.Value;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.http.converter.HttpMessageConverter;
  9. import org.springframework.http.converter.StringHttpMessageConverter;
  10. import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
  11. import org.springframework.web.method.support.HandlerMethodArgumentResolver;
  12. import org.springframework.web.servlet.config.annotation.*;
  13.  
  14. import java.nio.charset.Charset;
  15. import java.text.SimpleDateFormat;
  16. import java.util.ArrayList;
  17. import java.util.List;
  18.  
  19. @Configuration
  20. public class WebConfig implements WebMvcConfigurer {
  21.  
  22.     // 用户头像
  23.     @Value("${file.userImage.writePath}")
  24.     private String userImageWritePath;
  25.     @Value("${file.userImage.readPath}")
  26.     private String userImageReadPath;
  27.  
  28.     /**
  29.      * 映射文件路径配置
  30.      */
  31.     @Override
  32.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  33.  
  34.  
  35.         registry.addResourceHandler("/webjars/**")
  36.                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
  37.  
  38.         registry.addResourceHandler("BJTPReadpath")
  39.                 .addResourceLocations("file:"+ "BJTPSavepath");
  40.  
  41.         // 浏览器测试图片回显路径: http://IP:8080/file/ewm/Img/2023/10/12/图片名称.jpg
  42.   	    registry
  43.                 // 图片回显路径
  44.                 .addResourceHandler("file/ewm/Img/**")
  45.                 // 图片存放路径
  46.                 .addResourceLocations("file:D:/file/ewm/Img/");
  47.         }
  48.     }
  49.  
  50.     /**
  51.      * 跨域配置添加
  52.      */
  53.     @Override
  54.     public void addCorsMappings(CorsRegistry registry) {
  55.         // 设置允许跨域的路径
  56.         registry.addMapping("/**")
  57.                 // 设置允许跨域请求的域名
  58.               //  .allowedOrigins("*")
  59.                 .allowedOriginPatterns("*")
  60.                 // 是否允许证书 不再默认开启
  61.                 .allowCredentials(true)
  62.                 // 设置允许的方法
  63.                 .allowedMethods("*")
  64.                 // 跨域允许时间
  65.                 .maxAge(3600);
  66.     }
  67.  
  68.     //解决中文乱码问题
  69.     @Override
  70.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  71.         //解决中文乱码
  72.         converters.add(responseBodyConverter());
  73.         //解决 添加解决中文乱码后 上述配置之后，返回json数据直接报错 500：no convertter for return value of type
  74.         converters.add(messageConverter());
  75.     }
  76.     @Bean
  77.     public HttpMessageConverter<String> responseBodyConverter(){
  78.         StringHttpMessageConverter converter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
  79.         return converter;
  80.     }
  81.     @Bean
  82.     public MappingJackson2HttpMessageConverter messageConverter() {
  83.         MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
  84.         converter.setObjectMapper(getObjectMapper());
  85.         return converter;
  86.     }
  87.     @Bean
  88.     public ObjectMapper getObjectMapper() {
  89.         return new ObjectMapper();
  90.     }
  91.  
  92.     /**
  93.      *  格式化返回的内容
  94.      *  https://my.oschina.net/u/3681868/blog/3075150
  95.      * */
  96.     @Override
  97.     public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
  98.         MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
  99.         ObjectMapper objectMapper = converter.getObjectMapper();
  100.         // 时间格式化
  101.         objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
  102.         objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
  103.         // 设置格式化内容
  104.         converter.setObjectMapper(objectMapper);
  105.         converters.add(0, converter);
  106.     }
  107.  
  108.     /**
  109.      * 添加Web项目的拦截器
  110.      */
  111.     @Override
  112.     public void addInterceptors(InterceptorRegistry registry) {
  113.         //放行路径
  114.         List<String> jwtExcludePatterns = new ArrayList();
  115.         // 登录接口放行
  116.         jwtExcludePatterns.add("/api/user/login");
  117.         // 验证码放行
  118.         jwtExcludePatterns.add("/api/user/getVerify/**");
  119.         // 前端更换头像请求，没有走拦截器，此处放行
  120.         jwtExcludePatterns.add("/api/user/updatePicture");
  121.         // 对所有api开头的访问路径，都通过MyInterceptor拦截器进行拦截，MyInterceptor代码在下面
  122.         registry.addInterceptor(new MyInterceptor()).addPathPatterns("/api/**")
  123.                 .excludePathPatterns(jwtExcludePatterns);
  124.     }
  125.  
  126.     /*解析器  使用方法在文章末尾*/
  127.     @Override
  128.     public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
  129.         WebMvcConfigurer.super.addArgumentResolvers(resolvers);
  130.     }
  131. }

1、自定义拦截器

什么是拦截器：在AOP（Aspect-Oriented Programming）中用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略

为什么需要拦截器：在做身份认证或者是进行日志的记录时，我们需要通过拦截器达到我们的目的。最常用的登录拦截、或是权限校验、或是防重复提交、或是根据业务像12306去校验购票时间,总之可以去做很多的事情

  1.         <dependency>
  2.             <groupId>net.minidev</groupId>
  3.             <artifactId>json-smart</artifactId>
  4.         </dependency>
  5.         <dependency>
  6.             <groupId>com.vaadin.external.google</groupId>
  7.             <artifactId>android-json</artifactId>
  8.             <version>0.0.20131108.vaadin1</version>
  9.             <scope>compile</scope>
  10.         </dependency>
  1. package com.syh.pdd.config.web;
  2.  
  3. import com.syh.pdd.Utils.token.JwtUtil;
  4. import lombok.extern.slf4j.Slf4j;
  5. import net.minidev.json.JSONObject;
  6. import org.springframework.http.HttpMethod;
  7. import org.springframework.web.servlet.HandlerInterceptor;
  8. import org.springframework.web.servlet.ModelAndView;
  9.  
  10. import javax.servlet.http.HttpServletRequest;
  11. import javax.servlet.http.HttpServletResponse;
  12. import java.io.IOException;
  13. import java.io.PrintWriter;
  14. import java.text.SimpleDateFormat;
  15. import java.util.Date;
  16.  
  17. /**
  18.  * 自定义拦截器类token认证
  19.  * 注意：可以实现多个拦截器，只需要继续实现HandlerInterceptor即可            
  20.  */
  21. @Slf4j
  22. public class MyInterceptor implements HandlerInterceptor {
  23.     /**
  24.      * 访问控制器方法前执行
  25.      */
  26.     @Override
  27.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException {
  28.         // ==========!!!!!!注意注意注意   注意注意   注意注意   ========================
  29.         /*
  30.          * 前端在请求的时候会发送一个OPTION请求来验证本次请求是否安全，
  31.          * 但是springboot的拦截器会拦截所有请求。因为第一次是OPTION没有携带JWT，所以验证失败
  32.          * */
  33.         if (HttpMethod.OPTIONS.toString().equals(request.getMethod())) {
  34.             return true;
  35.         }
  36.         // 获取token
  37.         String token = request.getHeader("token");
  38.         // 校验token
  39.         if (JwtUtil.checkToken(token)) {
  40.             log.info(request.getRequestURL() + ">>>" +
  41.                     new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "通过token验证");
  42.             return true; // 放行
  43.         } else{
  44.             //设置response状态
  45.             response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
  46.             response.setCharacterEncoding("UTF-8");
  47.             response.setContentType("application/json; charset=utf-8");
  48.             //设置失败响应数据
  49.             JSONObject res = new JSONObject();
  50.             res.put("status","101010");
  51.             res.put("msg","登录过期，请重新登录");
  52.             PrintWriter out = null ;
  53.             out = response.getWriter();
  54.             out.write(res.toString());
  55.             out.flush();
  56.             out.close();
  57.             return false; // 拦截
  58.         }
  59.     }
  60.  
  61.     /**
  62.      * 访问控制器方法后执行
  63.      */
  64.     @Override
  65.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
  66.     }
  67.  
  68.     /**
  69.      * postHandle方法执行完成后执行，一般用于释放资源
  70.      */
  71.     @Override
  72.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
  73.     }
  74. }
  75.  
  1. /**
  2.  * Web配置类
  3.  */
  4. @Configuration
  5. public class WebConfig implements WebMvcConfigurer {
  6.     /**
  7.      * 添加Web项目的拦截器
  8.      */
  9.     @Override
  10.     public void addInterceptors(InterceptorRegistry registry) {
  11.         //放行路径
  12.         List<String> jwtExcludePatterns = new ArrayList();
  13.         // 登录接口放行
  14.         jwtExcludePatterns.add("/system/user/login");
  15.         // 验证码放行
  16.         jwtExcludePatterns.add("/system/user/getVerify/**");
  17.         // 对所有图片资源放行
  18.         jwtExcludePatterns.add("/Project/saveFile/**");
  19.  
  20.         // 拦截路径：对所有访问路径，都通过MyInterceptor类型的拦截器进行拦截
  21.         registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**")
  22.                 .excludePathPatterns(jwtExcludePatterns);
  23.  
  24.     }
  25. }

三、WebMvcConfigurationSupport

  1. package com.hssmart.config.web;
  2.  
  3. import com.fasterxml.jackson.databind.DeserializationFeature;
  4. import com.fasterxml.jackson.databind.ObjectMapper;
  5. import org.springframework.beans.factory.annotation.Value;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.http.converter.HttpMessageConverter;
  9. import org.springframework.http.converter.StringHttpMessageConverter;
  10. import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
  11. import org.springframework.web.servlet.config.annotation.CorsRegistry;
  12. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  13. import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
  14.  
  15. import java.nio.charset.Charset;
  16. import java.text.SimpleDateFormat;
  17. import java.util.List;
  18.  
  19. @Configuration
  20. public class WebConfig extends WebMvcConfigurationSupport{
  21.  
  22.     // 自定义一个拦截器
  23.     @Autowired
  24.     UserArgumentResolver userArgumentResolver;
  25.  
  26.  
  27.     /**
  28.      * 映射文件路径配置
  29.      */
  30.     @Override
  31.     protected void addResourceHandlers(ResourceHandlerRegistry registry) {
  32.  
  33.         registry.addResourceHandler("swagger-ui.html")
  34.                 .addResourceLocations("classpath:/META-INF/resources/");
  35.  
  36.         registry.addResourceHandler("/webjars/**")
  37.                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
  38.  
  39.  
  40.         /**
  41.          * 说明：增加虚拟路径(经过本人测试：在此处配置的虚拟路径，用springboot内置的tomcat时有效，
  42.          用外部的tomcat也有效;所以用到外部的tomcat时不需在tomcat/config下的相应文件配置虚拟路径了,阿里云linux也没问题)
  43.          */
  44.         //registry.addResourceHandler("/pic/**").addResourceLocations("file:E:/pic/");
  45.  
  46.  
  47.  
  48.         registry.addResourceHandler("BJTPReadpath")
  49.                 .addResourceLocations("file:"+ "BJTPSavepath");
  50.  
  51.  
  52.         //阿里云(映射路径去除盘符)
  53.         //registry.addResourceHandler("/ueditor/image/**").addResourceLocations("/upload/image/");
  54.         //registry.addResourceHandler("/ueditor/video/**").addResourceLocations("/upload/video/");
  55.  
  56.         //用户图片路径
  57.         registry.addResourceHandler("/Project/saveFile/user/userImg/**"(网络路径，其实可以任意定义))
  58.                 .addResourceLocations("file:D:/JAVA/Project/saveFile/user/userImg/"(储存路径));
  59.  
  60.         super.addResourceHandlers(registry);
  61.     }
  62.  
  63.  
  64.     /**
  65.      * 跨域配置添加
  66.      */
  67.     @Override
  68.     public void addCorsMappings(CorsRegistry registry) {
  69.         // 设置允许跨域的路径
  70.         registry.addMapping("/**")
  71.                 // 设置允许跨域请求的域名
  72.                 .allowedOrigins("*")
  73.                 // 是否允许证书 不再默认开启
  74.                 .allowCredentials(true)
  75.                 // 设置允许的方法 springboot较高版本不能使用*号
  76.                 // .allowedMethods("GET", "POST", "PUT", "OPTIONS", "DELETE", "PATCH")
  77.                 .allowedMethods("*")
  78.                 // 跨域允许时间
  79.                 .maxAge(3600);
  80.     }
  81.  
  82.  
  83.     //解决中文乱码问题
  84.     @Override
  85.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  86.         super.configureMessageConverters(converters);
  87.         //解决中文乱码
  88.         converters.add(responseBodyConverter());
  89.         //解决 添加解决中文乱码后 上述配置之后，返回json数据直接报错 500：no convertter for return value of type
  90.         converters.add(messageConverter());
  91.     }
  92.  
  93.  
  94.     @Bean
  95.     public HttpMessageConverter<String> responseBodyConverter(){
  96.         StringHttpMessageConverter converter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
  97.         return converter;
  98.     }
  99.     @Bean
  100.     public MappingJackson2HttpMessageConverter messageConverter() {
  101.         MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
  102.         converter.setObjectMapper(getObjectMapper());
  103.         return converter;
  104.     }
  105.     @Bean
  106.     public ObjectMapper getObjectMapper() {
  107.         return new ObjectMapper();
  108.     }
  109.  
  110.  
  111.     /**
  112.      *  格式化返回的内容（格式转换器）
  113.      *  https://my.oschina.net/u/3681868/blog/3075150
  114.      * */
  115.     @Override
  116.     public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
  117.         MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
  118.         ObjectMapper objectMapper = converter.getObjectMapper();
  119.         // 生成JSON时,将所有Long转换成String
  120.         //SimpleModule simpleModule = new SimpleModule();
  121.         //simpleModule.addSerializer(Long.class, ToStringSerializer.instance);
  122.         //simpleModule.addSerializer(Long.TYPE, ToStringSerializer.instance);
  123.         //objectMapper.registerModule(simpleModule);
  124.         // 时间格式化
  125.         objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
  126.         objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
  127.         // 设置格式化内容
  128.         converter.setObjectMapper(objectMapper);
  129.         converters.add(0, converter);
  130.     }
  131.  
  132.     /**
  133.      * 解析器，该方法可实现可不实现，需要自定义。作用在调用Controller方法的参数传入之前，有返回值
  134.      */
  135.     @Override
  136.     public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
  137.         // userArgumentResolver该类对Controller传入的参数做了具体处理
  138.         resolvers.add(userArgumentResolver);
  139.     }
  140.  
  141.  
  142. }
  143.

1、解析器

（1）自定义解析器

  1. @Configuration
  2. public class UserArgumentResolver implements HandlerMethodArgumentResolver {
  3.  
  4.     @Autowired
  5.     Userservice userservice;
  6.  
  7.     // 此方法返回true，下面的参数才会执行
  8.     @Override
  9.     public boolean supportsParameter(MethodParameter methodParameter) {
  10.         // 获取传入参数的类型
  11.         Class<?> type = methodParameter.getParameterType();
  12.         // 如果参数类型有为User类的则符合,进入resolveArgument方法
  13.         if (UserPojo.class == type) {
  14.             return true;
  15.         }
  16.         return false;
  17.     }
  18.  
  19.     // 该方法为拦截方法，将结果返回给controller
  20.     @Override
  21.     public Object resolveArgument(MethodParameter methodParameter,
  22.                                   ModelAndViewContainer modelAndViewContainer,
  23.                                   NativeWebRequest nativeWebRequest,
  24.                                   WebDataBinderFactory webDataBinderFactory) throws Exception {
  25.  
  26.         HttpServletRequest request = nativeWebRequest.getNativeRequest(HttpServletRequest.class);
  27.         HttpServletResponse response = nativeWebRequest.getNativeResponse(HttpServletResponse.class);
  28.         
  29.         String userTick = CookieUtil.getCookieValue(request, "userTicket");
  30.         if (StringUtils.isBlank(userTick)) {
  31.             return null;
  32.         }
  33.         UserPojo userPojo = userservice.getUserByCookie(userTick, request, response);
  34.         if (userPojo == null) {
  35.             return null;
  36.         }
  37.         return userPojo;
  38.     }
  39. }

（2）在controller中使用

  1. @GetMapping("goods")
  2. public Result showGoods(UserPojo user){
  3.     // 注意：这里的User参数不是由前端传入的，而是由addArgumentResolvers方法处理之后传进来的
  4.     log.info(user.toString());
  5.     // 根据处理之后传入的参数判断是否登录
  6.     if (user == null)
  7.         return Result.error();
  8.     return Result.ok();
  9. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Monodyee/article/detail/576393
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号