SpringBoot 3.3 中實現 API 接口限流就是這么簡單

作者：編程疏影 2024-09-09 11:35:35

通過本文的示例，我們成功地在 Spring Boot 3.3 中實現了簡單而有效的 API 接口限流功能。我們利用了 Guava 提供的 RateLimiter 工具，結合 Spring Boot 的配置屬性管理和依賴注入機制，實現了靈活可配的限流策略。

在互聯網飛速發展的今天，隨著系統用戶規模的不斷擴大和分布式架構的廣泛應用，API 接口的穩定性和性能成為系統設計中至關重要的因素。無論是應對突發的流量高峰，還是防止惡意爬蟲的惡意請求，限流策略都已成為現代系統不可或缺的一部分。

為什么需要接口限流？

防止系統過載：在短時間內大量的請求可能導致系統資源耗盡，進而導致服務降級甚至宕機。通過限流，我們可以有效控制流量的上限，確保系統在高負載下仍然能夠提供穩定的服務。
保護關鍵資源：一些關鍵的 API 接口可能涉及到數據庫、緩存等有限資源的操作，如果不加限制，可能會導致資源耗盡，影響系統整體性能。限流可以確保這些關鍵資源的訪問量在可控范圍內。
應對惡意攻擊：分布式拒絕服務攻擊（DDoS）是常見的網絡攻擊手段，攻擊者通過發送大量請求癱瘓系統。限流策略可以作為第一道防線，快速識別并過濾掉異常流量，減少攻擊對系統的影響。
提升用戶體驗：在用戶訪問量大的情況下，如果不加以控制，可能會出現系統響應速度下降的情況，影響用戶體驗。合理的限流策略能夠為用戶提供更加穩定和一致的服務質量。
公平資源分配：在多用戶、多租戶的場景下，限流能夠確保系統資源的公平分配，避免某個用戶或租戶獨占資源，影響其他用戶的正常使用。

為了解決上述問題，我們可以在 API 接口上實施限流策略，使得系統能夠在高并發環境下保持穩定，并且能夠合理應對各類突發情況。在本文中，我們將探討如何在 SpringBoot 3.3 中，通過簡單的配置和代碼實現 API 接口的限流。

運行效果：

圖片

若想獲取項目完整代碼以及其他文章的項目源碼，且在代碼編寫時遇到問題需要咨詢交流，歡迎加入下方的知識星球。

項目結構

我們將從項目的結構開始，先了解一下本示例項目的文件布局。

rate-limiter/
├── src/
│   ├── main/
│   │   ├── java/com/icoderoad/ratelimiter/
│   │   │   ├── controller/
│   │   │   │   └── RateLimiterController.java
│   │   │   ├── config/
│   │   │   │   └── RateLimiterConfig.java
│   │   │   ├── properties/
│   │   │   │   └── RateLimiterProperties.java
│   │   │   └── application/
│   │   │       └── SpringBootRateLimiterApplication.java
│   │   ├── resources/
│   │   │   ├── templates/
│   │   │   │   └── index.html
│   │   │   └── application.yml
└── pom.xml

接下來，我們將逐步搭建項目，實現 API 接口限流功能。

引入依賴

在 pom.xml 中引入以下依賴：

<?xml versinotallow="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>3.3.3</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.icoderoad</groupId>
	<artifactId>ratelimiter</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>ratelimiter</name>
	<description>Demo project for Spring Boot</description>
	
	<properties>
		<java.version>17</java.version>
		<guava.version>31.1-jre</guava.version>
	</properties>
	<dependencies>
		 <!-- Spring Boot Web Starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Guava 用于限流 -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>${guava.version}</version>
        </dependency>

        <!-- Thymeleaf 模板引擎 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </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>
			</plugin>
		</plugins>
	</build>

</project>

配置限流參數

在 src/main/resources/application.yml 中配置限流參數：

server:
  port: 8080

rate-limiter:
  permits-per-second: 5       # 每秒許可數
  warmup-period: 0            # 預熱時間（秒）
  timeout: 0                  # 獲取許可的超時時間（秒）

參數說明：

permits-per-second：每秒允許的請求數量。
warmup-period：限流器預熱時間，用于平滑地增加到最大速率。
timeout：獲取許可的超時時間，0 表示立即返回獲取結果。

創建限流配置屬性類

在 src/main/java/com/icoderoad/ratelimiter/properties/RateLimiterProperties.java 中創建配置屬性類，用于映射 application.yml 中的配置：

package com.icoderoad.ratelimiter.propertie;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import lombok.Data;

@Data
@Component
@ConfigurationProperties(prefix = "rate-limiter")
public class RateLimiterProperties {

    /**
     * 每秒許可數
     */
    private double permitsPerSecond;

    /**
     * 預熱時間（秒）
     */
    private long warmupPeriod;

    /**
     * 獲取許可的超時時間（秒）
     */
    private long timeout;

}

說明：

使用 @ConfigurationProperties 注解將配置屬性映射到類中，便于在代碼中使用。
提供對應的 Getter 和 Setter 方法，方便 Spring Boot 自動注入配置。

配置 RateLimiter

在 src/main/java/com/icoderoad/ratelimiter/config/RateLimiterConfig.java 中創建限流器配置：

package com.icoderoad.ratelimiter.config;

import java.util.concurrent.TimeUnit;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.google.common.util.concurrent.RateLimiter;
import com.icoderoad.ratelimiter.propertie.RateLimiterProperties;

@Configuration
public class RateLimiterConfig {

    /**
     * 配置 RateLimiter Bean
     *
     * @param properties 注入的限流配置屬性
     * @return RateLimiter 實例
     */
    @Bean
    public RateLimiter rateLimiter(RateLimiterProperties properties) {
        if (properties.getWarmupPeriod() > 0) {
            // 創建帶有預熱期的 RateLimiter
            return RateLimiter.create(
                    properties.getPermitsPerSecond(),
                    properties.getWarmupPeriod(),
                    TimeUnit.SECONDS
            );
        } else {
            // 創建標準的 RateLimiter
            return RateLimiter.create(properties.getPermitsPerSecond());
        }
    }
}

說明：

根據配置文件中的參數動態創建 RateLimiter 實例。
支持帶有預熱期的限流器配置，滿足不同場景下的需求。

創建控制器

在 src/main/java/com/icoderoad/ratelimiter/controller/RateLimiterController.java 中創建控制器，處理 API 請求：

package com.icoderoad.ratelimiter.controller;

import java.util.concurrent.TimeUnit;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.google.common.util.concurrent.RateLimiter;
import com.icoderoad.ratelimiter.propertie.RateLimiterProperties;

@Controller
public class RateLimiterController {

    @Autowired
    private RateLimiter rateLimiter;

    @Autowired
    private RateLimiterProperties properties;

    /**
     * 測試限流接口
     *
     * @return 請求結果
     */
    @GetMapping("/api/test")
    @ResponseBody
    public ResponseEntity<String> testApi() {
        boolean acquired = rateLimiter.tryAcquire(properties.getTimeout(), TimeUnit.SECONDS);
        if (acquired) {
            // 允許請求，返回成功響應
            return ResponseEntity.ok("請求成功！");
        } else {
            // 拒絕請求，返回限流響應
            return ResponseEntity.status(429).body("請求過多，請稍后再試！");
        }
    }
}

說明：

使用 rateLimiter.tryAcquire(timeout, TimeUnit.SECONDS) 方法嘗試獲取許可，支持超時等待。
根據獲取許可的結果返回對應的響應：

成功獲取：返回 200 狀態碼和成功消息。

獲取失敗：返回 429 狀態碼和錯誤提示。

創建前端頁面

在 src/main/resources/templates/index.html 中創建前端頁面，使用 Thymeleaf、Bootstrap 和 jQuery 實現：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>API 限流測試</title>
    <!-- 引入 Bootstrap CSS -->
    <link rel="stylesheet" >
    <!-- 自定義樣式 -->
    <style>
        body {
            padding-top: 50px;
        }
    </style>
</head>
<body>

<div class="container">
    <h1 class="mb-4">API 限流測試</h1>
    <button id="testButton" class="btn btn-primary">發送請求</button>
    <div id="alertPlaceholder" class="mt-3"></div>
</div>

<!-- 引入 jQuery -->
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<!-- 引入 Bootstrap JS -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>

<script>
    $(document).ready(function () {
        $('#testButton').click(function () {
            $.ajax({
                url: '/api/test',
                method: 'GET',
                success: function (response) {
                    showAlert(response, 'success');
                },
                error: function (xhr) {
                    if (xhr.status === 429) {
                        showAlert(xhr.responseText, 'danger');
                    } else {
                        showAlert('發生未知錯誤，請稍后重試。', 'warning');
                    }
                }
            });
        });

        /**
         * 顯示提示信息
         * @param message 消息內容
         * @param type 提示類型（'success', 'danger', 'warning' 等）
         */
        function showAlert(message, type) {
            const alertHtml = `
                <div class="alert alert-${type} alert-dismissible fade show" role="alert">
                    ${message}
                    <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
                </div>
            `;
            $('#alertPlaceholder').html(alertHtml);
        }
    });
</script>

</body>
</html>

說明：

引入資源：

使用 CDN 加載 Bootstrap 和 jQuery，確保資源的快速和穩定加載。

頁面結構：
一個按鈕用于觸發 API 請求。
一個占位符 div 用于顯示提示信息。
JavaScript 邏輯：
使用 jQuery 監聽按鈕點擊事件，發送 AJAX 請求到 /api/test 接口。
根據響應結果，調用 showAlert 函數，在頁面上顯示不同類型的提示信息。
showAlert 函數使用 Bootstrap 的 Alert 組件，提供友好的用戶提示。

效果展示：

請求成功：顯示綠色的成功提示。
請求被限流：顯示紅色的錯誤提示，提示用戶請求過多。
未知錯誤：顯示黃色的警告提示，提示發生未知錯誤。

啟動應用

在 src/main/java/com/icoderoad/ratelimiter/application/SpringBootRateLimiterApplication.java 中啟動 Spring Boot 應用：

package com.icoderoad.ratelimiter;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication(scanBasePackages = "com.icoderoad.ratelimiter")
public class RatelimiterApplication {

	public static void main(String[] args) {
		SpringApplication.run(RatelimiterApplication.class, args);
	}

}

說明：

使用 @SpringBootApplication 注解標注主啟動類，并指定掃描的基礎包路徑。
運行 main 方法即可啟動應用。

8. 測試與驗證

步驟：

啟動應用：運行主啟動類，啟動 Spring Boot 應用。
訪問頁面：在瀏覽器中訪問 http://localhost:8080/，看到 API 限流測試頁面。
發送請求：點擊“發送請求”按鈕，觀察頁面提示信息。

正常情況：如果請求未超過限流閾值，顯示綠色的“請求成功！”提示。
限流情況：如果在短時間內連續多次點擊按鈕，超過配置的每秒許可數，將顯示紅色的“請求過多，請稍后再試！”提示。

調整配置：可以修改 application.yml 中的限流參數，重新啟動應用，測試不同的限流策略效果。

示例演示：

設置 permits-per-second 為 2，表示每秒允許 2 個請求。
連續快速點擊按鈕，多數請求將被限流，提示用戶稍后重試。

9. 總結

通過本文的示例，我們成功地在 Spring Boot 3.3 中實現了簡單而有效的 API 接口限流功能。我們利用了 Guava 提供的 RateLimiter 工具，結合 Spring Boot 的配置屬性管理和依賴注入機制，實現了靈活可配的限流策略。同時，通過前端頁面的簡單設計和友好提示，使得用戶能夠清晰地感知到限流機制的存在和作用。

責任編輯：武曉燕來源：路條編程

API 接口限流