SpringBoot攔截器使用精講

Posted on by

我們對攔截器並不陌生，無論是 Struts 2 還是 Spring MVC 中都提供瞭攔截器功能，它可以根據 URL 對請求進行攔截，主要應用於登陸校驗、權限驗證、亂碼解決、性能監控和異常處理等功能上。Spring Boot 同樣提供瞭攔截器功能。 

在 Spring Boot 項目中，使用攔截器功能通常需要以下 3 步：

  1. 定義攔截器
  2. 註冊攔截器
  3. 指定攔截規則（如果是攔截所有，靜態資源也會被攔截）

定義攔截器

在 Spring Boot 中定義攔截器十分的簡單，隻需要創建一個攔截器類，並實現 HandlerInterceptor 接口即可。

HandlerInterceptor  接口中定義以下 3 個方法，如下表。

返回值類型 方法聲明 描述
boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  該方法在控制器處理請求方法前執行，其返回值表示是否中斷後續操作，返回 true 表示繼續向下執行，返回 false 表示中斷後續操作。
void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) 該方法在控制器處理請求方法調用之後、解析視圖之前執行，可以通過此方法對請求域中的模型和視圖做進一步修改。
void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) 該方法在視圖渲染結束後執行，可以通過此方法實現資源清理、記錄日志信息等工作。

示例1

以 spring-boot-adminex 項目為例，在 net.biancheng.www.componet 中創建一個名為 LoginInterceptor 的攔截器類，對登陸進行攔截，代碼如下。

package net.biancheng.www.componet;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    /**
     * 目標方法執行前
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object loginUser = request.getSession().getAttribute("loginUser");
        if (loginUser == null) {
            //未登錄，返回登陸頁
            request.setAttribute("msg", "您沒有權限進行此操作，請先登陸！");
            request.getRequestDispatcher("/index.html").forward(request, response);
            return false;
        } else {
            //放行
            return true;
        }
    }
    /**
     * 目標方法執行後
     *
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle執行{}", modelAndView);
    }
    /**
     * 頁面渲染後
     *
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion執行異常{}", ex);
    }
}

註冊攔截器

創建一個實現瞭 WebMvcConfigurer 接口的配置類（使用瞭 @Configuration 註解的類），重寫 addInterceptors() 方法，並在該方法中調用 registry.addInterceptor() 方法將自定義的攔截器註冊到容器中。

示例 2

在配置類 MyMvcConfig 中，添加以下方法註冊攔截器，代碼如下。

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
    ......
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor());
    }
}

指定攔截規則

在使用 registry.addInterceptor() 方法將攔截器註冊到容器中後，我們便可以繼續指定攔截器的攔截規則瞭，代碼如下。

@Slf4j
@Configuration
public class MyConfig implements WebMvcConfigurer {
    ......
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        log.info("註冊攔截器");
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**") //攔截所有請求，包括靜態資源文件
                .excludePathPatterns("/", "/login", "/index.html", "/user/login", "/css/**", "/images/**", "/js/**", "/fonts/**"); //放行登錄頁，登陸操作，靜態資源
    }
}

在指定攔截器攔截規則時，調用瞭兩個方法，這兩個方法的說明如下：

  • addPathPatterns：該方法用於指定攔截路徑，例如攔截路徑為“/**”，表示攔截所有請求，包括對靜態資源的請求。
  • excludePathPatterns：該方法用於排除攔截路徑，即指定不需要被攔截器攔截的請求。

至此，攔截器的基本功能已經完成，接下來，我們先實現 spring-boot-adminex 的登陸功能，為驗證登陸攔截做準備。

實現登陸功能

1. 將 AdminEx 模板中的 main.html 移動到 src/main/resources/templates 中，結構如下圖。

圖1：main 頁面

2. 在 net.bianheng.www.controller 中創建一個 LoginController， 並在其中添加處理登陸請求的方法 doLogin()，代碼如下。

package net.biancheng.www.controller;
import lombok.extern.slf4j.Slf4j;
import net.biancheng.www.bean.User;
import org.springframework.stereotype.Controller;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpSession;
import java.util.Map;
@Slf4j
@Controller
public class LoginController {
    @RequestMapping("/user/login")
    public String doLogin(User user, Map<String, Object> map, HttpSession session) {
        if (user != null && StringUtils.hasText(user.getUsername()) && "123456".equals(user.getPassword())) {
            session.setAttribute("loginUser", user);
            log.info("登陸成功，用戶名：" + user.getUsername());
            //防止重復提交使用重定向
            return "redirect:/main.html";
        } else {
            map.put("msg", "用戶名或密碼錯誤");
            log.error("登陸失敗");
            return "login";
        }
    }
/*
    @RequestMapping("/main.html")
    public String mainPage(){
        return "main";
    }*/
}

3. 在配置類 MyMvcConfig 中添加視圖映射，代碼如下。

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        //當訪問 “/” 或 “/index.html” 時，都直接跳轉到登陸頁面
        registry.addViewController("/").setViewName("login");
        registry.addViewController("/index.html").setViewName("login");
        //添加視圖映射 main.html 指向  dashboard.html
        registry.addViewController("/main.html").setViewName("main");
    }
    ......
}

4. 在 login.html 適當位置添加以下代碼，顯示錯誤信息。

<p style="color: red" th:text="${msg}" th:if="${not #strings.isEmpty(msg)}"></p>

驗證登陸及登陸攔截功能

1. 啟動 Spring Boot，在未登錄的情況下，直接通過“http://localhost:8080/main.html”訪問主頁，結果如下圖。

圖1：登陸被攔截

2. 在登陸頁用戶名和密碼輸入框內分別輸入 “admin”和“admin123”，點擊下方的登陸按鈕，結果如下圖。

圖2：登陸失敗

3. 在登陸頁用戶名和密碼輸入框內分別輸入 “admin”和“123456”，點擊下方的登陸按鈕，結果如下圖。

圖3：登陸成功 

以上就是SpringBoot攔截器使用精講的詳細內容，更多關於SpringBoot攔截器的資料請關註WalkonNet其它相關文章！

推薦閱讀：