6-前后端项目上传到gitee、后端多方式登录接口、发送短信功能、发送短信封装、短信验证码接口、短信登录接口

林光虚霁晓

已于 2024-03-28 14:49:04 修改

阅读量807

点赞数

分类专栏：项目文章标签： gitee sdk 短信验证 token

于 2023-10-13 15:22:15 首次发布

本文链接：https://blog.csdn.net/weixin_44145338/article/details/133810298

版权

项目专栏收录该内容

9 篇文章 0 订阅

订阅专栏

1 前后端项目上传到gitee

2 后端多方式登录接口

2.1 序列化类
 2.2 视图类
 2.3 路由

3 发送短信功能

4 发送短信封装
 4.0 目录结构
 4.1 settings.py
4.2 sms.py

5 短信验证码接口

6 短信登录接口
 6.1 视图类
 6.2 序列化类

1 前后端项目上传到gitee

# 我们看到好多开源项目，前后端都在一个仓库中---》为了方便
# 正常咱们开发代码，一个项目一个仓库  

# 1 后端仓库创建好了，提交过了---》继续提交
	git add .
    git commit -m '完成手机号校验功能'
    git push origin master

# 2 前端
	创建远程仓库
    本地按上面命令，提交上即可(配置远程remote地址)

2 后端多方式登录接口

# 分析
	前端携带的数据：{username:用户名，手机号，邮箱,password:md5(密码)}
    注册的时候：密码也是md5加密后带过来的
    我们登录的时候，带的密码是md5加密的---》后端校验通不过
  
# 后端：
	-request.data中取出来
    -校验用户名密码是否正确---》逻辑写到 序列类中
    -配合序列化类---》全局钩子中写逻辑，签发token
    -返回给前端
    
    
    
    
# 总结：
 1 序列化类实例化得到对象时要ser=UserLoginSerializer(data=request.data)    data=request.data  不能传给第一个位置
 2 被 APIResponse 序列化的数据类型，必须是 数字，字符串，列表，字典，不能是其他对象类型
 3 配置文件中写了个 后台项目地址

2.1 序列化类

from .models import User
from rest_framework import serializers
import re
from rest_framework.exceptions import ValidationError
from rest_framework_jwt.serializers import jwt_payload_handler, jwt_encode_handler
from django.conf import settings


# 只用来做校验
class UserLoginSerializer(serializers.Serializer):
    # 字段自己的校验规则会限制，不通过，因为是unique的
    username = serializers.CharField()
    password = serializers.CharField()

    def validate(self, attrs):
        # 1 校验用户名密码是否正确
        user = self._get_user(attrs)
        # 2 签发token
        token = self._get_token(user)
        # 3 把签发的token和username放到context中
        self.context['username'] = user.username
        self.context['token'] = token
        self.context['icon'] = settings.BACKEND_URL + '/media/' + str(user.icon)
        # 4 返回attrs
        return attrs

    def _get_user(self, attrs):
        username = attrs.get('username')
        password = attrs.get('password')
        if re.match(r'^1[3-9][0-9]{9}$', username):
            # 因为这个password是明文---》在数据库中存了密文，必须要使用  user.check_password校验用户秘钥
            # user=User.objects.filter(mobile=username,password=password)
            user = User.objects.filter(mobile=username).first()
        elif re.match(r'^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)+$', username):
            user = User.objects.filter(email=username).first()
        else:
            user = User.objects.filter(username=username).first()

        if user and user.check_password(password):
            return user
        else:
            raise ValidationError('用户名或密码错误')

    def _get_token(self, user):
        payload = jwt_payload_handler(user)
        token = jwt_encode_handler(payload)
        return token

2.2 视图类

class UserLoginView(GenericViewSet):
    serializer_class = UserLoginSerializer

    # 没有用，就不需要写
    # queryset = None
    @action(methods=['POST'], detail=False)
    def mul_login(self, request, *args, **kwargs):
        ser = self.get_serializer(data=request.data)
        # ser=UserLoginSerializer(data=request.data)
        ser.is_valid(raise_exception=True)
        username = ser.context.get('username')
        token = ser.context.get('token')
        icon = ser.context.get('icon')
        # icon 必须是字符串形式，不能是对象形式
        # {code:100,msg:成功，token：asdfasf,icon:asdfasdf,username:asdfasd}
        return APIResponse(username=username, token=token, icon=icon)
        # {code:100,msg:成功，token：asdfasf,user:{id:1,username:xxx,icon:ssss}}
        # return APIResponse(token=token, user=ser.data) # 如果执行ser.data,就会走序列化

2.3 路由

# 127.0.0.1:8000/api/v1/user/login/mul_login/   ---post 请求
router.register('login', UserLoginView, 'login')

3 发送短信功能

# 需要借助于第三方---》腾讯云

# python 脚本测试，能够成功发送短信
	

    
    
# API和sdk的区别
	-API： 网络地址，有请求方式，向这个地址按照规则发送请求，就能完成某些操作---》以后只要使用第三方服务，大概率会提供给你api
    -sdk：集成开发工具包，第三方平台，用不同语言对api接口进行封装---》只要按照它的使用规则---》直接导入使用接口
    	-可能没提供所有语言的sdk，不同语言要单独写
        -python的形式就是一个 包，把包下载下来
        
    -以后使用第三方，如果有sdk，优先用sdk，如果没有，只能用api
    
    
    
    
# 下载sdk
pip install --upgrade tencentcloud-sdk-python

在这里插入图片描述

# -*- coding: utf-8 -*-
from tencentcloud.common import credential
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
# 导入对应产品模块的client models。
from tencentcloud.sms.v20210111 import sms_client, models

# 导入可选配置类
from tencentcloud.common.profile.client_profile import ClientProfile
from tencentcloud.common.profile.http_profile import HttpProfile

try:
    # 必要步骤：
    # 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
    # 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
    # 您也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
    # 以免泄露密钥对危及您的财产安全。
    # SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi
    cred = credential.Credential("", "")

    # 实例化一个http选项，可选的，没有特殊需求可以跳过。
    httpProfile = HttpProfile()
    # 如果需要指定proxy访问接口，可以按照如下方式初始化hp（无需要直接忽略）
    # httpProfile = HttpProfile(proxy="http://用户名:密码@代理IP:代理端口")
    httpProfile.reqMethod = "POST"  # post请求(默认为post请求)
    httpProfile.reqTimeout = 30  # 请求超时时间，单位为秒(默认60秒)
    httpProfile.endpoint = "sms.tencentcloudapi.com"  # 指定接入地域域名(默认就近接入)
    clientProfile = ClientProfile()
    client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile)
    req = models.SendSmsRequest()

    req.SmsSdkAppId = "1400861098"
    # 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名
    # 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看
    req.SignName = "RoyHuang公众号"
    # 模板 ID: 必须填写已审核通过的模板 ID
    # 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看
    req.TemplateId = "1951470"
    # 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致，，若无模板参数，则设置为空
    req.TemplateParamSet = ["8888",'10']
    req.PhoneNumberSet = ["+8613221296955"]
    # 用户的 session 内容（无需要可忽略）: 可以携带用户侧 ID 等上下文信息，server 会原样返回
    req.SessionContext = ""
    # 短信码号扩展号（无需要可忽略）: 默认未开通，如需开通请联系 [腾讯云短信小助手]
    req.ExtendCode = ""
    # 国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。注：月度使用量达到指定量级可申请独立 SenderId 使用，详情请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
    req.SenderId = ""

    resp = client.SendSms(req)

    # 输出json格式的字符串回包
    print(resp.to_json_string(indent=2))

except TencentCloudSDKException as err:
    print(err)

4 发送短信封装

4.0 目录结构

tx_sms
    __init__.py
    settings.py
    sms.py

4.1 settings.py

	SECRET_ID=''
	SECRET_KEY=''
	APPID=''
	SIGN_NAME=''
	TEMPLATE_ID=''

4.2 sms.py

import random
from tencentcloud.common import credential
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.sms.v20210111 import sms_client, models
from tencentcloud.common.profile.client_profile import ClientProfile
from tencentcloud.common.profile.http_profile import HttpProfile
from . import settings

import json


# 1 生成一个 固定长度的随机验证码(数字)
def get_code(number=4):
    code = ''
    for i in range(number):
        r = random.randint(0, 9)
        code += str(r)
    return code


# 2 传入手机号和验证，发送短信功能函数
def send_sms(code, mobile):
    try:
        cred = credential.Credential(settings.SECRET_ID, settings.SECRET_KEY)
        httpProfile = HttpProfile()
        httpProfile.reqMethod = "POST"  # post请求(默认为post请求)
        httpProfile.reqTimeout = 30  # 请求超时时间，单位为秒(默认60秒)
        httpProfile.endpoint = "sms.tencentcloudapi.com"  # 指定接入地域域名(默认就近接入)
        clientProfile = ClientProfile()
        client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile)
        req = models.SendSmsRequest()

        req.SmsSdkAppId = settings.APPID
        req.SignName = settings.SIGN_NAME
        req.TemplateId = settings.TEMPLATE_ID
        req.TemplateParamSet = [code, '1']
        req.PhoneNumberSet = ["+86" + mobile]
        resp = client.SendSms(req)
        print(resp.to_json_string(indent=2))
        response_data_dict = json.loads(resp.to_json_string(indent=2))
        if response_data_dict.get('SendStatusSet')[0].get('Code')=='Ok':
            return True
        else:
            # 失败了，可以拿出message---》正常发送失败
            return False
    except Exception as err:
        # 发送过程中出了错误，失败
        return False


if __name__ == '__main__':
    print(get_code())

5 短信验证码接口

class MobileView(ViewSet):


    @action(methods=['POST'], detail=False)
    def send_sms(self, request, *args, **kwargs):
        # 1 给谁发，手机号是从前端传入的，{mobile:18923434,code:'验证码'}  ---》我们的：{mobile:18923434}
        mobile = request.data.get('mobile')
        # 2 生成数字验证码
        code = get_code()
        # 3 数字验证码保存---》保存到哪？后续还能拿到---》放到缓存中---》默认放在内存中
        cache.set('cache_mobile_%s' % mobile, code)  # key 一定要唯一，后续还能取出来，就用手机号
        # 4 同步 发送短信---》同步发送--》可能前端会一直等待，耗时
        # res = send_sms_mobile(code, mobile)
        # if res:
        #     return APIResponse(msg='发送成功')
        # else:
        #     return APIResponse(code=101, msg='发送失败，请稍后再试')
        #
        # 5 发送短信--》异步操作，使用多线程，无法知道短信是否成功了，不需要关注是否成功
        t=Thread(target=send_sms_mobile,args=[code,mobile])
        t.start()
        return APIResponse(msg='发送已发送')

6 短信登录接口

# 分析：
	前端携带的数据---》{mobile：11111,code:8888}
	后端：
    	-取出手机号验证码，验证验证码是否正确，如果正确
        -签发token
        -返回给前端

6.1 视图类

class UserLoginView(GenericViewSet):
    serializer_class = UserLoginSerializer

    # 没有用，就不需要写
    # queryset = None
    @action(methods=['POST'], detail=False)
    def mul_login(self, request, *args, **kwargs):
        return self._login(request, *args, **kwargs)

    @action(methods=['POST'], detail=False)
    def sms_login(self, request, *args, **kwargs):
        return self._login(request, *args, **kwargs)

    def get_serializer_class(self):
        # 判断，如果是sms_login，返回  短信登录的序列化类，其他情况就返回UserLoginSerializer
        if self.action == 'sms_login':
            return SMSLoginSerializer
        elif self.action == 'mul_login':
            return UserLoginSerializer
        else:
            return super().get_serializer_class()


    def _login(self, request, *args, **kwargs):
        ser = self.get_serializer(data=request.data)  # 序列化类不一样，重写某个方法，实现，不同的请求action，返回的序列化类不一样
        ser.is_valid(raise_exception=True)
        username = ser.context.get('username')
        token = ser.context.get('token')
        icon = ser.context.get('icon')
        return APIResponse(username=username, token=token, icon=icon)

6.2 序列化类

class LoginSerializer(serializers.Serializer):
    def validate(self, attrs):
        # 1 校验用户名密码是否正确
        user = self._get_user(attrs)
        # 2 签发token
        token = self._get_token(user)
        # 3 把签发的token和username放到context中
        self.context['username'] = user.username
        self.context['token'] = token
        self.context['icon'] = settings.BACKEND_URL + '/media/' + str(user.icon)
        # 4 返回attrs
        return attrs

    def _get_user(self, attrs):
        pass

    def _get_token(self, user):
        payload = jwt_payload_handler(user)
        token = jwt_encode_handler(payload)
        return token


# 只用来做校验
class UserLoginSerializer(LoginSerializer):
    # 字段自己的校验规则会限制，不通过，因为是unique的
    username = serializers.CharField()
    password = serializers.CharField()

    def _get_user(self, attrs):
        username = attrs.get('username')
        password = attrs.get('password')
        if re.match(r'^1[3-9][0-9]{9}$', username):
            # 因为这个password是明文---》在数据库中存了密文，必须要使用  user.check_password校验用户秘钥
            # user=User.objects.filter(mobile=username,password=password)
            user = User.objects.filter(mobile=username).first()
        elif re.match(r'^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)+$', username):
            user = User.objects.filter(email=username).first()
        else:
            user = User.objects.filter(username=username).first()

        if user and user.check_password(password):
            return user
        else:
            raise ValidationError('用户名或密码错误')


class SMSLoginSerializer(LoginSerializer):
    mobile = serializers.CharField()
    code = serializers.CharField()

    def _get_user(self, attrs):
        mobile = attrs.get('mobile')
        code = attrs.get('code')
        # 1 校验code是否正确
        old_code = cache.get('cache_mobile_%s' % mobile)
        if old_code == code:
            # 2 根据手机号，取到用户
            user = User.objects.filter(mobile=mobile).first()
            if user:
                return user
            else:
                raise ValidationError('手机号不存在')
        else:
            raise ValidationError('验证码错误')