springboot自定義攔截器簡單使用及舉例

2023-01-31 06:02:18

1. 自定義攔截器

在springboot中，使用自定義攔截器，只需要將類實現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()：當某個 url 已經匹配到對應的 Controller 中的某個方法，且在這個方法執行之前去執行。返回 true 則放行，返回 false 則不會向後執行。

postHandle()：當某個 url 已經匹配到對應的 Controller 中的某個方法，且在執行完了該方法，但是在 DispatcherServlet檢視渲染之前。所以在這個方法中有個 ModelAndView 引數，可以在此做一些修改動作。

afterCompletion()：在整個請求處理完成後（包括檢視渲染）執行，這時做一些資源的清理工作，這個方法只有在 preHandle(……) 被成功執行後並且返回 true才會被執行。

2. 攔截器登入驗證的小demo

只有當用戶正確登入以後，才允許使用者去存取網站的其他頁面和資源，即初始時攔截掉所有請求，除了登入頁面的請求，登入成功以後放行存取其他頁面。

目錄結構如下：

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 建立User的bean元件

使用lombok，來快速生成有參無參構造器，以及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 建立需要的表單頁面以及登入成功的頁面

index.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>登入頁面</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>顯示頁面</title>
</head>
<body>
    <h3 th:text="${msg}">title</h3>
    賬號:<p th:text="${loginUser.userName}">賬號xxx</p>
    密碼:<p th:text="${loginUser.password}">密碼xxx</p>
</body>
</html>

2.4 編寫controller對映關係

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","登入失敗,請檢查賬號密碼資訊..");
            return "index";
        }
    }
}

2.5 自定義攔截器類，實現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 {

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

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

        if (loginUser!=null){
            // 登入成功放行資源
            return true;
        }else{
            // 提示錯誤資訊
            request.setAttribute("msg","請先登入！");
            // 請求轉發
            request.getRequestDispatcher("/").forward(request,response);
            // 未登入攔截資源
            return false;
        }


    }

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

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

2.6註冊新增攔截器，自定義springboot設定類

通過addInterceptors(InterceptorRegistry registry)方法，使用registry.addInterceptor()將自定義攔截器註冊。

並且通過InterceptorRegistration.addPathPatterns()方法新增攔截的請求，InterceptorRegistration.excludePathPatterns()方法放行請求。

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 {

    // 新增註冊攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") // 攔截所有請求
                .excludePathPatterns("/","/login"); // 放行 / 和 /login請求,
        // 因為例子寫的比較簡單
        // .excludePathPatterns("/","/login","/css/**","/js/**","/fonts/**","/images/**"); 平常可以寫這樣
    }
}