SpringBoot + Redis 實(shí)現(xiàn)接口限流，一個(gè)注解的事！
Hollis的新書限時(shí)折扣中，一本深入講解Java基礎(chǔ)的干貨筆記！
Redis 除了做緩存，還能干很多很多事情：分布式鎖、限流、處理請求接口冪等性。。。太多太多了～
今天想和小伙伴們聊聊用 Redis 處理接口限流，這也是最近的 TienChin 項(xiàng)目涉及到這個(gè)知識(shí)點(diǎn)了，我就拎出來和大家聊聊這個(gè)話題，后面視頻也會(huì)講。
1. 準(zhǔn)備工作
首先我們創(chuàng)建一個(gè) Spring Boot 工程，引入 Web 和 Redis 依賴，同時(shí)考慮到接口限流一般是通過注解來標(biāo)記，而注解是通過 AOP 來解析的，所以我們還需要加上 AOP 的依賴，最終的依賴如下：
<dependency>
????<groupId>org.springframework.bootgroupId>
????<artifactId>spring-boot-starter-data-redisartifactId>
dependency>
<dependency>
????<groupId>org.springframework.bootgroupId>
????<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
????<groupId>org.springframework.bootgroupId>
????<artifactId>spring-boot-starter-aopartifactId>
dependency>
然后提前準(zhǔn)備好一個(gè) Redis 實(shí)例，這里我們項(xiàng)目配置好之后，直接配置一下 Redis 的基本信息即可，如下：
spring.redis.host=localhost
spring.redis.port=6379
spring.redis.password=123
好啦，準(zhǔn)備工作就算是到位了。
2. 限流注解
接下來我們創(chuàng)建一個(gè)限流注解，我們將限流分為兩種情況：
針對當(dāng)前接口的全局性限流，例如該接口可以在 1 分鐘內(nèi)訪問 100 次。 針對某一個(gè) IP 地址的限流，例如某個(gè) IP 地址可以在 1 分鐘內(nèi)訪問 100 次。
針對這兩種情況，我們創(chuàng)建一個(gè)枚舉類：
public?enum?LimitType?{
????/**
?????*?默認(rèn)策略全局限流
?????*/
????DEFAULT,
????/**
?????*?根據(jù)請求者IP進(jìn)行限流
?????*/
????IP
}
接下來我們來創(chuàng)建限流注解：
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public?@interface?RateLimiter?{
????/**
?????*?限流key
?????*/
????String?key()?default?"rate_limit:";
????/**
?????*?限流時(shí)間,單位秒
?????*/
????int?time()?default?60;
????/**
?????*?限流次數(shù)
?????*/
????int?count()?default?100;
????/**
?????*?限流類型
?????*/
????LimitType?limitType()?default?LimitType.DEFAULT;
}
第一個(gè)參數(shù)限流的 key，這個(gè)僅僅是一個(gè)前綴，將來完整的 key 是這個(gè)前綴再加上接口方法的完整路徑，共同組成限流 key，這個(gè) key 將被存入到 Redis 中。
另外三個(gè)參數(shù)好理解，我就不多說了。
好了，將來哪個(gè)接口需要限流，就在哪個(gè)接口上添加?@RateLimiter?注解，然后配置相關(guān)參數(shù)即可。
3. 定制 RedisTemplate
小伙伴們知道，在 Spring Boot 中，我們其實(shí)更習(xí)慣使用 Spring Data Redis 來操作 Redis，不過默認(rèn)的 RedisTemplate 有一個(gè)小坑，就是序列化用的是 JdkSerializationRedisSerializer，不知道小伙伴們有沒有注意過，直接用這個(gè)序列化工具將來存到 Redis 上的 key 和 value 都會(huì)莫名其妙多一些前綴，這就導(dǎo)致你用命令讀取的時(shí)候可能會(huì)出錯(cuò)。
例如存儲(chǔ)的時(shí)候，key 是 name，value 是 javaboy，但是當(dāng)你在命令行操作的時(shí)候，get name?卻獲取不到你想要的數(shù)據(jù)，原因就是存到 redis 之后 name 前面多了一些字符，此時(shí)只能繼續(xù)使用 RedisTemplate 將之讀取出來。
我們用 Redis 做限流會(huì)用到 Lua 腳本，使用 Lua 腳本的時(shí)候，就會(huì)出現(xiàn)上面說的這種情況，所以我們需要修改 RedisTemplate 的序列化方案。
?可能有小伙伴會(huì)說為什么不用 StringRedisTemplate 呢？StringRedisTemplate 確實(shí)不存在上面所說的問題，但是它能夠存儲(chǔ)的數(shù)據(jù)類型不夠豐富，所以這里不考慮。
修改 RedisTemplate 序列化方案，代碼如下：
@Configuration
public?class?RedisConfig?{
????@Bean
????public?RedisTemplate?redisTemplate(RedisConnectionFactory?connectionFactory)? {
????????RedisTemplate?redisTemplate?=?new?RedisTemplate<>();
????????redisTemplate.setConnectionFactory(connectionFactory);
????????//?使用Jackson2JsonRedisSerialize?替換默認(rèn)序列化(默認(rèn)采用的是JDK序列化)
????????Jackson2JsonRedisSerializer 這個(gè)其實(shí)也沒啥好說的，key 和 value 我們都使用 Spring Boot 中默認(rèn)的 jackson 序列化方式來解決。
4. 開發(fā) Lua 腳本
這個(gè)其實(shí)我在之前 vhr 那一套視頻中講過，Redis 中的一些原子操作我們可以借助 Lua 腳本來實(shí)現(xiàn)，想要調(diào)用 Lua 腳本，我們有兩種不同的思路：
在 Redis 服務(wù)端定義好 Lua 腳本，然后計(jì)算出來一個(gè)散列值，在 Java 代碼中，通過這個(gè)散列值鎖定要執(zhí)行哪個(gè) Lua 腳本。 直接在 Java 代碼中將 Lua 腳本定義好，然后發(fā)送到 Redis 服務(wù)端去執(zhí)行。
Spring Data Redis 中也提供了操作 Lua 腳本的接口，還是比較方便的，所以我們這里就采用第二種方案。
我們在 resources 目錄下新建 lua 文件夾專門用來存放 lua 腳本，腳本內(nèi)容如下：
local?key?=?KEYS[1]
local?count?=?tonumber(ARGV[1])
local?time?=?tonumber(ARGV[2])
local?current?=?redis.call('get',?key)
if?current?and?tonumber(current)?>?count?then
????return?tonumber(current)
end
current?=?redis.call('incr',?key)
if?tonumber(current)?==?1?then
????redis.call('expire',?key,?time)
end
return?tonumber(current)
這個(gè)腳本其實(shí)不難，大概瞅一眼就知道干啥用的。KEYS 和 ARGV 都是一會(huì)調(diào)用時(shí)候傳進(jìn)來的參數(shù)，tonumber 就是把字符串轉(zhuǎn)為數(shù)字，redis.call 就是執(zhí)行具體的 redis 指令，具體流程是這樣：
首先獲取到傳進(jìn)來的 key 以及 限流的 count 和時(shí)間 time。 通過 get 獲取到這個(gè) key 對應(yīng)的值，這個(gè)值就是當(dāng)前時(shí)間窗內(nèi)這個(gè)接口可以訪問多少次。 如果是第一次訪問，此時(shí)拿到的結(jié)果為 nil，否則拿到的結(jié)果應(yīng)該是一個(gè)數(shù)字，所以接下來就判斷，如果拿到的結(jié)果是一個(gè)數(shù)字，并且這個(gè)數(shù)字還大于 count，那就說明已經(jīng)超過流量限制了，那么直接返回查詢的結(jié)果即可。 如果拿到的結(jié)果為 nil，說明是第一次訪問，此時(shí)就給當(dāng)前 key 自增 1，然后設(shè)置一個(gè)過期時(shí)間。 最后把自增 1 后的值返回就可以了。
其實(shí)這段 Lua 腳本很好理解。
接下來我們在一個(gè) Bean 中來加載這段 Lua 腳本，如下：
@Bean
public?DefaultRedisScript?limitScript()? {
????DefaultRedisScript?redisScript?=?new?DefaultRedisScript<>();
????redisScript.setScriptSource(new?ResourceScriptSource(new?ClassPathResource("lua/limit.lua")));
????redisScript.setResultType(Long.class);
????return?redisScript;
}
可以啦，我們的 Lua 腳本現(xiàn)在就準(zhǔn)備好了。
5. 注解解析
接下來我們就需要自定義切面，來解析這個(gè)注解了，我們來看看切面的定義：
@Aspect
@Component
public?class?RateLimiterAspect?{
????private?static?final?Logger?log?=?LoggerFactory.getLogger(RateLimiterAspect.class);
????@Autowired
????private?RedisTemplate?redisTemplate;
????@Autowired
????private?RedisScript?limitScript;
????@Before("@annotation(rateLimiter)")
????public?void?doBefore(JoinPoint?point,?RateLimiter?rateLimiter)?throws?Throwable?{
????????String?key?=?rateLimiter.key();
????????int?time?=?rateLimiter.time();
????????int?count?=?rateLimiter.count();
????????String?combineKey?=?getCombineKey(rateLimiter,?point);
????????List 這個(gè)切面就是攔截所有加了?@RateLimiter?注解的方法，在前置通知中對注解進(jìn)行處理。
首先獲取到注解中的 key、time 以及 count 三個(gè)參數(shù)。 獲取一個(gè)組合的 key，所謂的組合的 key，就是在注解的 key 屬性基礎(chǔ)上，再加上方法的完整路徑，如果是 IP 模式的話，就再加上 IP 地址。以 IP 模式為例，最終生成的 key 類似這樣： rate_limit:127.0.0.1-org.javaboy.ratelimiter.controller.HelloController-hello（如果不是 IP 模式，那么生成的 key 中就不包含 IP 地址）。將生成的 key 放到集合中。 通過 redisTemplate.execute 方法取執(zhí)行一個(gè) Lua 腳本，第一個(gè)參數(shù)是腳本所封裝的對象，第二個(gè)參數(shù)是 key，對應(yīng)了腳本中的 KEYS，后面是可變長度的參數(shù)，對應(yīng)了腳本中的 ARGV。 將 Lua 腳本執(zhí)行的結(jié)果與 count 進(jìn)行比較，如果大于 count，就說明過載了，拋異常就行了。
好了，大功告成了。
6. 接口測試
接下來我們就進(jìn)行接口的一個(gè)簡單測試，如下：
@RestController
public?class?HelloController?{
????@GetMapping("/hello")
????@RateLimiter(time?=?5,count?=?3,limitType?=?LimitType.IP)
????public?String?hello()?{
????????return?"hello>>>"+new?Date();
????}
}
每一個(gè) IP 地址，在 5 秒內(nèi)只能訪問 3 次。
這個(gè)自己手動(dòng)刷新瀏覽器都能測試出來。
7. 全局異常處理
由于過載的時(shí)候是拋異常出來，所以我們還需要一個(gè)全局異常處理器，如下：
@RestControllerAdvice
public?class?GlobalException?{
????@ExceptionHandler(ServiceException.class)
????public?Map<String,Object>?serviceException(ServiceException?e)?{
????????HashMap?map?=?new?HashMap<>();
????????map.put("status",?500);
????????map.put("message",?e.getMessage());
????????return?map;
????}
}
這是一個(gè)小 demo，我就不去定義實(shí)體類了，直接用 Map 來返回 JSON 了。
好啦，大功告成。
最后我們看看過載時(shí)的測試效果：
好啦，這就是我們使用 Redis 做限流的方式。
完
我的新書《深入理解Java核心技術(shù)》已經(jīng)上市了，上市后一直蟬聯(lián)京東暢銷榜中，目前正在6折優(yōu)惠中，想要入手的朋友千萬不要錯(cuò)過哦~長按二維碼即可購買~
長按掃碼享受6折優(yōu)惠
往期推薦
JB出品，下一代IDE！！
SpringBoot 實(shí)現(xiàn)業(yè)務(wù)校驗(yàn)，這種方式才叫優(yōu)雅！
阿里大佬離職，一周面了20 多場，面經(jīng)奉上
有道無術(shù)，術(shù)可成；有術(shù)無道，止于術(shù)
歡迎大家關(guān)注Java之道公眾號(hào)
好文章，我在看??