Django实现小程序的登录验证功能，并维护登录态

这次自己做了一个小程序来玩，在登录方面一直有些模糊，网上看了很多文档后，得出以下一种解决方案。

环境说明：

1、小程序只需要拿到openid，其他信息不存储。

2、Django自带的User类不适合。

具体操作流程：

1、用户点进小程序，就调用wx.login()获取临时登录凭证code, wx.login()用户是无感知的，

2、通过wx.request()将code传到开发者服务器的后台程序，

3、后台拿到code之后，调用微信提供的接口，获取openid和session_key，

4、后台自定义User表，将openid作为用户名，不设置用户密码，如果用户不存在，则创建新用户，接着根据openid和session_key生成新的自定义登录态3rd_session(这里使用skey表示)返回给小程序，

5、后台将skey存入缓存中(Redis)，设置为2小时过期，

6、小程序接收到skey,说明登录成功，将skey保存到本地Storage中，下次请求时，在请求头中携带skey，

7、后台接收到请求，从请求头中拿到skey，判断缓存中是否还有此skey，如果有，说明还在登录态，允许执行请求相关操作，如果没有，说明需要重新登录，给小程序返回401.

第三方库： Django、Djando rest framework、Django-redis

用户信息

自定义User类

models.py

from django.db import models
from django.utils import timezone


class User(models.Model):
    openid = models.CharField(max_length=50, unique=True)
    created_date = models.DateTimeField(auto_now_add=True)
复制代码

User接口序列化

serializers.py

from rest_framework import serializers
from django.utils import timezone
from .models import User


class UserSerializer(serializers.ModelSerializer):

    class Meta:
        model = User
        fields = '__all__'
复制代码

登录接口设计

views.py

import hashlib
import json
import requests
from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response
from django_redis import get_redis_connection

from .models import User
from .serializers import UserSerializer


@api_view(['POST'])
def code2Session(request):
    appid = ''
    secret = ''
    js_code = request.data['code']
    url = 'https://api.weixin.qq.com/sns/jscode2session' + '?appid=' + appid + '&secret=' + secret + '&js_code=' + js_code + '&grant_type=authorization_code'
    response = json.loads(requests.get(url).content)  # 将json数据包转成字典
    if 'errcode' in response:
        # 有错误码
        return Response(data={'code':response['errcode'], 'msg': response['errmsg']})
    # 登录成功
    openid = response['openid']
    session_key = response['session_key']
    # 保存openid, 需要先判断数据库中有没有这个openid
    user, created = User.objects.get_or_create(openid=openid)
    user_str = str(UserSerializer(user).data)
    # 生成自定义登录态，返回给前端
    sha = hashlib.sha1()
    sha.update(openid.encode())
    sha.update(session_key.encode())
    digest = sha.hexdigest()
    # 将自定义登录态保存到缓存中, 两个小时过期
    conn = get_redis_connection('default')
    conn.set(digest, user_str, ex=2*60*60)
    
    return Response(data={'code': 200, 'msg': 'ok', 'data': {'skey': digest})
复制代码

其中，redis的安装，配置与使用，可以参考这篇文档。

登录后，返回skey给小程序端，小程序保存到本地，下次请求携带skey。

用户登录认证

因为我的User类是自定义的，skey也是自定义的，没有使用token或者jwt等技术，这里就需要自定义登录认证了，在执行视图里相应的请求处理函数前，先对skey做判断，判断通过就从skey中取得openid的值。

我在这里考虑了几种方法：

1、利用Django中间件，

2、利用装饰器,

3、利用rest_framework的认证类,

这里先分析Django的请求处理流程:

从上图也可以看出，在中间件中做认证，完全是可行的，认证不通过就可以直接返回了，不用到达路由映射表和视图。但是rest_framework中，对request进行了封装，中间件中的request是django的HttpRequest，而rest_framework将django的request封装成rest_framework的Request。

如果是装饰器的话，在本次设计中不够灵活，因为除了登录接口，其他接口的每个method都需要做认证。

所以综合考虑，自定义一个rest_framework的认证类是最适合这次小程序的验证的，在认证类中设置request.user，然后在视图中就可以通过request.user直接获取用户信息了。

接下来，先分析一下rest_framework的源码，看看是怎么做认证的。

从上图源码分析中，可以看出最后是调用了认证类的认证方法：authenticator.authenticate(). 然后先看看rest_framework自带的认证类，在rest_framework.authentication中，

接下来就自定义一个适用于本次小程序设计的认证类： 新建authentication.py文件

from rest_framework import exceptions
from rest_framework.authentication import BaseAuthentication
from django_redis import get_redis_connection


class UserAuthentication(BaseAuthentication):
    def authenticate(self, request):
        if 'HTTP_SKEY' in request.META:
            skey = request.META['HTTP_SKEY']
            conn = get_redis_connection('default')
            if conn.exists(skey):
                user = conn.get(skey)  
                return (user, skey)
            else:
                raise exceptions.AuthenticationFailed(detail={'code': 401, 'msg': 'skey已过期'})
        else:
            raise exceptions.AuthenticationFailed(detail={'code': 400, 'msg': '缺少skey'})

    def authenticate_header(self, request):
        return 'skey'
复制代码

最后利用全局设置DEFAULT_AUTHENTICATION_CLASSE将UserAuthentication设置为全局使用，同时登录接口应该设计为不使用认证类，将登录接口添加两行代码。

settings.py文件：

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'note.authentication.UserAuthentication',  # 用自定义的认证类
    ),
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    ),
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework.parsers.JSONParser',
    ),
}
复制代码

登录接口

import hashlib
import json
import requests
from rest_framework import status
from rest_framework.decorators import api_view, authentication_classes
from rest_framework.response import Response
from django_redis import get_redis_connection

from .models import User
from .serializers import UserSerializer


@api_view(['POST'])
@authentication_classes([])  # 添加
def code2Session(request):
    appid = ''
    secret = ''
    js_code = request.data['code']
    url = 'https://api.weixin.qq.com/sns/jscode2session' + '?appid=' + appid + '&secret=' + secret + '&js_code=' + js_code + '&grant_type=authorization_code'
    response = json.loads(requests.get(url).content)  # 将json数据包转成字典
    if 'errcode' in response:
        # 有错误码
        return Response(data={'code':response['errcode'], 'msg': response['errmsg']})
    # 登录成功
    openid = response['openid']
    session_key = response['session_key']
    # 保存openid, 需要先判断数据库中有没有这个openid
    user, created = User.objects.get_or_create(openid=openid)
    user_str = str(UserSerializer(user).data)
    # 生成自定义登录态，返回给前端
    sha = hashlib.sha1()
    sha.update(openid.encode())
    sha.update(session_key.encode())
    digest = sha.hexdigest()
    # 将自定义登录态保存到缓存中, 两个小时过期
    conn = get_redis_connection('default')
    conn.set(digest, user_str, ex=2*60*60)
    
    return Response(data={'code': 200, 'msg': 'ok', 'data': {'skey': digest})
复制代码

之后，在接口中通过request.user就可以取到本次请求的用户信息了。