django-rest-social-auth partial pipeline使用及邮箱自定义恢复问题

1. 先确认Partial Pipeline基础配置 #

首先得保证settings.py里的管道配置和partial支持都正确：

SOCIAL_AUTH_PIPELINE = (
    # 保留默认前置步骤
    'social_core.pipeline.social_auth.social_details',
    'social_core.pipeline.social_auth.social_uid',
    'social_core.pipeline.social_auth.auth_allowed',
    'social_core.pipeline.social_auth.social_user',
    # 插入你的自定义中断步骤，用来收集邮箱
    'your_app.pipeline.require_email',  # 替换成你自己的管道函数路径
    # 后续默认步骤
    'social_core.pipeline.user.create_user',
    'social_core.pipeline.social_auth.associate_user',
    'social_core.pipeline.social_auth.load_extra_data',
    'social_core.pipeline.user.user_details',
)

# 开启partial pipeline支持
SOCIAL_AUTH_PARTIAL_PIPELINE_KEY = 'partial_pipeline_key'
SOCIAL_AUTH_ENABLED_BACKENDS = ['google', 'facebook']  # 替换成你用的社交登录后端

你的自定义require_email函数要注意返回JSON响应（而不是重定向），让前端知道需要收集邮箱：

import json
from django.http import HttpResponse
from social_core.pipeline.partial import partial

@partial
def require_email(strategy, details, user=None, is_new=False, *args, **kwargs):
    # 仅对新用户且无邮箱的情况中断管道
    if is_new and not details.get('email'):
        # 保存当前管道的部分状态
        partial_token = strategy.partial_save()
        # 返回JSON告知前端需要输入邮箱，并传递恢复管道的token
        return HttpResponse(
            json.dumps({
                'status': 'needs_email',
                'partial_token': partial_token
            }),
            content_type='application/json'
        )
    # 不需要中断则继续管道
    return None

2. 自定义Complete视图，适配JWT场景 #

默认的/complete/视图是为web重定向设计的，我们需要写一个API友好的视图来恢复管道并返回JWT，而不是跳转到页面：

在你的app的views.py中添加：

from django.http import JsonResponse
from social_django.utils import psa
from rest_framework_social_oauth2.views import SocialTokenView
from social_core.exceptions import AuthException

@psa('social:complete')
def custom_social_complete(request, backend):
    # 从请求体获取前端传来的partial token和用户输入的邮箱
    partial_token = request.data.get('partial_token')
    email = request.data.get('email')
    
    if not partial_token or not email:
        return JsonResponse({'error': '缺少partial_token或邮箱参数'}, status=400)
    
    try:
        # 加载之前保存的管道状态
        strategy = request.strategy
        partial = strategy.partial_load(partial_token)
        # 更新用户邮箱信息到管道的details中
        partial['details']['email'] = email
        # 继续执行剩余的管道流程
        user = strategy.complete(backend, request, partial=partial)
    except AuthException as e:
        return JsonResponse({'error': f'认证失败: {str(e)}'}, status=400)
    
    # 用户创建/关联成功后，生成JWT token
    if user and user.is_active:
        # 复用rest_framework_social_oauth2的token生成逻辑
        token_view = SocialTokenView.as_view()
        mock_request = request._request
        mock_request.user = user
        response = token_view(mock_request)
        return response
    
    return JsonResponse({'error': '用户认证失败'}, status=401)

然后在urls.py中配置这个自定义视图，替换默认的complete路由：

from django.urls import path
from your_app.views import custom_social_complete

urlpatterns = [
    # 其他API路由...
    path('api/login/social/jwt/complete/<str:backend>/', custom_social_complete, name='custom_social_complete'),
    # 保留你原来的JWT登录路由
    path('api/login/social/jwt/', ...),
]

3. 前端调整请求逻辑 #

当前端收到needs_email的响应时，弹出邮箱输入表单；用户提交后，调用我们自定义的/api/login/social/jwt/complete/<backend>/接口，携带partial_token和email参数，就能恢复管道并直接获取JWT，不会触发重定向。

4. 可选：关闭默认重定向配置 #

如果还是有重定向干扰，可以在settings.py中添加：

# API场景下禁用登录重定向
SOCIAL_AUTH_LOGIN_REDIRECT_URL = None

关键提醒 #

• 自定义管道函数一定要返回JSON响应，不能用重定向，否则前端无法识别中断状态。
• partial token是恢复管道的唯一标识，必须保证前端正确传递这个参数。
• 自定义complete视图要处理管道的加载、更新邮箱、继续执行，最终返回JWT，完全适配API场景。

内容的提问来源于stack exchange，提问作者Tiger