如何在Springboot实现拦截器功能

Natalia ·

更新时间:2024-11-10

· 1613 次阅读

preHandle: 预先处理,在目标的controller方法执行之前,进行处理

postHandle: 在目标的controller方法执行之后,到达指定页面之前进行处理

afterCompletion: 在页面渲染之后进行处理

方法:

1.Springboot通过实现HandlerInterceptor接口实现拦截器

2.通过WebMvcConfigurer实现一个配置类,再通过@Configuration 注解注入到容器

3.指定拦截规则

以用户登录为案例,若用户没有登录session里面就没有用户的数据,就会转到首页登录页面

在正确登录之后，就将reglister保存到session中，再次访问页面的时候，登录拦截器就可以找到这个reglister对象，就不需要再次拦截到登录界面了.

package com.zwz.springbootweb.interceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.websocket.Session;
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession();
        Object reglister = session.getAttribute("Reglister");
        if (reglister != null) {
            return true;
        } else {
            request.setAttribute("msg", "请先登录!");
            request.getRequestDispatcher("/").forward(request,response);
            return false;
        }
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

之后通过实现WebMvcConfigurer接口实现一个配置类，在配置类中注入拦截器，最后再通过 @Configuration 注解注入配置.并且指定拦截的路径和需要放行的路径.

注意:拦截器 /** 会拦截一切资源,包括静态资源,需要将静态资源放行

package com.zwz.springbootweb.config;
import com.zwz.springbootweb.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.util.UrlPathHelper;
@Configuration
public class WebConfig implements WebMvcConfigurer{
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**").excludePathPatterns("/loginjudge","/","/retolo","/static/**");
    }
}

拦截器的应用场景

1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page VIEW）等。

2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；

3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

5、OpenSessionInView：如Hibernate，在进入处理器打开SESSION，在完成后关闭SESSION。

拦截器与过滤器的区别

1、拦截器是基于Java的反射机制的，而过滤器是基于函数回调。

2、拦截器不依赖与servlet容器，过滤器依赖与servlet容器。

3、拦截器只能对ACTION请求起作用，而过滤器则可以对几乎所有的请求起作用。

4、拦截器可以访问ACTION上下文、值栈里的对象，而过滤器不能访问。

5、在ACTION的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。