本文档介绍了如何在 Django 项目中使用 python-social-auth 库，通过自定义字段（例如 Telegram ID）将社交账号与用户模型关联。我们将创建一个自定义的 pipeline，在用户通过 Telegram 登录时，根据 telegram_id 字段查找已存在的用户，并将其与社交账号关联，从而避免创建重复用户。
通过自定义字段关联社交账号
在使用 python-social-auth 进行社交登录时，默认情况下，它会尝试通过 email 或 username 关联用户。但是，在某些情况下，我们需要使用自定义字段进行关联，例如 Telegram ID。以下步骤将指导你如何实现这一目标。
1. 定义用户模型
首先，确保你的用户模型包含你想要用于关联的自定义字段。在这个例子中，我们使用 telegram_id 字段。
import uuid
from django.contrib.auth.models import AbstractUser
from django.db import models
class Profile(AbstractUser):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
telegram_id = models.BigIntegerField(verbose_name='Telegram ID', unique=True, blank=True, null=True)
def __str__(self):
return self.username确保运行 python manage.py makemigrations 和 python manage.py migrate 来更新数据库结构。
2. 创建自定义 Pipeline
接下来，创建一个自定义的 pipeline 函数，用于根据 telegram_id 关联用户。
from django.contrib.auth import get_user_model
from social_core.exceptions import AuthException
def associate_by_telegram_id(backend, details, user=None, *args, **kwargs):
if backend.name == 'telegram':
if user:
return None
tgid = kwargs.get('uid')
if tgid:
try:
tgid = int(tgid)
except ValueError:
return None # Or raise an exception
UserModel = get_user_model()
users = list(UserModel.objects.filter(telegram_id=tgid))
if len(users) == 0:
return None
elif len(users) > 1:
raise AuthException(
backend, "The given Telegram ID is associated with another account"
)
else:
return {"user": users[0], "is_new": False}这个 pipeline 函数做了以下事情：
- 检查当前 backend 是否是 Telegram。
- 如果已经存在用户，则跳过。
- 获取 Telegram ID (tgid)。
- 在用户模型中查找具有相同 telegram_id 的用户。
- 如果找到一个用户，则返回该用户，并设置 is_new 为 False。
- 如果找到多个用户，则抛出异常。
- 如果没有找到用户，则返回 None，让后续的 pipeline 处理。
注意事项：
- 在将 kwargs.get('uid') 转换为整数时，需要进行错误处理，以防止 ValueError 异常。
- 确保你的用户模型字段名称与 pipeline 中使用的名称一致（例如 telegram_id）。
3. 配置 Social Auth Pipeline
现在，将自定义的 pipeline 添加到 SOCIAL_AUTH_PIPELINE 设置中。
SOCIAL_AUTH_PIPELINE = (
'social_core.pipeline.social_auth.social_details',
'social_core.pipeline.social_auth.social_uid',
'social_core.pipeline.social_auth.social_user',
'social_core.pipeline.user.get_username',
'your_app.pipelines.associate_by_telegram_id', # 替换为你的 pipeline 路径
'social_core.pipeline.social_auth.associate_by_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',
)确保将 'your_app.pipelines.associate_by_telegram_id' 替换为你的 pipeline 函数的实际路径。 该pipeline应该在associate_by_email之前，create_user之前执行。
4. 验证配置
配置完成后，尝试使用 Telegram 登录。如果一切配置正确，当用户使用已存在 telegram_id 的 Telegram 账号登录时，将会自动关联到对应的用户，而不会创建新的用户。
总结
通过创建自定义的 pipeline 函数，我们可以灵活地控制 python-social-auth 的用户关联逻辑，从而满足各种自定义需求。 在本例中，我们展示了如何通过 telegram_id 字段关联 Telegram 账号，你可以根据自己的需求修改 pipeline 函数，使用其他自定义字段进行关联。 记住，仔细测试你的 pipeline，确保它在各种情况下都能正常工作。
