Springboot中使用redis進行api限流
阿新 • • 發佈:2019-12-09
api限流的場景
限流的需求出現在許多常見的場景中
- 秒殺活動,有人使用軟體惡意刷單搶貨,需要限流防止機器參與活動
- 某api被各式各樣系統廣泛呼叫,嚴重消耗網路、記憶體等資源,需要合理限流
- 淘寶獲取ip所在城市介面、微信公眾號識別微信使用者等開發介面,免費提供給使用者時需要限流,更具有實時性和準確性的介面需要付費。
api限流實戰
首先我們編寫註解類AccessLimit
,使用註解方式在方法上限流更優雅更方便!三個引數分別代表有效時間、最大訪問次數、是否需要登入,可以理解為 seconds 內最多訪問 maxCount 次。
import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface AccessLimit { int seconds(); int maxCount(); boolean needLogin() default true; }
限流的思路
- 通過路徑:ip的作為key,訪問次數為value的方式對某一使用者的某一請求進行唯一標識
- 每次訪問的時候判斷
key
是否存在,是否count
超過了限制的訪問次數 - 若訪問超出限制,則應
response
返回msg:請求過於頻繁
給前端予以展示
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.web.method.HandlerMethod; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @Component public class AccessLimtInterceptor implements HandlerInterceptor { @Autowired private RedisService redisService; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if (handler instanceof HandlerMethod) { HandlerMethod hm = (HandlerMethod) handler; AccessLimit accessLimit = hm.getMethodAnnotation(AccessLimit.class); if (null == accessLimit) { return true; } int seconds = accessLimit.seconds(); int maxCount = accessLimit.maxCount(); boolean needLogin = accessLimit.needLogin(); if (needLogin) { //判斷是否登入 } String key = request.getContextPath() + ":" + request.getServletPath() + ":" + ip ; Integer count = redisService.get(key); if (null == count || -1 == count) { redisService.set(key, 1); redisService.expire(seconds); return true; } if (count < maxCount) { redisService.inCr(key); return true; } if (count >= maxCount) { // response 返回 json 請求過於頻繁請稍後再試 return false; } } return true; } }
註冊攔截器並配置攔截路徑和不攔截路徑
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; // extends WebMvcConfigurerAdapter 已經廢棄,java 8開始直接繼承就可以 @Configuration public class IntercepterConfig implements WebMvcConfigurer { @Autowired private AccessLimtInterceptor accessLimtInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(accessLimtInterceptor) .addPathPatterns("/攔截路徑") .excludePathPatterns("/不被攔截路徑 通常為登入註冊或者首頁"); } }
在Controller
層的方法上直接可以使用註解@AccessLimit
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("test")
public class TestControler {
@GetMapping("accessLimit")
@AccessLimit(seconds = 3, maxCount = 10)
public String testAccessLimit() {
//xxxx
return "";
}
}