教程:在Django中实现微信授权登录

发布时间:2024年01月16日

教程:在Django中实现微信授权登录

本教程将引导您如何在Django项目中实现微信授权登录。在本教程中,我们将使用自定义的用户模型User,并通过微信提供的API来进行用户认证。

在进行以下教程之前,请确保你已经在微信开放平台添加了网站应用,并获得了:

1.WECHAT_APPID

2.WECHAT_SECRET

3.以及设置了回调域(即认证的网址)

WECHAT_REDIRECT_URI 比如,我的回调域就是:https://www.xxx.com,Django的url中我则写成/wechat/callback/,视图中就可以进行回调使用了,这个没有绝对,重要的是设置自己的网址为回调域

第1步:创建自定义用户模型

首先,在您的Django应用中创建一个自定义的用户模型。在models.py文件中定义模型:

from django.db import models

# 这里一定要继承AbstractUser才行
from django.contrib.auth.models import AbstractUser

class User(AbstractUser):
    # 不需要显式添加id字段,Django会自动创建
    openid = models.CharField(max_length=128, unique=True, null=True, blank=True)
    username = models.CharField(max_length=150, null=True, unique=True)
    # 不需要再次声明password字段,因为AbstractUser类已经包含了password字段
    # email字段已在AbstractUser中定义,只需指定null和blank即可
    email = models.EmailField(null=True, blank=True)
    phone_number = models.CharField(max_length=15, null=True, blank=True)
    real_name = models.CharField(max_length=128, null=True, blank=True)
    creation_date = models.DateTimeField(auto_now_add=True)
    role_type = models.CharField(max_length=50, null=True, blank=True)
    avatar = models.URLField(null=True, blank=True)
    gender = models.CharField(max_length=10, null=True, blank=True)
    birthday = models.DateField(null=True, blank=True)
    address = models.CharField(max_length=255, null=True, blank=True)
    # 新增加的微信字段
    nickname = models.CharField(max_length=64, null=True, blank=True)
    sex = models.PositiveSmallIntegerField(choices=((0, '未知'), (1, '男'), (2, '女')), null=True, blank=True)
    language = models.CharField(max_length=32, null=True, blank=True)
    city = models.CharField(max_length=32, null=True, blank=True)
    province = models.CharField(max_length=32, null=True, blank=True)
    country = models.CharField(max_length=32, null=True, blank=True)
    headimgurl = models.URLField(null=True, blank=True)
    privilege = models.JSONField(default=list, blank=True, null=True)  # 使用可调用的默认值
    unionid = models.CharField(max_length=128, null=True, blank=True)

    # last_login字段已经在AbstractBaseUser中,不需要重复声明

    # 如果你没有特别需要覆盖save()方法,也可以省略这个方法
    # def save(self, *args, **kwargs):
    #     super(User, self).save(*args, **kwargs)

    @classmethod
    def create_or_update_from_wechat(cls, wechat_data):
        user, created = cls.objects.update_or_create(
            openid=wechat_data['openid'],
            defaults={
                'nickname': wechat_data.get('nickname', ''),
                'sex': wechat_data.get('sex', 0),
                'language': wechat_data.get('language', ''),
                'city': wechat_data.get('city', ''),
                'province': wechat_data.get('province', ''),
                'country': wechat_data.get('country', ''),
                'headimgurl': wechat_data.get('headimgurl', ''),
                'privilege': wechat_data.get('privilege', []),
                'unionid': wechat_data.get('unionid', ''),
            }
        )
        return user

第2步:配置settings.py

settings.py文件中进行以下配置:

# 登录认证系统后端,二者任选其一即可
AUTHENTICATION_BACKENDS = [
    'django.contrib.auth.backends.ModelBackend',
    'allauth.account.auth_backends.AuthenticationBackend',
]

# index 是应用的名字,User 是你的自定义用户模型的类名
AUTH_USER_MODEL = 'index.User'

# 用户登录的url名称
LOGIN_URL = "user_login"

# 登录成功调回地址的url名称
LOGIN_REDIRECT_URL = "index"

第3步:实现登录视图

views.py中创建登录视图和微信回调视图:

from django.shortcuts import redirect
from django.conf import settings
import requests
from urllib.parse import quote
from django.http import HttpResponseRedirect
from django.contrib.auth import logout
from django.http import JsonResponse
from .models import User
from django.contrib.auth import login
from django.utils import timezone


def user_login(request):
    appid = settings.WECHAT_APPID
    redirect_uri = quote(settings.WECHAT_REDIRECT_URI)
    url = f"https://open.weixin.qq.com/connect/qrconnect?appid={appid}&redirect_uri={redirect_uri}&response_type=code&scope=snsapi_login&state=STATE#wechat_redirect"
    return HttpResponseRedirect(url)

def logout_view(request):
    logout(request)
    # 重定向到登录页面或者主页
    return redirect('index')

def wechat_login_callback(request):
    code = request.GET.get('code')
    # 利用code获取access_token
    appid = settings.WECHAT_APPID
    secret = settings.WECHAT_SECRET
    url = f'https://api.weixin.qq.com/sns/oauth2/access_token?appid={appid}&secret={secret}&code={code}&grant_type=authorization_code'
    response = requests.get(url)
    data = response.json()
    access_token = data.get('access_token')
    openid = data.get('openid')
    url = f'https://api.weixin.qq.com/sns/userinfo?access_token={access_token}&openid={openid}'
    response = requests.get(url)
    user_info = response.json()
    # 创建或者更新用户信息
    user = User.create_or_update_from_wechat(user_info)
    # 更新 last_login 字段
    user.last_login = timezone.now()
    user.save(update_fields=['last_login'])
    
    # 选择要登录的后端认证系统,这里可以选择Django自带的,也可以选择微信的
    backend = 'django.contrib.auth.backends.ModelBackend'
    # backend = 'allauth.account.auth_backends.AuthenticationBackend'
    user.backend = backend  # 设置用户实例的后端属性
    login(request, user, backend=backend)  # 登录用户,传入backend参数
    
    # 这里我随便写了一个url名称
    return redirect("bbworld")

第4步:配置URLs

urls.py中将路径与视图关联起来:

from django.urls import path
from . import views

urlpatterns = [
    path('login/', views.user_login, name='user_login'),
    path('logout/', views.logout_view, name='logout'),
    path('wechat/callback/', views.wechat_login_callback, name='wechat_callback'),
    # 其他URLs...
]

第5步:使用@login_required装饰器保护视图

在任何需要用户登录的视图前使用@login_required装饰器:

from django.shortcuts import render
from django.contrib.auth.decorators import login_required

@login_required
def bbworld(request):
    return render(request, 'bbworld.html')

第6步:处理未登录的重定向

当用户尝试访问受@login_required保护的页面时,他们将被重定向到在settings.py中定义的LOGIN_URL,然后授权登录成功后反调回LOGIN_REDIRECT_URL = “index”。

在Django中,当您对模型进行了更改之后,例如添加了新的字段或修改了字段的类型,您需要创建一个新的数据库迁移以便将这些更改应用到数据库中。以下是如何进行数据迁移的步骤:

第7步:数据迁移到数据库

这一步也可以建好模型的时候就进行操作,另外,确保setting里面已经设置好了数据库,无论是sqlite还是mysql

python manage.py makemigrations
python manage.py migrate

第8步:运行和测试

运行您的Django项目并测试登录流程。确保所有URLs正确配置,并且重定向和回调都按预期工作。

python manage.py runserver

访问登录URL,并通过微信扫码登录来测试整个流程。

以上就是在Django中实现微信授权登录的基本步骤。

因为这个事情,花了我很多时间,我也希望你能通过我的教程,快速完成业务,如果有不清楚的,欢迎留言咨询,我会第一时间回复,谢谢,祝你也学习愉快!

文章来源:https://blog.csdn.net/weixin_46084533/article/details/135615048
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。