Django REST Framework JWT提供的登錄簽發的視圖

Django REST Framework JWT提供了一個視圖。在我們登錄的時候，會校驗用戶名、密碼是否正確。如果信息無誤，可以返回一個JWT token。就可以簡單地實現了記錄用戶登錄狀態。

用法：

只需要在路由配置一下即可：

from rest_framework_jwt.views import obtain_jwt_token
urlpatterns=[
    ...
    url(r'login$',obtain_jwt_token)
]

這樣就可以實現登錄之后，返回JWT token了。

至於obtain_jwt_token是怎么實現校驗和返回JWT token的功能的呢？

可以看一下源碼，我簡單看了下，原理大體如下：

# 真正起作用的是ObtainJSONWebToken視圖
obtain_jwt_token = ObtainJSONWebToken.as_view()


# (點進ObtainJSONWebToken)
# ObtainJSONWebToken是一個DRF子類視圖
class ObtainJSONWebToken(JSONWebTokenAPIView):
    # JSONWebTokenSerializer先通過django的設置文件獲取到用戶的模型類，然后獲取到模型類的用戶名字段。然后自己建立一個序列化器，包括用戶名、密碼字段。
    serializer_class = JSONWebTokenSerializer


# (點進JSONWebTokenAPIView)
class JSONWebTokenAPIView(APIView):
        def post(self, request, *args, **kwargs):
            # 取得自己建立的序列化器
            serializer = self.get_serializer(data=request.data)
            # 校驗成功后的操作
            if serializer.is_valid():
                user = serializer.object.get('user') or request.user
                token = serializer.object.get('token')
                # response_data就是返回的數據。
                response_data = jwt_response_payload_handler(token, user, request)
                response = Response(response_data)
                ...
                ...
                return response

            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)


# (搜索jwt_response_payload_handler)
# 可以看到jwt_response_payload_handler返回一個字典，包含着JWT token
def jwt_response_payload_handler(token, user=None, request=None):
    """
    Returns the response data for both the login and refresh views.
    Override to return a custom response such as including the
    serialized representation of the User.

    Example:

    def jwt_response_payload_handler(token, user=None, request=None):
        return {
            'token': token,
            'user': UserSerializer(user, context={'request': request}).data
        }

    """
    return {
        'token': token
    }

這就是實現登錄后自動返回token的原理。

 

• 需求&解決

現在有一個需求，登錄成功后，不僅僅返回JWT token，還要返回username和user_id。應該怎么修改呢？

如果認真看上面的源碼，其實已經知道怎么解決了。

就是重寫33行的jwt_response_payload_handler函數。

def jwt_response_payload_handler(token,user=None,request=None):
    return {
        "token":token,
        "id":user.id,
        "username":user.username
    }

因為重寫了方法，要應用我們自定義的方法，需要在django上進行設置。

JWT_AUTH = {
    ...
    'JWT_RESPONSE_PAYLOAD_HANDLER': 'user.utils.jwt_response_payload_handler',  # 應用登錄返回token的自定義方法
}