定義

攔截器顧名思義是攔截打到控制器的請求然后做一些個性化的定制功能比如說302重定向等等，(Interceptor)攔截器相對于(Filter)過濾器可以攔截細一些的東西比如控制請求的方法和控制器，但是控制不了請求方法中的參數。

 

使用場景

最常用的幾個場景

1. 登陸攔截器：

• 白名單
• 測試環境表單模擬登陸
• 登陸狀態攔截并302重定向login頁面

2. 國際化

3. 鑒權

 

攔截順序

方法執行順序

preHandle -> Controller -> postHandle -> afterCompletion

• postHandle：在控制器后并生成視圖前被調用，此時有機會修改ModelAndView。
• afterCompletion：(已經渲染視圖)后被執行。

 

實現一個登陸攔截器為例：（實現模擬登陸以及未登陸的重定向 以及白名單配置）

Interceptor:

@Component
public class TestLoginInterceptor extends HandlerInterceptorAdapter {
    // 登陸url用于重定向
    public static String LOGIN_URL = "/login"; 
    // 測試環境和開發環境可以模擬登陸
    private static Set<String> MOCK_ENABLE_PROFILE = Sets.newHashSet("debug", "test");

    @Value("${spring.profiles.active}")
    private String profile;

    @Resource
    private TestMemberService testMemberService;

    @Autowired
    private RedisUtil redisUtil;

    /**
     * 攔截處理
     */
    @Override
    public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) throws Exception {
        res.addHeader("Connection", "close");
        String requestUrl = req.getContextPath()+req.getServletPath();
        // 放過登錄請求和健康檢測
        if (requestUrl.startsWith("/login") || requestUrl.startsWith("/health")) {
            return true;
        }

        // 模擬登陸
        if(isNotRelease() && StringUtils.isNotEmpty(req.getHeader("x-mock-phone"))) {
            initMockSession(req, res, req.getHeader("x-mock-phone"));
        }

        // 認證身份信息
        if (null != redisUtil.get(req)) {
            // 重置身份過期時間
            redisUtil.resetExpire(req);
        }else{
            // 重定向
            String contextPath = req.getContextPath();
            res.sendRedirect(contextPath+LOGIN_URL);
            return false;
        }
        return true;
    }

    private void initMockSession(HttpServletRequest req, HttpServletResponse res, String phone) {
        Menber member = testMemberService.getUserInfo(phone);

        if (Objects.isNull(member)) {
            return;
        }

        SessionUser sessionUser = new AcceptSessionUser();
        sessionUser.setLoginName(member.getMemMobile());
        sessionUser.setUserName(member.getMemName());
        redisUtil.set(req, res, sessionUser);
    }

    // 判斷環境是否是測試或開發
    private boolean isNotRelease() {
        String curProfile = StringUtils.lowerCase(profile);
        return MOCK_ENABLE_PROFILE.contains(curProfile);
    }

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

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        super.afterCompletion(request, response, handler, ex);
    }
}

注冊攔截器：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
  @Resource private TestLoginInterceptor loginInterceptor;

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(loginInterceptor)
            .addPathPatterns("/**")
            .excludePathPatterns("/**/*.css","/**/*.js"); // 排除css后綴和js后綴的路徑訪問路徑
  }
}

 

轉載請注明出處。