social-auth-app-django 自定义 token 参数|极客教程

social-auth-app-django 自定义 token 参数

在使用social-auth-app-django这个Django第三方库时，我们经常需要使用社交登录来进行用户认证。在这个过程中，social-auth-app-django会为每个登录的用户生成一个默认的access token，用于标识用户的身份。然而，有时候我们需要自定义这个access token，以满足特定需求。本文将详细介绍如何在social-auth-app-django中自定义token参数。

为什么需要自定义token参数

在实际开发中，我们可能需要为用户生成一个特定格式或特定长度的token，以便于后续的身份验证或者权限控制。例如，我们可能需要将用户的id和用户名组合在一起生成一个token，以确保其唯一性。或者我们可能需要将token的有效期设置为一定的时长。这时，我们就需要自定义token参数。

social-auth-app-django 中的Token创建逻辑

在social-auth-app-django中，默认生成的access token是一个随机生成的字符串。这个token是通过social_core.backends.utils中的handle_token函数生成的。在这个函数中，默认的token生成逻辑如下：

def handle_token(request_backend, user=None, social=None, *args, **kwargs):
    response = kwargs.get('response')
    backend = kwargs.get('backend')

    token = None
    if response:
        access_token = response.get('access_token')
        if backend.get('REDIRECT_STATE') and 'state' in request.session:
            token = request.session.pop('state')
    else:
        token = kwargs.get('request_token') or kwargs.get('oauth_token')

    if user and not token:
        try:
            token = social.extra_data.get('access_token')
        except AttributeError:
            pass

    if token:
        do_return = False
        tkn, tkn_created = Token.objects.get_or_create(
            token=token, defaults=dict(
                user=user, app=social_app
            )
        )

        # Do more stuff with the token, e.g. store additional data in the token object

        if tkn_created:
            do_return = 'new'  # Custom signal flag
        elif tkn.expired:
            tkn.renew()
            do_return = 'renewed'

        if do_return or getattr(tkn, 'refreshed', False):
            return tkn, do_return

    return token, None

通过查看这段代码，我们可以看到handle_token函数针对不同的情况提供了不同的token生成方式。在用户登录成功后，handle_token函数会创建一个Token对象，并返回这个Token对象。在这个过程中，我们可以根据自己的需求对token进行进一步的处理。

自定义Token参数

要自定义Token参数，我们可以继承social_core.backends.base.BaseAuth类，并重写get_user_details和auth_complete方法。具体步骤如下：

创建一个自定义的backend，在social_core/backends目录下新建一个文件custom_backend.py，并输入以下代码：

from social_core.backends.base import BaseAuth

class CustomBackend(BaseAuth):

    def get_user_details(self, response):
        # 获取用户信息
        user = super(CustomBackend, self).get_user_details(response)
        # 在这里自定义token的生成逻辑
        user['token'] = response['token']
        # 返回用户信息
        return user

    def auth_complete(self, *args, **kwargs):
        # 认证完成时的逻辑
        user = kwargs['user']
        # token的生成代码
        user.token = 'custom_token'
        return user

将创建的自定义backend添加到SOCIAL_AUTH_AUTHENTICATION_BACKENDS配置中，在settings.py中添加以下配置：

SOCIAL_AUTH_AUTHENTICATION_BACKENDS = (
    'path.to.CustomBackend',
    'social_core.backends.facebook.FacebookOAuth2',
    'social_core.backends.google.GoogleOAuth2',
    'social_core.backends.twitter.TwitterOAuth',
)

最后，在views.py中处理登录成功后的逻辑，获取自定义的token参数，并对其进行处理：

def social_login(request):
    # 处理社交登录成功后的逻辑
    if request.user.is_authenticated:
        social = request.user.social_auth.get(provider='custom')
        token = social.extra_data.get('token')

        # 对token进行处理
        # ...

    return HttpResponse('Social Login Success')