Django python-social-auth 无法获取正确的 Google OAuth2 详情

在本文中，我们将介绍在使用 Django python-social-auth 库时可能遇到的问题，特别是在使用 Google OAuth2 登录时无法获取到正确的用户详细信息的问题。

问题描述

Django python-social-auth 是一个用于在 Django 中实现第三方登录认证的库。它支持多个第三方登录提供商，包括 Google、Facebook、Twitter 等。然而，在绑定 Google OAuth2 登录时，有一些用户报告无法正确获取到用户的详细信息，例如电子邮件地址、头像等。

原因分析

该问题的根本原因是由于 Google OAuth2 更改了其 API 的权限要求。以前，可以使用一个简单的查询参数 access_type=offline 来获取用户的电子邮件地址和其他详细信息。然而，谷歌在更新后，要求应用程序使用 Google People API 来获取此类详细信息。

与此同时，Django python-social-auth 还没有完全适应这些更改，因此在请求用户详细信息时可能会遇到问题。

解决方法

步骤 1: 在 Google 开发者控制台启用 People API

首先登录到 Google 开发者控制台，进入你的项目。然后，找到 “API 与服务”，在库中搜索 “People API”。点击启用该 API。

步骤 2: 配置 Django settings.py

在 Django 项目的 settings.py 文件中，需要进行以下设置：

SOCIAL_AUTH_GOOGLE_OAUTH2_SCOPE = [
    'https://www.googleapis.com/auth/userinfo.profile',
    'https://www.googleapis.com/auth/userinfo.email',
]

这将确保我们请求的权限包括用户信息和电子邮件地址。

步骤 3: 更新 Django python-social-auth

在之前的版本中，python-social-auth 使用的 Google OAuth2 后端是 social_core.backends.google.GoogleOAuth2。但是，该后端没有适应新的 Google API 更改。

现在，我们需要切换到 social_core.backends.google.GoogleOAuth2PeopleAPI 后端。在 Django settings.py 文件中进行以下更改：

SOCIAL_AUTH_GOOGLE_OAUTH2_BACKEND = 'social_core.backends.google.GoogleOAuth2PeopleAPI'

步骤 4: 运行迁移

如果你更新了 python-social-auth，请确保运行 python manage.py migrate 命令，以应用可能的数据库更改。

步骤 5: 重新测试

现在，重新运行你的 Django 项目，并尝试使用 Google OAuth2 登录。你将能够获取到用户的详细信息，包括电子邮件地址、头像等。

示例

以下是一个简单的 Django 视图函数代码示例，用于演示在使用 Django python-social-auth 时如何获取用户的详细信息：

from social_django.utils import load_strategy

def get_user_details(request):
    strategy = load_strategy(request)

    user = request.user
    user_social = user.social_auth.get(provider='google-oauth2')

    # 获取用户的电子邮件地址
    email = user_social.extra_data.get('email')
    print('Email:', email)

    # 获取用户的头像 URL
    picture_url = user_social.extra_data.get('picture')
    print('Picture URL:', picture_url)

    # 其他用户详细信息
    # ...

    # 返回响应
    # ...

这里使用 load_strategy() 函数加载策略，并从当前用户的 social_auth 实例中获取 Google OAuth2 后端的额外数据。你可以根据需求使用这些额外数据进行其他操作，例如显示用户的电子邮件地址和头像。

总结

本文介绍了在使用 Django python-social-auth 时可能遇到的问题，特别是在使用 Google OAuth2 登录时无法获取到正确的用户详细信息的情况。我们探讨了问题的原因，并提供了解决方案。通过启用 Google People API 并更新 Django python-social-auth 配置，我们能够成功获取到用户的电子邮件地址和其他详细信息。希望本文能帮助你解决类似的问题，并顺利使用 Django python-social-auth 实现第三方登录。