Redis 做接口限流，一个注解的事！

Redis 除了做缓存，还能干很多很多事情：分布式锁、限流、处理请求接口幂等性。。。太多太多了～,今天想和小伙伴们聊聊用 Redis 处理接口限流，这也是最近的 TienChin 项目涉及到这个知识点了，我就拎出来和大家聊聊这个话题。,首先我们创建一个 Spring Boot 工程，引入 Web 和 Redis 依赖，同时考虑到接口限流一般是通过注解来标记，而注解是通过 AOP 来解析的，所以我们还需要加上 AOP 的依赖，最终的依赖如下：,然后提前准备好一个 Redis 实例，这里我们项目配置好之后，直接配置一下 Redis 的基本信息即可，如下：,好啦，准备工作就算是到位了。,接下来我们创建一个限流注解，我们将限流分为两种情况：,针对这两种情况，我们创建一个枚举类：,接下来我们来创建限流注解：,第一个参数限流的 key，这个仅仅是一个前缀，将来完整的 key 是这个前缀再加上接口方法的完整路径，共同组成限流 key，这个 key 将被存入到 Redis 中。,另外三个参数好理解，我就不多说了。,好了，将来哪个接口需要限流，就在哪个接口上添加 注解，然后配置相关参数即可。@RateLimiter,小伙伴们知道，在 Spring Boot 中，我们其实更习惯使用 Spring Data Redis 来操作 Redis，不过默认的 RedisTemplate 有一个小坑，就是序列化用的是 JdkSerializationRedisSerializer，不知道小伙伴们有没有注意过，直接用这个序列化工具将来存到 Redis 上的 key 和 value 都会莫名其妙多一些前缀，这就导致你用命令读取的时候可能会出错。,例如存储的时候，key 是 name，value 是 javaboy，但是当你在命令行操作的时候， 却获取不到你想要的数据，原因就是存到 redis 之后 name 前面多了一些字符，此时只能继续使用 RedisTemplate 将之读取出来。get name,我们用 Redis 做限流会用到 Lua 脚本，使用 Lua 脚本的时候，就会出现上面说的这种情况，所以我们需要修改 RedisTemplate 的序列化方案。,可能有小伙伴会说为什么不用 StringRedisTemplate 呢?StringRedisTemplate 确实不存在上面所说的问题，但是它能够存储的数据类型不够丰富，所以这里不考虑。,修改 RedisTemplate 序列化方案，代码如下：,这个其实也没啥好说的，key 和 value 我们都使用 Spring Boot 中默认的 jackson 序列化方式来解决。,这个其实我在之前 vhr 那一套视频中讲过，Redis 中的一些原子操作我们可以借助 Lua 脚本来实现，想要调用 Lua 脚本，我们有两种不同的思路：,Spring Data Redis 中也提供了操作 Lua 脚本的接口，还是比较方便的，所以我们这里就采用第二种方案。,我们在 resources 目录下新建 lua 文件夹专门用来存放 lua 脚本，脚本内容如下：,这个脚本其实不难，大概瞅一眼就知道干啥用的。KEYS 和 ARGV 都是一会调用时候传进来的参数，tonumber 就是把字符串转为数字，redis.call 就是执行具体的 redis 指令，具体流程是这样：,其实这段 Lua 脚本很好理解。,接下来我们在一个 Bean 中来加载这段 Lua 脚本，如下：,可以啦，我们的 Lua 脚本现在就准备好了。,接下来我们就需要自定义切面，来解析这个注解了，我们来看看切面的定义：,这个切面就是拦截所有加了 注解的方法，在前置通知中对注解进行处理。@RateLimiter,好了，大功告成了。,接下来我们就进行接口的一个简单测试，如下：,每一个 IP 地址，在 5 秒内只能访问 3 次。,这个自己手动刷新浏览器都能测试出来。,由于过载的时候是抛异常出来，所以我们还需要一个全局异常处理器，如下：,这是一个小 demo，我就不去定义实体类了，直接用 Map 来返回 JSON 了。,好啦，大功告成。,最后我们看看过载时的测试效果：,好啦，这就是我们使用 Redis 做限流的方式。