《Spring篇》---WebMvcConfigurer

最新推荐文章于 2023-07-08 21:49:07 发布
最新推荐文章于 2023-07-08 21:49:07 发布
阅读量2.4k 收藏 3
点赞数 1
分类专栏： 个人笔记 文章标签： java 开发语言 后端 spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/CSDN_zcy_my/article/details/121508734
版权

Spring---WebMvcConfigurer

简介

WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，ViewResolver，MessageConverter。基于java-based方式的spring mvc配置，需要创建一个配置类并实现WebMvcConfigurer 接口

WebMvcConfigurer 配合HandlerInterceptor 拦截器配置校验服务

Spring拦截器分类

spring中拦截器主要分两种，一个是HandlerInterceptor，一个是MethodInterceptor。

HandlerInterceptor

HandlerInterceptor是springMVC项目中的拦截器，它拦截的目标是请求的地址，比MethodInterceptor先执行。

HandlerInterceptor拦截的是请求地址，所以针对请求地址做一些验证、预处理等操作比较合适。当你需要统计请求的响应时间时MethodInterceptor将不太容易做到，因为它可能跨越很多方法或者只涉及到已经定义好的方法中一部分代码。

实现一个HandlerInterceptor拦截器可以直接实现HandlerInterceptor接口，也可以继承HandlerInterceptorAdapter类。

看下UML:
拦截器继承关系和主要方法

public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {
    public HandlerInterceptorAdapter() {
    }
　　 //在业务处理器处理请求之前被调用
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
　　//在业务处理器处理请求完成之后，生成视图之前执行  
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }
　　 // 在DispatcherServlet完全处理完请求之后被调用，可用于清理资源  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }

    public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    }
}

执行顺序如下：
在这里插入图片描述

例子

public class SecurityConfig implements WebMvcConfigurer {

    @Bean
    public SecurityInterceptor securityInterceptor() {
        return new SecurityInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(securityInterceptor()).addPathPatterns("/**").excludePathPatterns("/js/**", "/css/**","/images/**");
    }

}

@Order(0)
public class SecurityInterceptor implements AsyncHandlerInterceptor {

    private static final Logger log = LoggerFactory.getLogger(SecurityInterceptor.class);

    @Autowired
    private TblResourceService resourceService;

    @Autowired
    private CustomConfig customConfig;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        String requestURI = request.getRequestURI();
        Map<String, List<ResourceUrlVO>> allResourceUrls = resourceService.getAllResourceUrls();
        if (allResourceUrls == null)
        {
            errorPrint(response, request, requestURI, InfoCodeEnum.ERROR_CODE.getCode(), "没有配置任何接口！");
            return false;
        }

        if (MapUtil.isEmpty(allResourceUrls)) {
            for (int i=0; i<5; i++)
            {
                allResourceUrls = resourceService.getAllResourceUrls();
                if (!MapUtil.isEmpty(allResourceUrls))
                {
                    break;
                }

                if (i == 5)
                {
                    errorPrint(response, request, requestURI, InfoCodeEnum.ERROR_CODE.getCode(), "请求地址非法！");
                    return false;
                }
            }
        }

        List<ResourceUrlVO> resourceUrlVOS = allResourceUrls.get(requestURI);
        if (CollUtil.isEmpty(resourceUrlVOS)) {
            for (int i=0; i<5; i++)
            {
                resourceUrlVOS = allResourceUrls.get(requestURI);
                if (!CollUtil.isEmpty(resourceUrlVOS))
                {
                    break;
                }

                if (i == 5)
                {
                    errorPrint(response, request, requestURI, "999888", "请求地址非法！");
                    return false;
                }
            }
        }
        if(resourceUrlVOS==null){
            errorPrint(response, request, requestURI, "999000", "请求地址非法！");
            return false;
        }
        List<String> resourceIds = resourceUrlVOS.stream().map(urlVO -> urlVO.getResourceId() + "").collect(Collectors.toList());

        String cookieValue = CookieUtil.getCookieValue(request, customConfig.getCookieName());
        boolean present = resourceIds.stream().anyMatch(id -> !id.equals("-1"));
        // 不存在说明只含有免登录的Url，直接放行
        if (!present) {
            if (StrUtil.isNotBlank(cookieValue)) {
                Claims claims = JwtUtil.verifyJWT(cookieValue);
                Object userIdStr;
                if (claims != null && (userIdStr = claims.get(LoginParamsEnum.USERID.getName())) != null) {
                    request.setAttribute(LoginParamsEnum.USERID.getName(), Long.parseLong(userIdStr.toString()));
                    request.setAttribute(LoginParamsEnum.NICK_NAME.getName(), claims.get(LoginParamsEnum.NICK_NAME.getName()));
                }
            }
            return true;
        }
        boolean match = resourceIds.stream().anyMatch(id -> !id.equals("0"));
        // 不存在说明只含有只需要登录的Url，直接校验token是否存在，存在就放行
        if (!match) {
            if (StrUtil.isBlank(cookieValue)) {
                errorPrint(response, request, requestURI, InfoCodeEnum.NOT_LOGIN_CODE.getCode(), "登录失效，请重新登录！");
                return false;
            }
            Claims claims = JwtUtil.verifyJWT(cookieValue);
            Object userIdStr;
            if (claims != null && (userIdStr = claims.get(LoginParamsEnum.USERID.getName())) != null) {
                request.setAttribute(LoginParamsEnum.USERID.getName(), Long.parseLong(userIdStr.toString()));
                request.setAttribute(LoginParamsEnum.NICK_NAME.getName(), claims.get(LoginParamsEnum.NICK_NAME.getName()));
            }
            return true;
        }
        // 需要有对应权限才允许放行
        if (StrUtil.isBlank(cookieValue)) {
            errorPrint(response, request, requestURI, InfoCodeEnum.NOT_LOGIN_CODE.getCode(), "登录失效，请重新登录！");
            return false;
        }
        // 已登录
        // 超管需要直接放行
        Claims claims = JwtUtil.verifyJWT(cookieValue);
        Object userIdObj;
        if (claims == null || (userIdObj = claims.get(LoginParamsEnum.USERID.getName())) == null) {
            errorPrint(response, request, requestURI, InfoCodeEnum.NOT_LOGIN_CODE.getCode(), "登录失效，请重新登录！");
            return false;
        }
        Long userId = Long.parseLong(userIdObj.toString());
        List<TblRole> allRoles = resourceService.getAllRoles(userId);
        boolean adminMatch = allRoles.stream().anyMatch(role -> role.getFlag().equals(1L));
        if (adminMatch) {
            Object userIdStr;
            if (claims != null && (userIdStr = claims.get(LoginParamsEnum.USERID.getName())) != null) {
                request.setAttribute(LoginParamsEnum.USERID.getName(), Long.parseLong(userIdStr.toString()));
                request.setAttribute(LoginParamsEnum.NICK_NAME.getName(), claims.get(LoginParamsEnum.NICK_NAME.getName()));
            }
            return true;
        }
        // 判断用户资源是否包含当前对应的resourceId
        List<TblResource> allResources = resourceService.getAllResources(userId);
        boolean anyMatch = allResources.stream().anyMatch(resource -> resourceIds.contains(resource.getId().toString()));
        if (anyMatch) {
            Object userIdStr;
            if (claims != null && (userIdStr = claims.get(LoginParamsEnum.USERID.getName())) != null) {
                request.setAttribute(LoginParamsEnum.USERID.getName(), Long.parseLong(userIdStr.toString()));
                request.setAttribute(LoginParamsEnum.NICK_NAME.getName(), claims.get(LoginParamsEnum.NICK_NAME.getName()));
            }
            return true;
        }
        errorPrint(response, request, requestURI, null, "当前用户权限不足！");
        return false;
    }

    private void errorPrint(HttpServletResponse response, HttpServletRequest request, String location, String code,
                            String message) {
        PrintWriter out = null;
        try {
            // response.reset(); 注释掉此代码才可以清空掉Cookies信息
            response.setCharacterEncoding("UTF-8");
            response.setContentType("application/json;charset=utf-8");
            out = response.getWriter();
            log.error("user-agent:" + request.getHeader("user-agent"));
            log.error("身份验证失败的位置：" + location);
            out.print(JSONObject.toJSONString(ActionResult.getErrorResult(code, message)));
            log.error("错误信息: {}", JSONObject.toJSONString(ActionResult.getErrorResult(code, message)));
        } catch (Exception ex) {
            log.error("返回写入异常", ex);
            if (out != null) {
                out.close();
            }
        }
    }

简单描述@Order()注解

注解@Order或者接口Ordered的作用是定义Spring IOC容器中Bean的执行顺序的优先级，而不是定义Bean的加载顺序，Bean的加载顺序不受@Order或Ordered接口的影响；

@Order的注解源码解读

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Documented
public @interface Order {
 
    /**
     * 默认是最低优先级,值越小优先级越高
     */
    int value() default Ordered.LOWEST_PRECEDENCE;
 
}

注解可以作用在类(接口、枚举)、方法、字段声明（包括枚举常量）；
注解有一个int类型的参数，可以不传，默认是最低优先级；
通过常量类的值我们可以推测参数值越小优先级越高

Ordered接口类

package org.springframework.core;
 
public interface Ordered {
    int HIGHEST_PRECEDENCE = -2147483648;
    int LOWEST_PRECEDENCE = 2147483647;
 
    int getOrder();
}

结论

1、如果多个拦截器，执行顺序：preHandle() :123 ,postHandle():321,afterCompletion():321

2、preHandle() 返回false，不会往下执行

3、preHandle()返回true的拦截器，必然会执行他的afterCompletion()；

4、如果preHandle()都返回true，有一个拦截器的postHandle()抛出异常，则后面拦截器的postHandle()不会执行。（注意：写代码时要注意）

总结

参考相关链接：
WebMvcConfigurer讲解
相关例子参考
@Order注解详解

CSDN_zcy_my
关注
  • 1
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
WebMvcConfigurer
weixin_47414034的博客
10-27 1033
我们常常会创建一个config包 ，在这个包里面新建一个MyMvcConfig类，这个类实现WebMvcConfigurer接口，并且重写这个接口里面的方法。常用来实现效果：用户想访问一个页面，先检查用户是否已经登录，如果没有登陆，就会提示你还没有登录，需要先登录，并返回登陆页面。
WebMvcConfigurer接口的常见方法及其用途
最新发布
hjvvlkn的博客
06-21 441
在讨论接口的每个方法时，我们将通过具体的案例来展示如何实现它们，并分析这些配置对spring mvc应用程序的影响。
Java系列 - WebMvcConfigurer详解
ifredom
05-17 2863
WebMvcConfigurer接口常用的方法： /* 拦截器配置 */ void addInterceptors(InterceptorRegistry var1); /* 视图跳转控制器 */ void addViewControllers(ViewControllerRegistry registry); /** *静态资源处理 **/ void addResourceHandlers(ResourceHandlerRegistry registry); /* 默认静态资源处理器 */ void
SpringBoot狂神08-(实现WebMvcConfigurer扩展配置)
Java后端技术栈
07-29 2285
官网阅读 在进行项目编写前，我们还需要知道一个东西，就是SpringBoot对我们的SpringMVC还做了哪些配置，包括如何扩展，如何定制。 只有把这些都搞清楚了，我们在之后使用才会更加得心应手。途径一：源码分析，途径二：官方文档！ 地址 ：https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/#boot-features-spring-mvc-auto-configuration
关于SpringMVC中的几个配置类WebMvcConfigurer 、WebMvcConfigurationSupport 、WebMvcConfigurerAdapter
这是我的笔记本，记录学习历程，分享学习经验，菜鸡一枚，感谢支持！
07-08 2088
在学习SSM时，对SpringMVC做自定义配置时，接触到了WebMvcConfigurer 、WebMvcConfigurationSupport 、WebMvcConfigurerAdapter这几个抽象类或接口，这三个类都能对SpringMVC做出配置，至于这三者之间的关系与区别，当时也没有在乎，现在来整理一下。首先最早的一个用来对SpringMVC做出配置的类是WebMvcConfigurerAdapter类，是一个抽象类，从Spring5.0开始已被弃用。
spring-boot 过滤器 filter
03-07
本篇文章将深入探讨Spring Boot中的过滤器机制，以及如何创建和注册自定义过滤器。 一、Filter的基本概念 Filter是Java Servlet规范的一部分，它提供了一种机制，可以在请求到达目标Servlet或者响应离开Servlet...
spring-boot添加 拦截器
08-21
本篇文章将详细探讨如何在Spring Boot中添加和使用拦截器来实现登录拦截。 首先，我们需要了解Spring Boot中的拦截器是如何工作的。在Spring MVC框架中，拦截器是基于AOP（面向切面编程）的概念实现的。我们可以...
zwqh-Spring-Boot-2.X-master.zip
08-26
通过配置Spring Boot的`WebMvcConfigurer`或`WebApplicationInitializer`，将Swagger UI的静态资源暴露在指定的URL下。 6. **生成离线文档**： Swagger2支持生成离线文档，如HTML和Word。这通常通过Swagger的`...
house-app工程.zip
03-12
本篇文章将详细解析一个基于Spring Boot开发的“house-app”工程，该工程主要用于租房信息的管理，包括信息的增删改查、文件上传、前后端验证、异常处理、条件分页查询、跨域问题的解决以及拦截器的运用。...
springboot2-webservice
03-28
本篇文章将深入探讨如何在SpringBoot2中集成Web服务，以便更好地理解和实现基于Java的Web服务解决方案。 一、SpringBoot2概述 SpringBoot是Spring框架的一个扩展，它旨在简化Spring应用的初始搭建以及开发过程。...
实现WebMvcConfigurer就能定制我们的Mvc是如何进行的
m0_47039719的博客
03-26 1086
@EnableWebMvc为容器注入了DelegatingWebMvcConfiguration类 此类的作用主要是开启定制mvc的功能，实质就是整合了applicationConfig实现了WebMvcConfigurer后对某些功能如视图解析器的自定义实现 configuers会保存ApplicationConfig实例，原因： spring源码解析 --AutowiredAnnotationBeanPostProcessor_asLightYouAre...
SpringBoot集成kafka全面实战
热门推荐
Felix
03-28 20万+
本文是SpringBoot+Kafka的实战讲解，如果对kafka的架构原理还不了解的读者，建议先看一下《大白话kafka架构原理》、《秒懂kafka HA（高可用）》两篇文章。 一、生产者实践 普通生产者 带回调的生产者 自定义分区器 kafka事务提交 二、消费者实践 简单消费 指定topic、partition、offset消费 ...
IDEA中使用org.springframework.boot.autoconfigure.AutoConfiguration.imports没有被识别
Zhangsama1的博客
02-24 1万+
在SpringBoot2.7.x版本之后，慢慢不支持META-INF/spring.factories文件了，需要导入的自动配置类可以放在/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中，可以看下spring-boot-autoconfigure-2.7.7.jar下的这个文件。所以正确的操作是先创建META-INF目录，然后在其下面创建spring目录，然后把这个文件放进去即可。
Spring —— 拦截器（HandlerInterceptor、WebMvcConfigurer）
看了就会暴富的博客！
01-11 1086
问题 在项目开发过程中经常需要进行某些拦截：接口拦截以进行权限校验，参数校验等等。 解决 使用HandlerInterceptor定义拦截器，并把拦截器添加到WebMvcConfigurer配置器中。 HandlerInterceptor Springboot中的拦截器，里面共提供了三种方法。 方法名 作用 preHandle 在执行请求之前被调用 postHandle 在处理器处理完请求之后，渲染视图之前被调用 afterCompletion 在..
spring boot kafka 动态启动，springboot集成kafka，无法连接时，也能正常启动
qq_38653209的博客
06-17 2282
在所有卡夫卡相关的配置类上加，此注解 @Conditional(MyCondition.class) 其中MyCondition,自己实现 package com.ireal.crpas.kafkademo.test; import org.apache.kafka.clients.producer.KafkaProducer; import org.apache.kafka.clients.producer.Producer; import org.springframework.beans.
Spring Cloud OpenFeign 原理
杨宇昌的博客
04-28 1112
Spring Cloud OpenFeign
WebMvcConfigurer的介绍以及两种配置方式
damokelisijian866的博客
08-12 3399
前言 公司的“僵尸项目”（好几年没维护和升级），昨天突然诈尸，出现了一个问题，需要解决，打开代码时，发现项目中用到的WebMvcConfigurerAdapter过期，需要用WebMvcConfigurer来做替换，今天就趁着说一下关于WebMvcConfigurer的两种配置方式。 WebMvcConfigurer介绍 WebMvcConfigurer是一个接口，提供很多自定义的拦截器，例如跨域设置、类型转化器等等。可以说此接口为开发者提前想到了很多拦截层面的需求，方便开发者自由选择使用。由于Spring
controller自定义切面碰到filter和WebMvcConfigurer的执行顺序
weixin_43831204的博客
07-09 2001
filter→WebMvcConfigurer→自己的切面
"SpringCloud-Gateway 1.1：API管理与网关配置优化
SpringCloud-Gateway是一个基于Spring Cloud的网关服务，它提供了一种简单的方式来路由到不同的服务，并且还能够执行一些过滤操作。它使用了非常先进的被称为“路由”的功能。这使得它成为了一个强大的工具，能够在...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值