• 腾讯云短信开发-短信验证码接口-短信登录接口-短信注册接口
  • 昨日内容回顾
  • 今日内容概要
  • 今日内容详细
    • 1 腾讯云短信开发
      • 1.1 封装发送短信
    • 2 短信验证码接口
    • 3 短信登录接口
      • 3.1 视图类
      • 3.2 序列化类
    • 4 短信注册接口
      • 4.1 路由
      • 4.2 视图类
      • 4.3 序列化类

腾讯云短信开发-短信验证码接口-短信登录接口-短信注册接口

昨日内容回顾

# 1 git回顾

# 2 pycharm操作git
	公司版权问题---> pycharm收费软件---> 可能会用vscode，社区版 vim搭建开发环境
    项目右键操作git---> git很多操作之前使用命令 都可以通过点点点的完成
    
# 3 登录注册页功能分析
	多方式登录接口 ---> 完成
    验证手机号是否存在---> 完成
    
    发送短信接口---> 借助于第三方
    短信登录接口
    短信注册接口
    
# 4 验证手机号是否存在
	保证发送短信接口安全 不会吧被第三方盗用
    	1 加频率限制(频率限制 只能限制手机号一分钟发一次 但是不能限制接口一分钟访问一次)
        2 随机字符串：
        	跨站请求伪造：csrf
            同一个浏览器里：
            	登录 银行---> cookie存在浏览器中了
                进入了一个恶意网站 恶意网站里有个按钮 一点击 向银行发请求 虽然能发送成功 服务器也能正常响应 但是会被浏览器拦截
                因为 一旦登录银行成功 只要向银行发送请求 就会自动携带cookie
            解决方案：
                来到要发送post请求的页面 后端产生一个随机字符串 给前端
                如果要发post请求(一般用来增加 修改数据) 需要携带一个随机字符串 如果没有带 就会被禁止发送post
                
'''
以后写视图类 有个统一模板
try:
	逻辑
except Exception as e:
	再抛出来
	return APIResponse()
'''
	以后记住：
    	视图函数 视图类的方法 返回值一定是响应对象(django原生的4个 drf的一个 自己封装了一个)
        raise的对象 必须是错误对象 KeyError APIException LqzException
        
# 5 多方式登录接口
	前端---> post请求---> {username:lqz,password:123}---> 后端接收---> login_mul函数执行
    正常逻辑：
    	1 取出用户名 取出密码
        2 判断用户名对应的值是手机号 还是邮箱 还是用户名
        3 去数据库根据 手机号 或邮箱 或用户名 查询
        4 查到签发token 返回给前端
        
# 补充
	1 接口幂等性：接口幂等性就是用户对于同一操作发起的一次请求或者多次请求的结果是一致的，不会因为多次点击而产生了副作用。
    	解决方案：使用token机制 生成全局唯一的token，token放到redis或jvm内存 token会在页面跳转时获取，存放到pageScope中，支付请求先提交先获取token---> 提交后后台校验token，执行提交逻辑，提交成功同时删除token，生成新的token更新redis，这样当第一次提交后token更新了，页面再次提交携带的token是已删除的token，后台验证会失败不让提交
        token特点：要申请 一次有效性 可以限流
        注意：redis要用删除操作来判断token，删除成功代表token校验通过，如果用select + delete来校验token，存在并发问题，不建议使用
        
    2 异常捕获，可以捕获力度更细一些(精确到什么类型错误 抛出什么异常)
    
    3 自定义异常类
    class LqzException(Exception):
        def __init__(self,message):
            pass

今日内容概要

• 1 腾讯云短信开发

  • 1.1 封装发送短信

• 2 短信验证码接口

• 3 短信登录接口

  • 3.1 视图类
  • 3.2 序列化类

• 4 短信注册接口

  • 4.1 路由
  • 4.2 视图类
  • 4.3 序列化类

今日内容详细

1 腾讯云短信开发

# 给手机发送短信---> 第三方平台：腾讯云短信---> 

# API和SDK 有sdk优先使用sdk

# sdk：
	3.0版本 云操作的sdk 不仅仅有发送短信 还有云功能的其他功能
    2.0版本 简单 只有发送短信功能
    
# 安装sdk
	方式一：pip install tencentcloud-sdk-python
    方式二源码安装：
    	下载源码
        执行 python steup.py install
        
# 发送短信测试

1.1 封装发送短信

-libs下：
    send_sms_v3
        __init__.py
        settings.py
        sms.py
        
       
    
# __init__.py
from .sms import get_code,send_sms


# settings.py
SECRET_ID = ''
SECRET_KEY = ''
APP_ID = ''
SIGN_NAME = ''
TEMPLATE_ID = ''

# sms.py
# 生成 n 位数字验证码的函数
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


def get_code(number=4):
    code = ''
    for i in range(number):
        code += str(random.randint(0, 9))  # python 是强类型语言，不同类型运算不允许
    return code


# 发送短信函数
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()
        clientProfile.signMethod = "TC3-HMAC-SHA256"  # 指定签名算法
        clientProfile.language = "en-US"
        clientProfile.httpProfile = httpProfile
        client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile)
        req = models.SendSmsRequest()

        req.SmsSdkAppId = settings.APP_ID
        req.SignName = settings.SIGN_NAME
        req.TemplateId = settings.TEMPLATE_ID
        # 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致，，若无模板参数，则设置为空
        req.TemplateParamSet = [code, '1']
        # 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号]
        # 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号
        req.PhoneNumberSet = ["+86" + mobile, ]
        # 用户的 session 内容（无需要可忽略）: 可以携带用户侧 ID 等上下文信息，server 会原样返回
        req.SessionContext = ""
        # 短信码号扩展号（无需要可忽略）: 默认未开通，如需开通请联系 [腾讯云短信小助手]
        req.ExtendCode = ""
        # 国际/港澳台短信 senderid（无需要可忽略）: 国内短信填空，默认未开通，如需开通请联系 [腾讯云短信小助手]
        req.SenderId = ""
        resp = client.SendSms(req)
        # 输出json格式的字符串回包
        res = json.loads(resp.to_json_string(indent=2))
        if res.get('SendStatusSet')[0].get('Code') == 'Ok':
            return True
        else:
            return False
    except TencentCloudSDKException as err:
        print(err)
        return False

2 短信验证码接口

class UserView(GenericViewSet):
    serializer_class = UserLoginSerializer
    queryset = User.objects.all().filter(is_active=True)

    
    @action(methods=['POST'], detail=False)
    def send_sms(self, request):
        try:
            mobile = request.data['mobile']
            # 生成验证码
            code = get_code()
            # 使用异步发送短信
            # t = Thread(target=ss, args=[code, mobile])
            # t.start()
            # return APIResponse(msg='短信已发送')

            # 登录验证 找个地方存一下存到缓存中 key值唯一
            # 目前没学redis 暂时先存到内存中【项目部署会有坑】后期要使用redis作为缓存
            cache.set('sms_code_%s' % mobile, code)
			
            res = ss(code, mobile)  # 同步发送 后期可以改成异步 后期学了celery可以加入异步 目前咱们可以使用 多线程
            if res:
                return APIResponse(msg='发送成功')
            else:
                return APIResponse(code=110, msg='发送失败')

        except Exception as e:
            raise APIException(str(e))
            
'''
小小的补充：
            # 使用异步发送短信
            t = Thread(target=ss, args=[code, mobile])
            t.start()
            return APIResponse(msg='短信已发送')
'''

3 短信登录接口

# 前端---> {mobile:110120, code:7777}---> post--->
# 视图类的方法中的逻辑
	1 取出手机号和验证码
    2 校验验证码是否正确(发送验证码接口 存储验证码)
    	session：根本不用
        全局变量：不好 可能取不到 集群环境中
        缓存：django自带缓存
        	-from django.core.cache import cache
        	-cache.set()
            -cache.get()
    3 根据手机号查询用户 如果能查到
    4 签发token
    5 返回给前端
    

3.1 视图类

class UserView(GenericViewSet):
    serializer_class = UserLoginSerializer
    queryset = User.objects.filter(is_active=True)

    # 重写get_serializer_class 区分不同登录使用不同序列化类
    def get_serializer_class(self):
        if self.action == 'login_sms':
            return UserMobileLoginSerializer
        else:
            return super(UserView, self).get_serializer_class()
        
    # 此处封装将login写为内置方法 方便不同序列化类分别调用
    def _login(self, request, *args, **kwargs):
        ser = self.get_serializer(data=request.data)
        ser.is_valid(raise_exception=True)
        token = ser.context.get('token')
        username = ser.context.get('username')
        return APIResponse(token=token, username=username)

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

3.2 序列化类

from .models import User
from rest_framework import serializers
import re
from rest_framework.exceptions import APIException, ValidationError
from rest_framework_jwt.settings import api_settings

jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
from django.core.cache import cache

# 写这个父类方便别的序列化类调用 省代码
class BaseUserSerializer:
    def validate(self, attrs):
        user = self._get_user(attrs)
        token = self._get_token(user)
        self.context['token'] = token
        self.context['username'] = user.username
        return attrs

    def _get_user(self, attrs):
        raise Exception('你必须重写它')

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



class UserMobileLoginSerializer(BaseUserSerializer, serializers.ModelSerializer):
    code = serializers.CharField()
    mobile = serializers.CharField()

    class Meta:
        model = User
        fields = ['mobile', 'code']  # code 不是表的字段，要重写 ，mobile 有唯一约束，需要重写
    def _get_user(self, attrs):
        code = attrs.get('code')
        mobile = attrs.get('mobile')
        # 从缓存中取出
        old_code = cache.get('sms_code_%s' % mobile)
        if old_code and old_code == code:
            # 根据手机号，查到用户
            user = User.objects.filter(mobile=mobile).first()
            if user:
                return user
            else:
                raise APIException('用户不存在')
        else:
            raise APIException('验证码验证失败')

4 短信注册接口

# 前端---> {mobile:xxx, code:xxx,password:123}---> post
# 后端---> 视图类

4.1 路由

# http://127.0.0.1:8000/api/v1/user/register/   --->post 请求
router.register('register',views.RegisterUserView,'register')

4.2 视图类

class RegisterUserView(GenericViewSet, CreateModelMixin):
    queryset = User.objects.all()
    serializer_class = RegisterSeriializer

    def create(self, request, *args, **kwargs):
        # 使用父类的 会触发序列化类 一定要让code只写
        super().create(request, *args, **kwargs)

        return APIResponse(msg='注册成功')

4.3 序列化类

class RegisterSeriializer(serializers.ModelSerializer):
    # code不是数据库字段 重写
    code = serializers.CharField(max_length=4, write_only=True)

    class Meta:
        model = User
        fields = ['mobile', 'code', 'password']
        extra_kwargs = {
            'password': {'write_only': True}
        }

    def validate(self, attrs):  # 全局钩子
        '''
        1 取出前端传入的code 校验code是否正确
        2 把username设置成手机号(你可以随机生成) 用户名如果不传 存库进不去
        3 code 不是数据库的字段 从attrs中剔除
        '''
        mobile = attrs.get('mobile')
        code = attrs.get('code')
        old_code = cache.get('sms_code_%s' % mobile)
        if old_code and old_code == code:
            attrs['username'] = '用户' + mobile
            attrs.pop('code')  # 登录成功将验证码删除 因为不需要返回验证码
        else:
            raise APIException('验证码验证失败')

        return attrs

    def create(self, validated_data):  # 一定要重写create 因为密码是明文 如果不重写 存入到数据库的也是明文
        # validated_data = {username:18888,mobile:18888,password:123}
        # 创建用户
        user = User.objects.create_user(**validated_data)

        # 不要忘了return 后期 ser.data 会使用当前返回的对象做序列化
        return user