Java使用Semaphore对单接口进行限流

2021-07-21 15:39:55 作者：TianXinCoord

本篇主要讲如何使用Semaphore对单接口进行限流，主要有三种方式，文中通过示例代码介绍的非常详细，需要的朋友们下面随着小编来一起学习学习吧

一、实战说明

1.1 效果说明

本篇主要讲如何使用Semaphore对单接口进行限流，例如有如下场景
a. A系统的有a接口主要给B系统调用，现在希望对B系统进行限流，例如处理峰值在100，超过100的请求快速失败
b. 接口作为总闸入口，希望限制所有外来访问，例如某个房间只能同时100个玩家在线，只有前面的处理完后面的才能继续请求
c. 其他类型场景，也就是资源固定的情况下需要轮流使用资源的可以采用Semaphore

不适用场景
a. 由于是针对总入口进行限流，所以不能根据IP或者token等进行限流，适用场景比较固定
b. 后续的博客中会介绍如何使用其他的针对IP/Token级别的限流，例如AOP+Redis+Lua进行限流

优点主要有
a. 相比针对IP级别的限流，Semaphore实现相对简单，对上述场景能快速实现限流效果

实现难度：3颗星

1.2 核心知识点

主要使用以下技术点
a. springboot
b. juc包中的Semaphore(tryAcquire、release方法)

Semaphore主要说明
a. Semaphore中可以通过tryAcquire和acquire获取到一个许可证(默认)，通过release释放许可证
b. 两个获取许可证的主要区别就是前者是非阻塞而后者阻塞，如果我们要实现快速失败的效果，就必须使用非阻塞获取许可证方法
注意点
a. 一定要确保release方法被调用，例如放到finally中，否则许可证得不到释放，将会导致接口被全部陷死，无法接收请求

二、环境搭建

环境使用idea+spring initializr创建
新建springboot web项目

在这里插入图片描述

包目录说明

在这里插入图片描述

新建SemaphoreController，请求路径为limit
a. 注意点已经代码注释说明

package com.codecoord.semaphore.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.concurrent.Semaphore;

/**
 * 限流侧测试
 *
 * @author tianxincode@163.com
 * @since 2020-08-06
 */
@RestController
public class SemaphoreController {
    /**
     * 最大信号量，例如此处3，生成环境可以做成可配置项，通过注入方式进行注入
     */
    private static final int MAX_SEMAPHORE = 3;
    /**
     * Semaphore主限流，全局就行
     */
    private static final Semaphore SEMAPHORE = new Semaphore(MAX_SEMAPHORE);

    @RequestMapping("/limit")
    public String limit() {
        // 01.使用非阻塞tryAcquire，如果获取不到就快速返回失败
        if (!SEMAPHORE.tryAcquire()) {
            return "请求频率超过限制：" + MAX_SEMAPHORE;
        }

        // 02. 如果能进入到这里，说明一定获取到了许可证
        /// todo 可能的参数校验，注意如果参数校验不通过，一定要调用release方法
        /*if (valid(xxx)) {
            SEMAPHORE.release();
        }*/

        try {
            // 03. 模拟业务处理，假如需要1s
            Thread.sleep(1000);
            return "业务处理成功";
        } catch (InterruptedException e) {
            // 错误处理
            return "业务处理失败";
        } finally {
            // 04. 一定要释放，否则导致接口假死无法处理请求
            SEMAPHORE.release();
        }
    }
}