springboot 自定义注解拦截器

springboot 自定义注解拦截器

最近在工作中，发现自定义注解拦截使用起来特别方便，现在来写出来给大家看看

环境springboot

1. 首先写一个自定义注解

package com.study.cdmy.common;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Author 程达
 * @Description 在需要登录验证的Controller的方法上使用此注解
 * @Param
 * @Date  2019/4/9 11:29
 */
@Target(ElementType.METHOD)// 可用在方法名上
@Retention(RetentionPolicy.RUNTIME)// 运行时有效
public @interface AccessRequired {
}

2. 创建拦截器

package com.study.cdmy.interceptor;

import com.study.cdmy.common.AccessRequired;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

/**
 * @Author 程达
 * @Description 登录拦截
 * @Param
 * @Date  2019/4/9 11:46
 */
@Component
public class LoginInterceptor extends  HandlerInterceptorAdapter {

    private Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 如果不是映射到方法直接通过
        if (!(handler instanceof HandlerMethod)) {
            return true;
        }
        // ①:START 方法注解级拦截器
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();
        // 判断接口是否需要登录
        AccessRequired methodAnnotation = method.getAnnotation(AccessRequired.class);
        // 有 @LoginRequired 注解，需要认证
        if (methodAnnotation != null) {
            // 这写你拦截需要干的事儿，比如取缓存，SESSION，权限判断等
            logger.info("该方法需要登录，请登录");
            return false;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

    }
}

3.将拦截器添加到配置中，相当于spring-mvc.xml里的配置文件

package com.study.cdmy.config;

import com.study.cdmy.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 多个拦截器组成一个拦截器链
        // addPathPatterns 用于添加拦截规则
        // excludePathPatterns 用户排除拦截
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**");
        super.addInterceptors(registry);
    }
}

4. 创建一个controller类来测试

package com.study.cdmy.controller;

import com.study.cdmy.common.AccessRequired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author 程达
 * @Description 测试controller
 * @Param
 * @Date  2019/4/9 11:38
 */
@RestController
@RequestMapping(value = "test")
public class TestController {


    /**
     * 加了拦截登录
     * @return
     */
    @AccessRequired
    @RequestMapping("/login")
    public String login(){
        return "success";
    }

    /**
     * 没有加拦截登录
     * @return
     */
    @RequestMapping("/login1")
    public String login1(){
        return "success1";
    }

}

5. 启动程序来测试

访问http://localhost:8080/test/login，log打印需要登录

访问http://localhost:8080/test/login1，直接返回数据

以上就是创建springboot自定义注解拦截器的全过程
码云源码–请看分支（自定义注解拦截器）