拦截器HandlerInterceptorAdapter使用方法,以及通过WebMvcConfigurer注册拦截器

一、Interceptor定义:
拦截器是在面向切面编程中应用的,就是在你的service或者一个方法前调用一个方法,或者在方法后调用一个方法。是基于JAVA的反射机制(在一个服务中定义的话,它会对所有请求进行拦截)

1.拦截器(Interceptor)执行顺序:
1. 请求到达 DispatcherServlet
2. DispatcherServlet 发送至 Interceptor ,执行 preHandle
3. 请求达到 Controller
4. 请求结束后,postHandle 执行

2.拦截器(Interceptor)和过滤器(Filter)的执行顺序
过滤前->拦截前->Action处理->拦截后->过滤后

 3.使用方法
1)预处理preHandle()方法

用户发送请求时,先执行preHandle()方法。会先按照顺序执行所有拦截器的preHandle方法,一直遇到return false为止,比如第二个preHandle方法是return false,则第三个以及以后所有拦截器都不会执行。若都是return true,则执行用户请求的url方法。

2)后处理postHandle()方法

调用了Service并返回ModelAndView,但未进行页面渲染,可以在这里继续修改ModelAndView

3)返回处理afterCompletion()方法

已经渲染了页面,在afterCompletion中,可以根据ex是否为null判断是否发生了异常,进行日志记录。

注:一般使用preHandle这个拦截器进行预处理,对url进行请求拦截
使用demo:

package sca.pro.system.common.request;

import cn.hutool.core.net.URLDecoder;
import cn.hutool.json.JSONUtil;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import sca.pro.common.contants.Contants;
import sca.pro.common.jwt.MapInfo;
import sca.pro.common.response.HttpCode;
import sca.pro.common.response.HttpResult;
import sca.pro.system.common.util.ServletUtils;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Method;

/**
 * @author shq
 * @description Request拦截器
 * @createDate 2022-5-27
 * @updateUser
 * @updateDate
 * @updateRemark
 */
public class RequestContextInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (!(handler instanceof HandlerMethod)) {
            return true;
        }
        Method method = ((HandlerMethod) handler).getMethod();
        if (!method.isAnnotationPresent(AuthInfoRequired.class)) {
            return true;
        }
        AuthInfoRequired annotation = method.getAnnotation(AuthInfoRequired.class);
        if (!annotation.required()) {
            return true;
        }
        if (initHeaderContext(request)) {
            return super.preHandle(request, response, handler);
        } else {
            returnJson(response, JSONUtil.toJsonStr(new HttpResult().builder()
                    .code(HttpCode.UNAUTHORIZED).build()));
            return false;
        }
    }

    private boolean initHeaderContext(HttpServletRequest request) {
        String mapInfoStr = ServletUtils.URLDecoderString(request.getHeader(Contants.JWT_MAP_KEY));
        if (mapInfoStr != null) {
            try {
                MapInfo mapInfo = JSONUtil.toBean(mapInfoStr, MapInfo.class);
                new RequestContext.RequestContextBuild()
                        .mapInfo(mapInfo)
                        .bulid();
                if (mapInfo.getUsername() == null) {
                    return false;
                }
                return true;
            } catch (Exception e) {
                return false;
            }
        } else {
            return false;
        }
    }

    private void returnJson(HttpServletResponse response, String json) throws Exception {
        PrintWriter writer = null;
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html; charset=utf-8");
        try {
            writer = response.getWriter();
            writer.print(json);
        } catch (IOException e) {
        } finally {
            if (writer != null)
                writer.close();
        }
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        RequestContext.clean();
        super.postHandle(request, response, handler, modelAndView);
    }
}

二,WebMvcConfigurer注册拦截器(WebMvcConfigurer不仅可以配置拦截器,还可以配置过滤器,跨域访问,请求参数格式化,以及请求转发等)

@Configuration
public class MvcConfigurer implements WebMvcConfigurer {

    //拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //将加一个拦截器,检查会话,所有的请求都经过此拦截器
        registry.addInterceptor(new MyLoginInterceptor()).addPathPatterns("/**");
    }
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
HandlerInterceptorAdapter是Spring框架提供的一个适配器类,用于简化自定义拦截器的实现。它实现了HandlerInterceptor接口,并提供了一些默认的空实现方法,方便我们只关注需要实现的方法HandlerInterceptor是Spring框架提供的拦截器接口,用于在请求处理过程中进行拦截和处理。通过实现HandlerInterceptor接口,我们可以在请求到达Controller之前、Controller处理过程中以及Controller返回响应之后执行一些自定义的逻辑。 使用HandlerInterceptorAdapterHandlerInterceptor的步骤如下: 1. 创建一个类并实现HandlerInterceptor接口,或者继承HandlerInterceptorAdapter类。 2. 实现需要的方法,常用的方法包括preHandle、postHandle和afterCompletion。 - preHandle方法在请求到达Controller之前执行,可以进行一些前置处理,如权限验证、日志记录等。 - postHandle方法在Controller处理完请求后执行,可以对返回结果进行处理或修改。 - afterCompletion方法在整个请求完成后执行,可以进行一些清理工作,如资源释放等。 3. 在Spring配置文件中配置拦截器。 - 如果使用HandlerInterceptorAdapter,可以通过继承WebMvcConfigurerAdapter类并重写addInterceptors方法来添加拦截器。 - 如果使用HandlerInterceptor,可以通过实现WebMvcConfigurer接口并重写addInterceptors方法来添加拦截器。 注意:在配置拦截器时,需要注意拦截器的顺序,以及拦截的路径和排除的路径的配置。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

EntyIU

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

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

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

打赏作者

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

抵扣说明:

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

余额充值