Django REST Framework:ModelViewSet如何拦截特定key返回404并保留标准路由
两种方案的实际可行性评估
1. URL优先级拦截方案
这个方案完全可落地:
- Django的URL路由是严格按照配置从上到下匹配的,只要把
collection/special的路由规则写在collection/<key>动态路由的前面,就会优先命中特定路径,不会走到原来的ModelViewSet逻辑。 - 这个方案需要注意两个核心问题:
- 路由配置顺序一定不能颠倒,如果把动态路由写在前面,
special会被当成普通的key值匹配走原逻辑,拦截直接失效。 - 不要直接用Django默认的HTML格式404页面,作为API返回不符合前后端分离的响应规范。可以直接基于DRF写一个极简的视图,抛出
NotFound异常即可,不用自己手写响应逻辑,示例代码:
from rest_framework.decorators import api_view from rest_framework.exceptions import NotFound @api_view(["GET", "POST", "PUT", "PATCH", "DELETE"]) def special_key_block_view(request): raise NotFound() - 路由配置顺序一定不能颠倒,如果把动态路由写在前面,
- 但这个方案的硬伤是可维护性差:相当于把“某个特定key禁止访问”的业务规则硬编码到了路由层,以后如果调整路由前缀、拆分ViewSet、增加嵌套路由,很容易漏改这个硬编码的规则,长期维护成本高。
2. ViewSet方法重写方案
这个方案同样完全可行,而且是更贴合DRF设计思路的实现方式。很多人不确定重写哪个方法的问题,其实选对入口就能覆盖所有HTTP方法的拦截:
- 不要选
get_object这类仅针对单个资源查询的方法,否则无法拦截list、批量操作这类不需要实例化单对象的请求,覆盖不全。 - 正确的重写位置是
initial方法:这个方法是DRF ViewSet在进入具体action逻辑前的统一前置入口,会在权限校验、参数解析、业务逻辑执行前统一执行,不管是GET/POST/PUT/DELETE任何HTTP方法,只要路由匹配到了这个ViewSet,就一定会走到initial的逻辑,刚好匹配“所有访问都返回404”的需求。 - 实现示例:
from rest_framework.exceptions import NotFound from rest_framework.viewsets import ModelViewSet class CollectionViewSet(ModelViewSet): # 保留你原有所有配置:queryset、serializer_class、filterset等全部不变 def initial(self, request, *args, **kwargs): # 先执行父类的标准初始化逻辑:版本协商、内容协商、权限初步校验等 super().initial(request, *args, **kwargs) # 判断路径参数中的key值 if self.kwargs.get("key") == "special": raise NotFound(detail="资源不存在")
- 这个方案的优势是:所有和这个接口相关的业务规则都和对应的ViewSet绑定,不会散落在路由配置里,耦合度更低,维护成本也更小。
DRF推荐的实现思路
DRF本身的分层设计要求路由层只做“路径-视图”的映射,不承载业务逻辑,因此更推荐在View层做参数拦截的方式:
- 这种方式完全复用DRF自带的异常处理体系,抛出
NotFound异常后,会自动按照项目统一的DRF异常渲染规则返回JSON格式的错误响应,和项目其他接口的错误返回格式完全一致,不需要单独适配404的响应格式。 - 不会因为路由调整导致拦截逻辑失效,所有规则都跟着对应的ViewSet走,逻辑闭环更清晰。
扩展性更强的替代方案
如果后续可能新增更多需要拦截的特殊key,完全可以把这个拦截逻辑抽成可复用的Mixin基类,避免重复写校验代码:
class BlockedKeyMixin: # 子类直接配置需要拦截的key列表即可 blocked_keys = [] def initial(self, request, *args, **kwargs): super().initial(request, *args, **kwargs) if self.kwargs.get("key") in self.blocked_keys: raise NotFound(detail="资源不存在") # 实际业务ViewSet直接继承即可 class CollectionViewSet(BlockedKeyMixin, ModelViewSet): blocked_keys = ["special"] # 原有所有业务配置保持不变
这种方式后续要新增拦截key,只要在对应ViewSet的blocked_keys列表里加值就行,不用改路由,也不用重复写拦截逻辑,灵活性高很多。
内容的提问来源于stack exchange,提问作者Ulrich Schuster
相关产品推荐
相关产品推荐

