限流,就是限制对 API 的调用频率。每一次 API 调用,都要花费服务器的资源,因此很多 API 不会对用户无限次地开放,请求达到某个次数后就不再允许访问了,或者一段时间内,最多只允许访问 API 指定次数。**
django-rest-framework 为我们提供了 2 个常用的限流功能辅助类,分别是 AnonRateThrottle 和 - UserRateThrottle。
AnonRateThrottle 用于限制未认证用户的访问频率,限制依据是用户的 ip。
UserRateThrottle 用于限定认证用户,即网站的注册用户(目前我们博客不支持用户登录注册,所以这个类没什么用)。两个类可以用于同一 API,以便对不同类型的用户实施不同的限流政策。
AnonRateThrottle 和 UserRateThrottle 这两个辅助类限制频率的指定格式为 “最大访问次数/时间间隔”,例如设置为 10/min,则只允许一分钟内最多调用接口 10 次。
超过限定次数的调用将抛出 exceptions.Throttled 异常,客户端收到 429 状态码(too many requests)的响应。
接口名 | URL | 限流 |
---|---|---|
文章列表 | /api/posts/ | 10/min |
文章详情 | /api/posts/:id/ | 10/min |
分类列表 | /categories/ | 10/min |
标签列表 | /tags/ | 10/min |
归档日期列表 | /posts/archive/dates/ | 10/min |
评论列表 | /api/posts/:id/comments/ | 10/min |
文章搜索结果 | /api/search/ | 5/min |
单个视图的设置会覆盖全局设置。因为几乎所有接口都是对匿名用户限流,因此先来进行全局设置。在项目配置文件 settings.py 中找到 REST_FRAMEWORK 配置项,加入如下配置:
REST_FRAMEWORK = {
'DEFAULT_THROTTLE_CLASSES': [
'rest_framework.throttling.AnonRateThrottle',
],
'DEFAULT_THROTTLE_RATES': {
'anon': '10/min',
}
}
这样,所有接口访问频率均被设置为 10/min。
对于搜索接口,我们制定的限流规则是 5/min,因此我们对这个视图集的限流类进行单独设置。
因为全局配置中,默认设置的限流频率为 10/min,为了将限流类的默认频率设置为 5/min,我们需要继承原限流类覆盖它的 THROTTLE_RATES 属性,代码非常简单:
# 在views.py视图函数里添加
from rest_framework.throttling import AnonRateThrottle
class PostSearchAnonRateThrottle(AnonRateThrottle):
THROTTLE_RATES = {
"anon": "5/min"}
接着在搜索接口的视图集中通过 throttle_classes 指定这个限流类:
class PostSearchView(HaystackViewSet):
index_models = [Post]
serializer_class = PostHaystackSerializer
throttle_classes = [PostSearchAnonRateThrottle]
HTTP 429 Too Many Requests
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Retry-After: 52
Vary: Accept
{
"detail": "请求超过了限速。 Expected available in 52 seconds."
}
HTTP 429 Too Many Requests
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Retry-After: 26
Vary: Accept
{
"detail": "请求超过了限速。 Expected available in 26 seconds."
}
如果搜索功能依赖 Elasticsearch 服务,因此测试接口时需要运行 Docker 容器,可参考 基于 drf-haystack 实现文章搜索接口。