在SpringBoot項目中添加SpringMVC攔截器

1、認識攔截器

　　SpringMVC的攔截器（Interceptor）不是Filer，同樣可以實現請求的預處理、后處理。使用攔截器僅需要兩個步驟

　　實現攔截器

　　注冊攔截器

1.1實現攔截器

　　實現攔截器可以自定義實現HandleInterceptor接口，也可以繼承HandleInterceptorAdatper類，后者是前者的實現類。

　　下面是攔截器實現的一個例子，目的是判斷用戶是否登錄。如果preHandle方法return true ，則后續方法繼續執行。

 

package zsjmsdemo.interceptor;

import java.io.PrintWriter;
import java.util.Set;
import java.util.concurrent.TimeUnit;

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

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.util.ObjectUtils;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.alibaba.fastjson.JSON;
import com.ezhiyang.xxxb.common.DataResult;
import com.ezhiyang.xxxb.utils.MobileUtil;

public class LoginInterceptor extends HandlerInterceptorAdapter {
    
    private RedisTemplate<String, Object> redisTemplate;

    /**
     * 預處理回調方法，實現處理器的預處理(如登陸檢查/判斷同一對象短時間內是否重復調用接口等) 第三個參數為相應的處理器即controller
     * f返回true表示流程繼續，調用下一個攔截器或者處理器，返回false表示流程中斷，通過response產生響應
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        String token = getToken(request);
        if (!ObjectUtils.isEmpty(token)) {
            //判斷同一用戶短時間內是否重復請求接口
            String method = request.getMethod();
            if (method!=null&&("POST".equalsIgnoreCase(method)||"GET".equalsIgnoreCase(method))) {
                String requestUri = request.getRequestURI();
                String url = requestUri.substring(request.getContextPath().length());//獲取此次請求訪問的是哪個接口
                String ip=MobileUtil.getIpAddr(request);//獲取當前的ip地址值
                String requestKey=ip+"_"+token+"_"+url;
                Object object = redisTemplate.opsForValue().get("requestKey");
                //若重復請求則提示
                if (!ObjectUtils.isEmpty(object)) {
                    DataResult dataResult=new DataResult();
                    dataResult.setCode("4001");
                    dataResult.setMsg("請求太頻繁，請稍后再試");
                    response.setCharacterEncoding("utf-8");
                    response.setContentType("text/html; charset=utf-8");
                    PrintWriter writer=response.getWriter(); 
                    writer.print(JSON.toJSON(dataResult));
                    writer.close();
                    response.flushBuffer(); 
                    return false;
                }
                //若是第一次請求則記錄請求標記，在處理器執行完成后刪除標記
                redisTemplate.opsForValue().set(requestKey, url, 5, TimeUnit.SECONDS);//設置5秒，只是為了防止攔截器的后置處理方法沒執行到（比如突然斷電），導致后續的同類請求都不能執行
                //如果請求允許，就記住key，請求處理完后，還要刪除標識
                request.setAttribute("ACCESS_KEY", requestKey);
            }
            
            //根據token從redis中獲取登錄信息
            Set<String> keys = redisTemplate.keys(token);
            if (!ObjectUtils.isEmpty(keys) && keys.size() == 1) {
                Object nimitokenvalue = redisTemplate.opsForValue().get(keys.iterator().next());
                if (ObjectUtils.isEmpty(nimitokenvalue)) {
                    return true;
                }
            } else {
                Object loginInfo = redisTemplate.boundValueOps(token)
                        .get();
                if (loginInfo != null) {
                    return true;
                }
            }
        }else{
            response.setContentType("text/html; charset=utf-8");
            PrintWriter writer = response.getWriter();
            writer.print(new DataResult("4001", "沒登陸", new Object()));
            writer.close();
            response.flushBuffer(); 
            return false;
        }
        return super.preHandle(request, response, handler);
    }


    /**
     * 當請求進行處理之后，也就是controller方法調用之后執行，但是他會在DispatcherServlet進行視圖渲染之前被調用
     * 此時我們可以通過modelAndView對模型數據進行處理或對視圖進行處理
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("-------------------postHandle");
        String requestKey = (String)request.getAttribute("ACCESS_KEY");
        if (requestKey!=null) {
            redisTemplate.delete(requestKey);
        }
    }

    /**
     * 方法將在整個請求結束之后，也就是DispatcheServlet進行視圖渲染之后執行，這個方法的主要作用是對資源的清理工作
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("-------------------afterCompletion");
    }

    @Override
    public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
    }
    
    
    /**
     * 獲取token
     * @param req
     * @return
     */
    public static String getToken(HttpServletRequest req) {
        String token = req.getParameter("token");
        if (!ObjectUtils.isEmpty(token)) {
            return token;
        } else {
            Cookie[] cks = req.getCookies();
            if (cks != null) {
                for (Cookie ck : cks) {
                    if (ck.getName().equals("token")) {
                        return ck.getValue();
                    }
                }
            }
            return req.getHeader("token");
        }
    }

}

 

 

 

1.2注冊攔截器

package com.cxs.allmodel.interceptor;

import javax.annotation.Resource;

import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 為了使自定義的攔截器生效，需要注冊攔截器到spring容器中，具體的做法是繼承WebMvcConfigurerAdapter類，
 * 覆蓋其addInterceptors(InterceptorRegistry registry)方法。最后別忘了把Bean注冊到Spring容器中，
 * 可以選擇@Component 或者 @Configuration。
 *
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer{
    //在攔截器執行時實例化redisTemplate
    @Resource
    private RedisTemplate<String, Object> redisTemplate;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注冊攔截器
        InterceptorRegistration ir = registry.addInterceptor(new LoginInterceptor(redisTemplate));
        // 配置攔截的路徑
        ir.addPathPatterns("/**");
        // 配置不攔截的路徑
        ir.excludePathPatterns("/user/info","/user/add");

        // 還可以在這里注冊其它的攔截器
        //registry.addInterceptor(new OtherInterceptor()).addPathPatterns("/**");
    }
}

 

 

　也可以直接在SpringBoot的啟動類中繼承WebMvcConfigurerAdaoter類

package cn.wowkai.mall;

import java.nio.charset.Charset;
import java.util.Arrays;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import javax.sql.DataSource;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import org.springframework.http.HttpHeaders;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.fd.myshardingfordata.helper.ConnectionManager;
import com.fd.myshardingfordata.helper.TransManager;

import cn.wowkai.mall.web.interceptor.AuthInterceptor;

@EnableScheduling
@SpringBootApplication
public class ShopSaasMallApplication implements WebMvcConfigurer {

    public static void main(String[] args) {
        SpringApplication.run(ShopSaasMallApplication.class, args);
    }

    @Resource
    protected RedisTemplate<String, Object> redisTemplate;

    @PostConstruct
    private void init() {
        redisTemplate.setKeySerializer(new StringRedisSerializer(Charset.forName("UTF8")));
        redisTemplate.setValueSerializer(new StringRedisSerializer(Charset.forName("UTF8")));
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthInterceptor(redisTemplate)).excludePathPatterns("/mall/mp/*",
                "/mall/notify/panganNotify", "/mall/notify/panganRechargeNotify", "/mall/notify/panganbillNotify",
                "/mall/notify/wxpayrechargenotify", "/mall/notify/wxpaybillnotify", "/mall/notify/wxpaynotify",
                "/mall/api/getToken", "/mall/store/getStoreListWithLongitudeLatitude",
                "/mall/sett/getIndexTemplateListWithXcx", "/mall/product/productListForXcxSelect",
                "/mall/product/custFindProduct", "/mall/product/custFindProductSpeceInventoryAndPrice",
                "/mall/sett/xcx/getIndexTemplateMastList");
    }

    @Resource
    private DataSource dataSource;

    @Bean
    public TransManager transManager() {
        TransManager trans = new TransManager();
        trans.setConnectionManager(connectionManager());
        return trans;
    }

    @Bean
    public ConnectionManager connectionManager() {
        ConnectionManager conm = new ConnectionManager();
        conm.setGenerateDdl(true);
        conm.setShowSql(false);
        conm.setInitConnect("set  names  utf8mb4");
        conm.setDataSource(dataSource);
        conm.setReadDataSources(Arrays.asList(dataSource));

        return conm;
    }

    @Bean
    public CorsFilter corsFilter() {
        // 1.添加CORS配置信息
        CorsConfiguration config = new CorsConfiguration();
        // 放行哪些原始域
        config.addAllowedOrigin("*");
        // 是否發送Cookie信息
        config.setAllowCredentials(true);
        // 放行哪些原始域(請求方式)
        config.addAllowedMethod("*");
        // 放行哪些原始域(頭部信息)
        config.addAllowedHeader("*");
        // 暴露哪些頭部信息（因為跨域訪問默認不能獲取全部頭部信息）
        config.addExposedHeader(HttpHeaders.LOCATION);
        config.setExposedHeaders(Arrays.asList("JSESSIONID", "SESSION", "token", HttpHeaders.LOCATION,
                HttpHeaders.ACCEPT, HttpHeaders.ACCESS_CONTROL_ALLOW_HEADERS, HttpHeaders.ACCESS_CONTROL_EXPOSE_HEADERS,
                HttpHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, HttpHeaders.COOKIE, HttpHeaders.SET_COOKIE,
                HttpHeaders.SET_COOKIE2));
        // 2.添加映射路徑
        UrlBasedCorsConfigurationSource configSource = new UrlBasedCorsConfigurationSource();
        configSource.registerCorsConfiguration("/**", config);

        // 3.返回新的CorsFilter.
        return new CorsFilter(configSource);
    }

}

 

 

1.3攔截器的應用場景

　　攔截器的本質是面向切面編程（AOP），符合橫切關注點的功能都可以放在攔截器中來實現，主要的應用場景包括：

　　1、登錄驗證，判斷用戶是否登錄。

　　2、權限驗證，判斷用戶是否具有訪問權限。

　　3、日志記錄，記錄請求日志，以便統計請求訪問量。

　　4、處理cookie、本地化、國際化、主題等。

　　5、性能監控，監控請求處理時長等。

　　6、防止同一用戶在短時間內重復請求接口

 

2、原理

2.1、工作原理

　　攔截器不是Filter，卻實現了filter的功能，其原理在於:

　　所有的攔截器（Interceptor）和處理器（Handler）都注冊在HandlerMapping中。

　　Spring MVC中所有的請求都是由DispatcherServlet分發的。

　　當請求進入 DispatcherServlet.doDispatch()時候，首先會得到處理該請求的Handler（即Controller中對應的方法）以及所有攔截該請求的攔截器。攔截器就是在這里被調用開始工作的。

 

2.2、攔截器工作流程

　　一個攔截器，只有preHandle方法返回true，postHandle、afterCompletion才有可能被執行；如果preHandle方法返回false，則該攔截器的postHandle、afterCompletion必然不會被執行。

假設我們有兩個攔截器，例如叫Interceptor1和Interceptor2，當一個請求過來，正常的流程和中斷的流程分別如下。

 

2.2.1正常流程

　　注意兩個攔截器在執行preHandle方法和執行postHandle、afterCompletion方法時，順序是顛倒的。

Interceptor1.preHandle

Interceptor2.preHandle

//Controller處理請求

Interceptor2.postHandle

Interceptor1.postHandle

//渲染視圖

 Interceptor2.afterCompletion

 Interceptor1.afterCompletion

2.2.2中斷流程

　　假設執行 Interceptor2.preHandle中報錯，那么流程被中斷，之前被執行過的攔截器的afterCompletion仍然會執行。在本例中，即執行了 Interceptor1.afterCompletion。

Interceptor1.preHandle

Interceptor2.preHandle

//中間流程被中斷，不再執行

Interceptor1.afterCompletion

2.3和Filter共存時的執行順序

　　攔截器是在DispatcherServlet這個servlet中執行的，因此所有的請求最先進入Filter，最后離開Filter。其順序如下。

Filter

Interceptor.preHandle

Handler

Interceptor.postHandle

Interceptor.afterCompletion

Filter

 

 

原文鏈接： https://www.jianshu.com/p/51c5193b5883