SpringBoot自定義攔截器實現

1、編寫攔截器實現類，此類必須實現接口   HandlerInterceptor，然后重寫里面需要的三個比較常用的方法，實現自己的業務邏輯代碼

如：OneInterceptor

package com.leecx.interceptors.interceptor;


import com.leecx.pojo.LeeJSONResult;
import com.leecx.utils.JsonUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;

public class OneInterceptor implements HandlerInterceptor{

    /**
     * 在請求處理之前進行調用（Controller方法調用之前）
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {

        System.out.println("=====================");
        if (true) {
            returnErrorResponse(httpServletResponse, LeeJSONResult.errorMsg("被one攔截..."));
        }

        System.out.println("被one攔截...");

        return false;
    }

    /**
     * 請求處理之后進行調用，但是在視圖被渲染之前（Controller方法調用之后）
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

    }

    /**
     * 在整個請求結束之后被調用，也就是在DispatcherServlet 渲染了對應的視圖之后執行（主要是用於進行資源清理工作）
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

    }

    public void returnErrorResponse(HttpServletResponse response, LeeJSONResult result) throws IOException, UnsupportedEncodingException {
        OutputStream out = null;
        try{
            response.setCharacterEncoding("utf-8");
            response.setContentType("text/json");
            out = response.getOutputStream();
            out.write(JsonUtils.objectToJson(result).getBytes("utf-8"));
            out.flush();
        } finally{
            if(out!=null){
                out.close();
            }
        }
    }
}

說明：

1、preHandle  方法會在請求處理之前進行調用（Controller方法調用之前）

2、postHandle  請求處理之后進行調用，但是在視圖被渲染之前（Controller方法調用之后）

3、afterCompletion  在整個請求結束之后被調用，也就是在DispatcherServlet 渲染了對應的視圖之后執行（主要是用於進行資源清理工作）

2、編寫攔截器配置文件主類 WebMvcConfigurer  此類必須繼承  WebMvcConfigurerAdapter 類，並重寫其中的方法  addInterceptors   並且在主類上加上注解  @Configuration    

如：WebMvcConfigurer

package com.leecx.interceptors.config;

import com.leecx.interceptors.interceptor.OneInterceptor;
import com.leecx.interceptors.interceptor.TwoInterceptor;
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 WebMvcConfigurer extends WebMvcConfigurerAdapter{

    /**
     * <p>Title:</p>
     * <p>Description:重寫增加自定義攔截器的注冊，某一個攔截器需要先注冊進來，才能工作</p>
     * param[1]: null
     * return:
     * exception:
     * date:2018/4/18 0018 下午 17:29
     * author:段美林[[e-mail]]
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new OneInterceptor()).addPathPatterns("/one/**");

        registry.addInterceptor(new TwoInterceptor()).addPathPatterns("/one/**")
                                                     .addPathPatterns("/two/**");

        super.addInterceptors(registry);
    }
}

說明：

   攔截器的執行是會根據 registry 注入的先后順序執行，比如：/one/**   同時被  OneInterceptor、TwoInterceptor 攔截，但會先執行 OneInterceptor攔截的業務請求，因為它先注入進來的

 

3、在controller業務層，只要請求的地址為  攔截器 申明的需要攔截地址即可進入相應的業務處理。

如：OneInterceptorController    這個controller 類的所有實現方法都會被 攔截器  OneInterceptor   所攔截到。

package com.leecx.controller;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import com.leecx.pojo.User;

@Controller
@RequestMapping("/one")
public class OneInterceptorController {

    @RequestMapping("/index")
    public String index(ModelMap map) {
        System.out.println("=========one is  index");
        map.addAttribute("name", "itzixi22");
        return "thymeleaf/index";
    }
    
    @RequestMapping("center")
    public String center() {
        return "thymeleaf/center/center";
    }

    @RequestMapping("test")
    public String test(ModelMap map) {
        
        User user = new User();
        user.setAge(18);
        user.setName("manager");
        user.setPassword("123456");
        user.setBirthday(new Date());
        
        map.addAttribute("user", user);
        
        
        User u1 = new User();
        u1.setAge(19);
        u1.setName("itzixi");
        u1.setPassword("123456");
        u1.setBirthday(new Date());
        
        User u2 = new User();
        u2.setAge(17);
        u2.setName("LeeCX");
        u2.setPassword("123456");
        u2.setBirthday(new Date());
        
        List<User> userList = new ArrayList<>();
        userList.add(user);
        userList.add(u1);
        userList.add(u2);
        
        map.addAttribute("userList", userList);
        
        return "thymeleaf/test";
    }
    
    @PostMapping("postform")
    public String postform(User user) {
        System.out.println(user.getName());
        return "redirect:/th/test";
    }
}