java拦截器 (含自定义注解)

目录索引： 1. 拦截器介绍、对比

　　　　　 2. 实例1（登录拦截）

　　　　    3. 实例2（拦截 想调用 贴了某个自定义注解 的方法）

java三大利器：过滤器、监听器、拦截器

Springboot 拦截器配置（登录拦截）：

第一步：编写拦截器实现类，实现接口   HandlerInterceptor，

重写里面需要的三个比较常用的方法，实现自己的业务逻辑代码

(就是自己拦截器拦截时做什么处理)

package com.*.*.interceptor;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.*.*.*.User;

/**
 * 
 * 
 * @Package: com.*.*.interceptor 
 * @ClassName: AdminInterceptor 
 * @Description:拦截器
 * @author: zk
 * @date: 2019年9月19日 下午2:20:57
 */
public class AdminInterceptor implements  HandlerInterceptor {

    /**
     * 在请求处理之前进行调用（Controller方法调用之前）
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
//        System.out.println("执行了TestInterceptor的preHandle方法");
        try {
            //统一拦截（查询当前session是否存在user）(这里user会在每次登陆成功后，写入session)
            User user=(User)request.getSession().getAttribute("USER");
            if(user!=null){
                return true;
            }
            response.sendRedirect(request.getContextPath()+"你的登陆页地址");
        } catch (IOException e) {
            e.printStackTrace();
        }
        return false;//如果设置为false时，被请求时，拦截器执行到此处将不会继续操作
                      //如果设置为true时，请求将会继续执行后面的操作
    }
 
    /**
     * 请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
//         System.out.println("执行了TestInterceptor的postHandle方法");
    }
 
    /**
     * 在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
//        System.out.println("执行了TestInterceptor的afterCompletion方法");
    }
    
}

第二步：编写拦截器配置文件类 继承WebMvcConfigurer类，并重写其中的方法 （诺淇云 基本一样）

package com.*.*.config;

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

import com.*.*.interceptor.AdminInterceptor;

/**
 * 
 * 
 * @Package: com.*.*.config 
 * @ClassName: LoginConfig 
 * @Description:拦截器配置
 * @author: zk
 * @date: 2019年9月19日 下午2:18:35
 */
@Configuration
public class LoginConfig implements WebMvcConfigurer {
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注册TestInterceptor拦截器
        InterceptorRegistration registration = registry.addInterceptor(new AdminInterceptor());
        registration.addPathPatterns("/**");                      //所有路径都被拦截
        registration.excludePathPatterns(                         //添加不拦截路径
                                         "你的登陆路径",            //登录
                                         "/**/*.html",            //html静态资源
                                         "/**/*.js",              //js静态资源
                                         "/**/*.css",             //css静态资源
                                         "/**/*.woff",
                                         "/**/*.ttf"
                                         );    
    }
}

这里不被拦截的路径，根据自己需求进行添加，上述主要是关于静态资源方面的

到这里后端拦截已经完成。我的项目是前后端分离的，前端使用的LayuiAdmin,借助了LayuiAdmin的前端拦截器进行相关html页面的拦截

实例2（拦截 想调用 贴了某个自定义注解 的方法）：

  1. 网络例子：

 1 public class AnnotationInterceptor implements HandlerInterceptor {
 2     @Override
 3     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 4         HandlerMethod method= (HandlerMethod) handler;//获取 调用方法
 5         AnnotationTest methodAnnotation = method.getMethodAnnotation(AnnotationTest.class);//获取这个方法上的注解，使用这个可得到传入注解的参数
 6         boolean hasMethodAnnotation = method.hasMethodAnnotation(AnnotationTest.class);//判断 调用的方法 有没有使用指定的注解,有返回true
 7         if(hasMethodAnnotation){ //如果包含指定注解，可以进行判断是否登录，是否有权限等等验证、限流操作
　　　　　　　　    return false; //调用发法不执行
 9         }
10         return true;//返回true，调用方法执行
11     }
12 }

 2. 诺淇* 使用案例：

@Component
@AllArgsConstructor
public class CheckLoginIntercepter implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String userId = SecurityHelper.getCurrentUser().getUserId();
        if(handler instanceof org.springframework.web.method.HandlerMethod){  // 判断下 避免跨域调用 会报错
            org.springframework.web.method.HandlerMethod method = (HandlerMethod) handler;
            if(PublicUtils.isEmpty(userId) && method.hasMethodAnnotation(RequireLogin.class)){ //判断 调用的方法 有没有使用这个指定的注解，有返回true
                response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
                return false;
            }
        }
        return true;
    }
}