SpringBoot之用攔截器避免重覆請求

来源:https://www.cnblogs.com/okokabcd/archive/2022/11/21/16913680.html
-Advertisement-
Play Games

我們結合運算符重載知識實現string 類 在自己實現的String類中可以參考C++中string的方法 例如構造，加法，大小比較,長度，[] 等操作. 當前的MyString 類中,暫時不加入迭代器,我們將在下一節中加入迭代器的代碼. #include <iostream> using name ...


攔截器

什麼是攔截器

Spring MVC中的攔截器(Interceptor)類似於Servlet中的過濾器(Filter)，它主要用於攔截用戶請求並作相應的處理。例如通過攔截器可以進行許可權驗證、記錄請求信息的日誌、判斷用戶是否登錄等。

如何自定義攔截器

自定義一個攔截器非常簡單，只需要實現HandlerInterceptor這個介面即可，這個介面有三個可實現的方法

  1. preHandle()方法：該方法會在控制器方法前執行，其返回值表示是否知道如何寫一個介面。中斷後續操作。當其返回值為true時，表示繼續向下執行；當其返回值為false時，會中斷後續的所有操作（包括調用下一個攔截器和控制器類中的方法執行等）。

  2. postHandle()方法：該方法會在控制器方法調用之後，且解析視圖之前執行。可以通過此方法對請求域中的模型和視圖做出進一步的修改。

  3. afterCompletion()方法：該方法會在整個請求完成，即視圖渲染結束之後執行。可以通過此方法實現一些資源清理、記錄日誌信息等工作。

如何讓攔截器在Spring Boot中生效

想要在Spring Boot生效其實很簡單，只需要定義一個配置類，實現WebMvcConfigurer這個介面，並且實現其中的addInterceptors()方法即可，代碼如下：

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private XXX xxx;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 不攔截的uri
        final String[] commonExclude = {}};
        registry.addInterceptor(xxx).excludePathPatterns(commonExclude);
    }
}

用攔截器規避重覆請求

需求

開發中可能會經常遇到短時間內由於用戶的重覆點擊導致幾秒之內重覆的請求，可能就是在這幾秒之內由於各種問題，比如網路，事務的隔離性等等問題導致了數據的重覆等問題，因此在日常開發中必須規避這類的重覆請求操作，今天就用攔截器簡單的處理一下這個問題。

思路

在介面執行之前先對指定介面（比如標註某個註解的介面）進行判斷，如果在指定的時間內（比如5秒）已經請求過一次了，則返回重覆提交的信息給調用者。

根據什麼判斷這個介面已經請求了？

根據項目的架構可能判斷的條件也是不同的，比如IP地址，用戶唯一標識、請求參數、請求URI等等其中的某一個或者多個的組合。

這個具體的信息存放在哪？

由於是短時間內甚至是瞬間並且要保證定時失效，肯定不能存在事務性資料庫中了，因此常用的幾種資料庫中只有Redis比較合適了。

實現

Docker啟動一個Redis

docker pull redis:7.0.4

docker run -itd \
	--name redis \
	-p 6379:6379 \
	redis:7.0.4

創建一個Spring Boot項目

使用idea的Spring Initializr來創建一個Spring Boot項目，如下圖：

image.png

添加依賴

pom.xml文件如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.example</groupId>
    <artifactId>springboot_06</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot_06</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!--spring redis配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <!-- 1.5的版本預設採用的連接池技術是jedis  2.0以上版本預設連接池是lettuce, 在這裡採用jedis，所以需要排除lettuce的jar -->
            <exclusions>
                <exclusion>
                    <groupId>redis.clients</groupId>
                    <artifactId>jedis</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>io.lettuce</groupId>
                    <artifactId>lettuce-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

配置Redis

application.properties

spring.redis.host=127.0.0.1
spring.redis.database=1
spring.redis.port=6379

定義一個註解

package com.example.springboot_06.intercept;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RepeatSubmit {
    /**
     * 預設失效時間5秒
     *
     * @return
     */
    long seconds() default 5;
}

創建一個攔截器

package com.example.springboot_06.intercept;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Objects;
import java.util.concurrent.TimeUnit;

/**
 * 重覆請求的攔截器
 *
 * @Component：該註解將其註入到IOC容器中
 */
@Slf4j
@Component
public class RepeatSubmitInterceptor implements HandlerInterceptor {

    /**
     * Redis的API
     */
    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    /**
     * preHandler方法，在controller方法之前執行
     * <p>
     * 判斷條件僅僅是用了uri，實際開發中根據實際情況組合一個唯一識別的條件。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            // 只攔截標註了@RepeatSubmit該註解
            HandlerMethod method = (HandlerMethod) handler;
            // 標註在方法上的@RepeatSubmit
            RepeatSubmit repeatSubmitByMethod = AnnotationUtils.findAnnotation(method.getMethod(), RepeatSubmit.class);
            // 標註在controler類上的@RepeatSubmit
            RepeatSubmit repeatSubmitByCls = AnnotationUtils.findAnnotation(method.getMethod().getDeclaringClass(), RepeatSubmit.class);
            // 沒有限制重覆提交，直接跳過
            if (Objects.isNull(repeatSubmitByMethod) && Objects.isNull(repeatSubmitByCls)) {
                log.info("isNull");
                return true;
            }

            // todo: 組合判斷條件，這裡僅僅是演示，實際項目中根據架構組合條件
            //請求的URI
            String uri = request.getRequestURI();

            //存在即返回false，不存在即返回true
            Boolean ifAbsent = stringRedisTemplate.opsForValue().setIfAbsent(uri, "",
                    Objects.nonNull(repeatSubmitByMethod) ? repeatSubmitByMethod.seconds() : repeatSubmitByCls.seconds(), TimeUnit.SECONDS);

            //如果存在，表示已經請求過了，直接拋出異常，由全局異常進行處理返回指定信息
            if (ifAbsent != null && !ifAbsent) {
                String msg = String.format("url:[%s]重覆請求", uri);
                log.warn(msg);
                // throw new RepeatSubmitException(msg);
                throw new Exception(msg);
            }
        }
        return true;
    }
}

配置攔截器

package com.example.springboot_06.config;
import com.example.springboot_06.intercept.RepeatSubmitInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private RepeatSubmitInterceptor repeatSubmitInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 不攔截的uri
        final String[] commonExclude = {"/error", "/files/**"};
        registry.addInterceptor(repeatSubmitInterceptor).excludePathPatterns(commonExclude);
    }
}

寫個測試Controller

package com.example.springboot_06.controller;

import com.example.springboot_06.intercept.RepeatSubmit;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 標註了@RepeatSubmit註解，全部的介面都需要攔截
 *
 */
@Slf4j
@RestController
@RequestMapping("/user")
@RepeatSubmit
public class UserController {

    @RequestMapping("/save")
    public ResponseEntity save() {
        log.info("/user/save");
        return ResponseEntity.ok("save success");
    }
}

測試

image.png


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Android 自定義標題欄組件
    1.繪製Layout文件 首先新建一個layout文件, 命名為title_bar, 在裡面繪製標題欄, 我需要的是一個有返回鍵和當前頁面標題的titleBar 佈局代碼如下 <?xml version="1.0" encoding="utf-8"?> <FrameLayout xmlns:andr ...
  • Android Studio虛擬機無法顯示
    故障 做開發項目做的好好的，點了下清理工具，Android虛擬機的視窗沒了 回到Device Manager可以看到虛擬機確實還打開著，但就是無法啟動界面 解決 多半是清理的時候清理掉了前臺，找了半天也沒找到再次打開前臺的方法，重新運行程式也可以正常運行，就是不彈出界面。考慮殺掉後臺，讓Emulat ...
  • vue+ arcgis for js4.x 地方坐標系地圖服務（Spatial Reference）
    初始化地圖 引入 import * as esriLoader from 'esri-loader' 主要定義 private mapId: string = '' private map: any private mapview: any private markers: any = {} // ...
  • 自學 TypeScript 第四天，手把手項目搭建
    前言： 學了三天，我們學習了 TS 的基本類型聲明，TS 的編譯，webpack 打包，其實也就差不多了，剩下的也就一些 類，繼承，構造函數，抽象類，泛型一些的，如果都細緻的講可能寫好久，感興趣的可以自己找資料細緻的去學一下 學習代碼或一個新語法，最好的方法無非就是做項目，從這個過程中學會如何去使用 ...
  • 快速構建頁面結構的 3D Visualization
    對 Chrome 擴展功能熟悉的小伙伴，可能都有用過 Chrome 的 3D 展示頁面層級關係這個功能。 可以通過 控制台 --> 右邊的三個小點 --> More Tools --> Layers 打開。即可以看到頁面的一個 3D 層級關係，像是這樣： 這個功能有幾個不錯的作用： 頁面層級概覽 快 ...
  • JavaScript基礎快速複習
    學習信息 學習形式：網路教學視頻 學習地址：https://www.bilibili.com/video/BV1Sy4y1C7ha/?spm_id_from=333.337.search-card.all.click 學習開始時間：2022年11月18日 01 初識 JavaScript 瀏覽器執行 ...
  • 小公司的應用服務部署歷程
    先聲明一下：我所在的公司是一個小團隊，做物聯網相關的，前後端、硬體、測試加起來也就五六十個人左右；本人的崗位是Java開發（兼DBA、運維。。。）；我進公司時整個項目的部署架構為 簡單jar包部署微服務集群形式；去年公司將部分服務使用docker進行部署；因為現在服務稍微有點多導致容器管理起來也比較 ...
  • python中的字元串操作
    # 1.索引(下標) print('1.索引') str_data = 'Python' # [索引(下標)]取索引的格式 # 正負索引 # 獲取單個數據 sub_str = str_data[4] print(sub_str) sub_str = str_data[-2] print(sub_st ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類