springboot自定義攔截器簡(jiǎn)單使用及舉例

更新時(shí)間：2023年01月28日 15:15:27 作者：殺死一只知更鳥debug

Spring Boot攔截器是AOP的一種實(shí)現(xiàn),專門攔截對(duì)控制層的請(qǐng)求,主要應(yīng)用于判斷用戶權(quán)限,攔截webSocket請(qǐng)求,下面這篇文章主要給大家介紹了關(guān)于springboot自定義攔截器簡(jiǎn)單使用及舉例的相關(guān)資料,需要的朋友可以參考下

2.1 配置pom.xml
2.2 創(chuàng)建User的bean組件
2.3 創(chuàng)建需要的表單頁(yè)面以及登錄成功的頁(yè)面
2.4 編寫controller映射關(guān)系
2.5 自定義攔截器類，實(shí)現(xiàn)intercepetor接口
2.6注冊(cè)添加攔截器，自定義springboot配置類
2.7 運(yùn)行測(cè)試

總結(jié)

1. 自定義攔截器

在springboot中，使用自定義攔截器，只需要將類實(shí)現(xiàn)HandlerIntercepter接口(與原生的filter也基本差不多)。

HandlerIntercepeter源碼：

package org.springframework.web.servlet;

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

import org.springframework.lang.Nullable;
import org.springframework.web.method.HandlerMethod;

public interface HandlerInterceptor {

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {

		return true;
	}
	
	default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable ModelAndView modelAndView) throws Exception {
	}

	default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable Exception ex) throws Exception {
	}

}

preHandle()：當(dāng)某個(gè) url 已經(jīng)匹配到對(duì)應(yīng)的 Controller 中的某個(gè)方法，且在這個(gè)方法執(zhí)行之前去執(zhí)行。返回 true 則放行，返回 false 則不會(huì)向后執(zhí)行。

postHandle()：當(dāng)某個(gè) url 已經(jīng)匹配到對(duì)應(yīng)的 Controller 中的某個(gè)方法，且在執(zhí)行完了該方法，但是在 DispatcherServlet視圖渲染之前。所以在這個(gè)方法中有個(gè) ModelAndView 參數(shù)，可以在此做一些修改動(dòng)作。

afterCompletion()：在整個(gè)請(qǐng)求處理完成后（包括視圖渲染）執(zhí)行，這時(shí)做一些資源的清理工作，這個(gè)方法只有在 preHandle(……) 被成功執(zhí)行后并且返回 true才會(huì)被執(zhí)行。

2. 攔截器登錄驗(yàn)證的小demo

只有當(dāng)用戶正確登錄以后，才允許用戶去訪問(wèn)網(wǎng)站的其他頁(yè)面和資源，即初始時(shí)攔截掉所有請(qǐng)求，除了登錄頁(yè)面的請(qǐng)求，登錄成功以后放行訪問(wèn)其他頁(yè)面。

目錄結(jié)構(gòu)如下：

2.1 配置pom.xml

配置pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

2.2 創(chuàng)建User的bean組件

使用lombok，來(lái)快速生成有參無(wú)參構(gòu)造器，以及get ,set方法和toString()方法

package com.robin.boot.bean;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

@ToString
@NoArgsConstructor
@AllArgsConstructor
@Data
public class User {
    private String userName;
    private String password;
}

2.3 創(chuàng)建需要的表單頁(yè)面以及登錄成功的頁(yè)面

index.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>登錄頁(yè)面</title>
</head>
<body>
    <h3 th:text="${msg}">title</h3>
    <form action="/login" method="post">
        <input type="text" name="userName"><br>
        <input type="password" name="password"><br>
        <input type="submit" value="登錄">
    </form>
</body>
</html>

show.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>顯示頁(yè)面</title>
</head>
<body>
    <h3 th:text="${msg}">title</h3>
    賬號(hào):<p th:text="${loginUser.userName}">賬號(hào)xxx</p>
    密碼:<p th:text="${loginUser.password}">密碼xxx</p>
</body>
</html>

2.4 編寫controller映射關(guān)系

package com.robin.boot.controller;

import com.robin.boot.bean.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class LoginController {

    @PostMapping("/login")
    public String login(User user, Model model){
        System.out.println(user);
        if ("robin".equals(user.getUserName())&&"123456".equals(user.getPassword())){
            model.addAttribute("loginUser",user);
            return "show";
        }else{
            model.addAttribute("msg","登錄失敗,請(qǐng)檢查賬號(hào)密碼信息..");
            return "index";
        }
    }
}

2.5 自定義攔截器類，實(shí)現(xiàn)intercepetor接口

package com.robin.boot.interceptor;

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;
import javax.servlet.http.HttpSession;


@Slf4j
public class LoginInterceptor implements HandlerInterceptor {

    // 目標(biāo)方法執(zhí)行之前
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 攔截請(qǐng)求輸出
        String requestURI = request.getRequestURI();
        log.info("攔截了請(qǐng)求{}",requestURI);

        // 登錄檢查邏輯，是否登錄，登錄成功以后放行資源，未登錄則攔截資源
        HttpSession session = request.getSession();
        Object loginUser = session.getAttribute("loginUser");

        if (loginUser!=null){
            // 登錄成功放行資源
            return true;
        }else{
            // 提示錯(cuò)誤信息
            request.setAttribute("msg","請(qǐng)先登錄！");
            // 請(qǐng)求轉(zhuǎn)發(fā)
            request.getRequestDispatcher("/").forward(request,response);
            // 未登錄攔截資源
            return false;
        }


    }

    // 目標(biāo)方法執(zhí)行完畢
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
          log.info("postHandle執(zhí)行{}",modelAndView);
    }

    // 頁(yè)面渲染以后
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion執(zhí)行異常{}",ex);
    }
}

2.6注冊(cè)添加攔截器，自定義springboot配置類

通過(guò)addInterceptors(InterceptorRegistry registry)方法，使用registry.addInterceptor()將自定義攔截器注冊(cè)。

并且通過(guò)InterceptorRegistration.addPathPatterns()方法添加攔截的請(qǐng)求，InterceptorRegistration.excludePathPatterns()方法放行請(qǐng)求。

package com.robin.boot.config;

import com.robin.boot.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

// 自定義springboot配置類
@Configuration
public class MyWebConfig implements WebMvcConfigurer {

    // 添加注冊(cè)攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") // 攔截所有請(qǐng)求
                .excludePathPatterns("/","/login"); // 放行 / 和 /login請(qǐng)求,
        // 因?yàn)槔訉懙谋容^簡(jiǎn)單
        // .excludePathPatterns("/","/login","/css/**","/js/**","/fonts/**","/images/**"); 平常可以寫這樣
    }
}

2.7 運(yùn)行測(cè)試

訪問(wèn)首頁(yè)：

輸入錯(cuò)誤的賬號(hào)信息：

直接通過(guò)地址欄訪問(wèn)show.html,http://localhost:8080/show.html,攔截器發(fā)送提示信息并請(qǐng)求轉(zhuǎn)發(fā)到index.html,因?yàn)槭钦?qǐng)求轉(zhuǎn)發(fā)，所有地址欄不會(huì)發(fā)生改變。