Django RestFramework 全局异常处理

该博客介绍了如何在Django REST framework中定义并注册自定义的异常处理类,用于处理如数据库和Redis等特定异常,并提供详细的错误日志记录。通过设置`EXCEPTION_HANDLER`,确保在发生错误时返回统一格式的响应,同时保持系统的稳定运行。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

REST framework定义的异常

  • APIException 所有异常的父类
  • ParseError 解析错误
  • AuthenticationFailed 认证失败
  • NotAuthenticated 尚未认证
  • PermissionDenied 权限决绝
  • NotFound 未找到
  • MethodNotAllowed 请求方式不支持
  • NotAcceptable 要获取的数据格式不支持
  • Throttled 超过限流次数
  • ValidationError 校验失败

1定义异常处理类

from django.http import JsonResponse
from rest_framework.views import exception_handler as drf_exception_handler
import logging
from django.db import DatabaseError
from redis.exceptions import RedisError
import traceback

# 获取在配置文件中定义的logger,用来记录日志
logger = logging.getLogger('django')


def exception_handler(exc, context):
    """
    自定义异常处理
    :param exc: 异常
    :param context: 抛出异常的上下文(包含request请求对象和view视图对象)
    :return: Response响应对象
    """
    # 调用drf框架原生的异常处理方法
    
    response = drf_exception_handler(exc, context)
    if response is not None:
    	logger.info('REST_FRAMEWORK处理异常')
    	# 使用自定义封装好的方法处理数据格式并返回给前端
        return response_util.success(response)

    view = context['view']
    # 打印异常类以及异常的文本信息
    logger.error('[%s] %s' % (view, exc))
    returnData = {
        'code': 500,
        'msg': '服务器错误',
        'data': ""
    }
    # 捕获其他异常,直接返回 500
    if isinstance(exc, DatabaseError) or isinstance(exc, RedisError):
        # 数据库异常,使用traceback.format_exc()可以像系统报错没拦截那样子打印详细错误信息又不会导致程序停止
        logger.error(f'其他未知错误:{traceback.format_exc()}')
        # 使用django原生的响应对象返回,不能用DRF框架的响应对象
        return JsonResponse(data=returnData, status=500)
    else:
        # 打印错误详细信息
        logger.error(f'其他未知错误:{traceback.format_exc()}')
        # 使用django原生的响应对象返回,不能用DRF框架的响应对象
        return JsonResponse(data=returnData, status=500)

2 注册DRF框架中默认的错误处理为自己定义的类

在settings.py文件中定义

REST_FRAMEWORK = {
    # 异常处理
    'EXCEPTION_HANDLER': 'meiduo_service.utils.excepitons.exception_handler',
}

修改django默认处理了错误对象类似,将错误处理对象改为用中间件即可,处理的逻辑思路一样,不过类以及设置方法不一样而已

<think>嗯,用户想了解如何在Django REST框架中自定义权限类。我需要先回忆一下DRF的权限系统是怎么工作的。记得DRF的权限类是通过继承BasePermission类,然后实现has_permission或者has_object_permission方法。用户可能需要知道具体的步骤和示例。 首先,我应该解释为什么需要自定义权限类。比如默认的权限类可能不够,比如IsAuthenticated或者IsAdminUser不能满足具体需求,比如需要对象级别的权限,或者基于某些业务逻辑的判断。 接下来,要分步骤说明如何创建自定义权限类。可能需要先导入BasePermission,然后创建子类,并重写必要的方法。比如,has_permission用于全局权限检查,而has_object_permission用于对象级别的检查。要提醒用户注意两者的区别和使用场景。 然后,给出一个简单的例子,比如检查用户是否是对象的所有者。这时候需要在has_object_permission中比较request.user和对象的user字段。示例代码需要清晰,展示如何返回True或False。 另外,可能需要提到如何将自定义权限类应用到视图上,比如在视图的permission_classes属性中设置。还要注意权限类的顺序,因为DRF会按顺序检查,直到有一个拒绝为止。 用户可能还会想知道如何在多个视图中复用这个权限类,或者如何组合多个权限。比如,结合IsAuthenticated和自定义类,确保用户先登录再检查其他条件。 可能还需要提醒一些常见的注意事项,比如权限类中的request.user是否存在,处理匿名用户的情况,避免抛出异常,而是返回False。此外,权限类应保持简单,只做权限判断,不处理业务逻辑。 有没有其他常见的自定义权限场景?比如基于用户组、IP地址、或者时间等因素的权限。可以简要举例说明,让用户有更全面的理解。 最后,确保语言简洁,步骤明确,示例易懂。可能需要检查是否有遗漏的关键点,比如权限缓存、或者如何测试自定义权限类。不过用户可能暂时不需要太深入的内容,保持回答重点突出即可。</think>在 Django REST Framework (DRF) 中,自定义权限类可以让你灵活地控制 API 的访问权限。以下是实现自定义权限类的步骤和示例: --- ### **1. 权限类的作用** DRF 的权限类用于决定用户是否有权访问某个视图或对象。常见的场景包括: - 基于用户角色(如管理员、普通用户)限制操作 - 根据请求方法(GET/POST/PUT等)动态调整权限 --- ### **2. 自定义权限类的实现步骤** #### **步骤 1:继承 `BasePermission` 类** 创建一个继承自 `rest_framework.permissions.BasePermission` 的类,并实现以下方法之一: - `has_permission(self, request, view)`: 检查**整个视图**的访问权限(如列表请求)。 - `has_object_permission(self, request, view, obj)`: 检查**单个对象**的访问权限(如详情页操作)。 #### **步骤 2:编写权限逻辑** 在方法中返回 `True`(允许访问)或 `False`(拒绝访问)。 #### **步骤 3:在视图中应用权限类** 通过视图的 `permission_classes` 属性绑定自定义权限类。 --- ### **3. 示例代码** #### **示例 1:检查用户是否为对象所有者** ```python from rest_framework import permissions class IsOwner(permissions.BasePermission): # 对象级权限检查(针对单个对象的操作,如 retrieve/update/delete) def has_object_permission(self, request, view, obj): # 允许所有读请求(如 GET/HEAD/OPTIONS) if request.method in permissions.SAFE_METHODS: return True # 写操作需要检查用户是否为对象所有者 return obj.owner == request.user ``` #### **示例 2:自定义基于角色的权限** ```python class IsAdminOrReadOnly(permissions.BasePermission): # 全局权限检查(针对整个视图) def has_permission(self, request, view): # 允许所有读请求 if request.method in permissions.SAFE_METHODS: return True # 写操作需要管理员权限 return request.user and request.user.is_staff ``` --- ### **4. 在视图中使用自定义权限** 将自定义权限类添加到视图的 `permission_classes` 中: ```python from rest_framework import viewsets from .models import Article from .serializers import ArticleSerializer from .permissions import IsOwner, IsAdminOrReadOnly class ArticleViewSet(viewsets.ModelViewSet): queryset = Article.objects.all() serializer_class = ArticleSerializer # 组合多个权限类 permission_classes = [permissions.IsAuthenticated, IsOwner] class AdminArticleViewSet(viewsets.ModelViewSet): queryset = Article.objects.all() serializer_class = ArticleSerializer permission_classes = [IsAdminOrReadOnly] ``` --- ### **5. 关键注意事项** 1. **权限检查顺序**:DRF 按 `permission_classes` 列表顺序检查权限,遇到第一个 `False` 会立即拒绝。 2. **匿名用户处理**:检查 `request.user` 是否存在(如 `if request.user.is_authenticated`)。 3. **SAFE_METHODS**:`permissions.SAFE_METHODS` 包含只读方法(GET/HEAD/OPTIONS),常用于允许公共读取。 4. **组合权限**:可通过逻辑运算符(如 `and`/`or`)组合多个条件。 --- ### **6. 高级场景** - **动态权限**:根据请求参数或用户属性动态调整权限。 - **第三方集成**:结合 LDAP、OAuth 等外部权限系统。 - **缓存优化**:对频繁检查的权限结果进行缓存(需谨慎处理时效性)。 通过自定义权限类,你可以精确控制 API 的访问规则,灵活适应业务需求。如果需要更复杂的逻辑,可以结合 DRF 的[官方文档](https://www.django-rest-framework.org/api-guide/permissions/)进一步扩展。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值