1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
 *      Copyright (c) 2018-2028, DreamLu All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the dreamlu.net developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: DreamLu 卢春梦 (596392912@qq.com)
 */
 
package org.springblade.core.redis.ratelimiter;
 
 
import org.springblade.core.tool.function.CheckedSupplier;
import org.springblade.core.tool.utils.Exceptions;
 
import java.util.concurrent.TimeUnit;
 
/**
 * RateLimiter 限流 Client
 *
 * @author L.cm
 */
public interface RateLimiterClient {
 
    /**
     * 服务是否被限流
     *
     * @param key 自定义的key，请保证唯一
     * @param max 支持的最大请求
     * @param ttl 时间,单位默认为秒（seconds）
     * @return 是否允许
     */
    default boolean isAllowed(String key, long max, long ttl) {
        return this.isAllowed(key, max, ttl, TimeUnit.SECONDS);
    }
 
    /**
     * 服务是否被限流
     *
     * @param key      自定义的key，请保证唯一
     * @param max      支持的最大请求
     * @param ttl      时间
     * @param timeUnit 时间单位
     * @return 是否允许
     */
    boolean isAllowed(String key, long max, long ttl, TimeUnit timeUnit);
 
    /**
     * 服务限流，被限制时抛出 RateLimiterException 异常，需要自行处理异常
     *
     * @param key      自定义的key，请保证唯一
     * @param max      支持的最大请求
     * @param ttl      时间
     * @param supplier Supplier 函数式
     * @return 函数执行结果
     */
    default <T> T allow(String key, long max, long ttl, CheckedSupplier<T> supplier) {
        return allow(key, max, ttl, TimeUnit.SECONDS, supplier);
    }
 
    /**
     * 服务限流，被限制时抛出 RateLimiterException 异常，需要自行处理异常
     *
     * @param key      自定义的key，请保证唯一
     * @param max      支持的最大请求
     * @param ttl      时间
     * @param timeUnit 时间单位
     * @param supplier Supplier 函数式
     * @param <T>
     * @return 函数执行结果
     */
    default <T> T allow(String key, long max, long ttl, TimeUnit timeUnit, CheckedSupplier<T> supplier) {
        boolean isAllowed = this.isAllowed(key, max, ttl, timeUnit);
        if (isAllowed) {
            try {
                return supplier.get();
            } catch (Throwable e) {
                throw Exceptions.unchecked(e);
            }
        }
        throw new RateLimiterException(key, max, ttl, timeUnit);
    }
}