自定义Django_rest_framework_jwt登录错误返回的解决

Django JWT登录自定义返回概述

在使用Django构建前后端分离项目时，登录认证通常采用jwt_token方案。然而，默认的返回格式可能无法满足特定业务需求，因此需要自定义登录成功和失败时的响应体结构。

登录成功返回体自定义

当用户名和密码验证通过时，系统会生成token并返回响应。这一过程默认调用的是JWT_RESPONSE_PAYLOAD_HANDLER函数。若需自定义返回内容，必须重写jwt_response_payload_handler函数以覆盖默认行为。

在项目根目录下的settings.py配置文件中，添加JWT_RESPONSE_PAYLOAD_HANDLER配置项，指向自定义的处理函数路径。

JWT_AUTH = {
  'JWT_EXPIRATION_DELTA': datetime.timedelta(seconds=6000),
  'JWT_RESPONSE_PAYLOAD_HANDLER': 'Users.views.jwt_response_payload_handler',  # 后面跟着你视图里定义函数
}

接下来，需要自定义一个视图函数jwt_response_payload_handler，用于处理登录成功后的数据返回逻辑。

def jwt_response_payload_handler(token, user=None, request=None):
  """
  设置jwt登陆返回的格式
  :param token:
  :param user:
  :param request:
  :return:
  """
  return {
    "msg": "success",
    "status": 200,
    "data": [{
    	# data自定义你接口想返回的信息
      'token': token,
      'username': user.username
    }]
  }

配置完成后，登录成功的效果如下所示：

登录失败错误返回处理

当Django中JWT验证失败时，默认返回的是{"non_field_errors":["无法使用提供的认证信息登录。"]}。此时，系统不会调用jwt_response_payload_handler，而是通过其他机制处理错误。具体而言，失败时调用的是JWT_RESPONSE_PAYLOAD_ERROR_HANDLER函数。需要注意的是，该功能可能未合并至master分支，因此需要手动进行代码合并操作。

打开/usr/local/lib/python3.6/site-packages/rest_framework_jwt/settings.py文件，在IMPORT_STRINGS列表中添加JWT_RESPONSE_PAYLOAD_ERROR_HANDLER配置项，以启用错误处理机制。

在/usr/local/lib/python3.6/site-packages/rest_framework_jwt/views.py文件中，需对相关逻辑进行修改：

错误处理函数实现与配置

在自定义视图中，编写一个jwt_response_payload_error_handler函数，专门处理登录失败时的错误信息返回。

def jwt_response_payload_error_handler(serializer, request = None):
  return {
    "msg": "用户名或者密码错误",
    "status": 400,
    "detail": serializer.errors
  }

最后，在项目的settings.py文件的JWT配置块中，添加上述错误返回函数的引用：

# jwt_token配置
JWT_AUTH = {
  'JWT_EXPIRATION_DELTA': datetime.timedelta(seconds=6000),
  # 登陆成功自定义 的返回结构
  'JWT_RESPONSE_PAYLOAD_HANDLER': 'Users.views.jwt_response_payload_handler',
  # 登陆失败时自定义的返回结构
  'JWT_RESPONSE_PAYLOAD_ERROR_HANDLER': 'Users.views.jwt_response_payload_error_handler',
}

完成以上配置后，最终的返回结构如下所示：

至此，关于自定义Django_rest_framework_jwt登录错误返回的解决方案介绍完毕。如需了解更多相关Django_rest_framework_jwt登录错误处理内容，建议搜索本站历史文章或继续浏览后续相关文章。感谢大家的支持！