路飞项目--04

分析后端接口

# 用户板块--原型图--分析需要写哪些接口
    多方式登录接口
    短信登录接口
    发送短信接口
    短信注册接口
    校验手机号是否注册接口

手机号是否存在接口

思路：

       1 用了全局异常捕获，直接抛出异常报错

       2 路由用了自定义路由，由总路由拼接而来

# apps/user/views.py
from utills.common_response import APIResponse
from rest_framework.viewsets import ViewSet
from rest_framework.decorators import action
from .models import User
from rest_framework.exceptions import APIException

# 校验手机号是否存在接口
class UserMobileView(ViewSet):
    @action(methods=['POST'], detail=False,url_path='check_mobile')
    def mobile(self, request):
        try:
            mobile = request.data.get('mobile')
            User.objects.get(mobile=mobile)  # 能拿到说明手机号存在
            return APIResponse(msg='手机号存在')  # 定制返回格式
        except Exception as e:
            raise APIException(detail='手机号不存在')

# apps/user/urls.py
from rest_framework.routers import SimpleRouter
from  .views import UserMobileView

router = SimpleRouter()
# /api/v1/user/mobile/check_mobile/
router.register('mobile',UserMobileView,'mobile')
urlpatterns = [
    path('logger/', TestLoggerView.as_view()),
    path('exception/', TestExceptionView.as_view()),
    path('response/', TestResponseView.as_view()),
]
urlpatterns += router.urls

多方式登录接口

# 多方式登录接口，其实也是对登录接口的一种封装

# 思路：

        1、拿到前端传入的用户名[用户名、手机、邮箱] 和密码

        2、取数据库校验，拿到user

        3、校验通过，用user签发token

        4、返回前端

# apps/user/views.py
# 多方式登录接口
class UserLoginView(GenericViewSet):
    serializer_class = MoreLoginSerializer

    @action(methods=['POST'], detail=False)
    def more_login(self, request):
        ser = self.get_serializer(data=request.data, context={'request': request})
        ser.is_valid(raise_exception=True)  # 校验数据，就会执行serializer
        token = ser.context.get('token')
        username = ser.context.get('username')
        icon = ser.context.get('icon')
        return APIResponse(data={'token': token, 'username': username, 'icon': icon})

# apps/user/serializer.py
from rest_framework import serializers
from .models import User
import re
from rest_framework.exceptions import APIException
from rest_framework_simplejwt.tokens import RefreshToken
from django.conf import settings

# 这个序列化类只用来做反序列化，不需要将数据传到前端
class MoreLoginSerializer(serializers.Serializer):
    username = serializers.CharField()
    password = serializers.CharField()

    class Meta:
        model = User
        fields = ['username', 'password']

    # 验证数据
    def validate(self, attrs):
        user = self._get_user(attrs)  # 获取用户
        token = self._get_token(user)  # 签发token
        self._set_context(token, user)  # 放到context中
        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):
            user = User.objects.filter(mobile=username).first()
        elif re.match(r'^.+@.+$', username):  # 邮箱登录
            user = User.objects.filter(email=username).first()
        else:
            user = User.objects.filter(username=username).first()
        if user and user.check_password(password):  # auth表里验证密码
            return user
        else:
            raise APIException(detail='用户名或密码错误')

    # 拿到user签发token
    def _get_token(self, user):
        refresh = RefreshToken.for_user(user)
        return str(refresh.access_token)

    #  将token和user放到context中
    def _set_context(self, token, user):
        self.context['token'] = token
        self.context['username'] = user.username
        self.context['icon'] = settings.BACKEND_URL + '/media/' + str(user.icon)  # user.icon 文件对象

# apps/user/urls.py
from  .views import UserMobileView,UserLoginView

router = SimpleRouter()
# /api/v1/user/login/more_login/
router.register('login',UserLoginView,'login')
urlpatterns = [
]
urlpatterns += router.urls

腾讯云发送短信

# 项目中使用发送短信功能，借助于第三方:
    腾讯云短信（咱们）
    阿里、容联云短信
# 补充：短信轰炸，是违法的行为，不可以尝试

# 登录成功：https://console.cloud.tencent.com/smsv2

   短信发送：https://cloud.tencent.com/document/product/382/55981
    API：api接口，请求地址，携带参数，返回某些格式
    sdk：使用某种语言对api接口进行封装
        有sdk，优先用sdk，简单

        下载sdk，导入，掉方法执行，传入参数即可
# 下载sdk：pip install tencentcloud-sdk-python

# 代码直接贴下来，改动一下数据就可以使用了：

# script/1-发送短信.py
# -*- 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("AKIDT0gF0iU8gJ5XEvW0cLyWzZME97yQipya", "gJsS0X8vlkfkyKmJzgO4kKlm2OuW4Wug")
    # cred = credential.Credential(
    #     os.environ.get(""),
    #     os.environ.get("")
    # )

    # 实例化一个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()
    clientProfile.signMethod = "TC3-HMAC-SHA256"  # 指定签名算法
    clientProfile.language = "en-US"
    clientProfile.httpProfile = httpProfile

    # 实例化要请求产品(以sms为例)的client对象
    # 第二个参数是地域信息，可以直接填写字符串ap-guangzhou，支持的地域列表参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8
    client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile)

    # 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
    # 您可以直接查询SDK源码确定SendSmsRequest有哪些属性可以设置
    # 属性可能是基本类型，也可能引用了另一个数据结构
    # 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明
    req = models.SendSmsRequest()

    # 基本类型的设置:
    # SDK采用的是指针风格指定参数，即使对于基本类型您也需要用指针来对参数赋值。
    # SDK提供对基本类型的指针引用封装函数
    # 帮助链接：
    # 短信控制台: https://console.cloud.tencent.com/smsv2
    # 腾讯云短信小助手: https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81

    # 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666
    # 应用 ID 可前往 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 查看
    req.SmsSdkAppId = "1400885290"
    # 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名
    # 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看
    req.SignName = "蟒蛇梦想家公众号"
    # 模板 ID: 必须填写已审核通过的模板 ID
    # 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看
    req.TemplateId = "2057994"
    # 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致，，若无模板参数，则设置为空
    req.TemplateParamSet = ["6666"]
    # 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号]
    # 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号
    req.PhoneNumberSet = ["+8613093703948"]
    # 用户的 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)



'''

{
  "SendStatusSet": [
    {
      "SerialNo": "3369:323809362217060692711588557",
      "PhoneNumber": "+8618066185575",
      "Fee": 1,
      "SessionContext": "",
      "Code": "Ok",
      "Message": "send success",
      "IsoCode": "CN"
    }
  ],
  "RequestId": "dbfe8874-af6c-42c9-827d-67dc7de342a4"
}

'''

腾讯云短信封装

# 将腾讯云代码封装成一个包，这样在自己写的项目中不管哪个位置都可以导入使用

# 封装了两个函数，一个是随机生成验证码，一个是腾讯云发送短信

        验证码：导入执行函数后随机生成

        手机号：由前端的请求地址栏中GET取得

# 做了动态的setting，以供方便改动账号信息

# 在包下的__init__中导入一下才可以后续导入其他代码体中使用

# lib/send_information/__init__.py
from .sms import get_code,common_send_sms

# libs/send_information/settings.py
SECRET_ID = 'AKIDXwBFAATk5lQydSLGAuR5e7LK5tvxtme6'
SECRET_KEY = 'dHuYIvWVMJ9ApYN6xv5LYo7QahhH3gAf'

# 申请的短信应用 SDK AppID
APP_ID = '1400885403'

# 申请的短信模板ID，需要在短信控制台中申请
TEMPLATE_ID = '2060860'

# 申请的签名，参数使用的是`签名内容`，而不是`签名ID`
SIGN = "佳佳的工作日记公众号"

# lib/send_information/sms.py
# 提供函数，给外部使用
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
import json
from rest_framework.exceptions import APIException
from libs.send_information import settings
import random


#  随机生成4位的验证码
def get_code(count=4):
    code = ''
    for i in range(count):
        code += str(random.randint(0, 9))
    return code


# 发送短信函数
def common_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
        # 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名
        # 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看
        req.SignName = settings.SIGN
        # 模板 ID: 必须填写已审核通过的模板 ID
        # 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看
        req.TemplateId = settings.TEMPLATE_ID
        # 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致，，若无模板参数，则设置为空
        req.TemplateParamSet = [code]
        # 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号]
        # 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号
        req.PhoneNumberSet = ["+86" + mobile]
        # 用户的 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格式的字符串回包
        resp = json.loads(resp.to_json_string(indent=2))
        if resp.get('SendStatusSet')[0].get('Code') == 'Ok':
            return True
        else:
            return False

    except TencentCloudSDKException as err:
        raise APIException(detail=str(err))
    except Exception as e:
        raise APIException(detail=str(e))


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

3、​​​​​

发送短信接口

# 我们以后一定要多分类，

        由此我将验证手机号是否存在的接口和发送短信的接口归类写在了一起

        多方式登录【邮箱，手机号，用户名】单独写了一个类

# 接口取的是请求地址栏中的手机号以供前端使用，用get请求

from libs.send_information import get_code, common_send_sms
from django.utils.datastructures import MultiValueDictKeyError
from django.core.cache import cache
from threading import Thread


# 关于手机号和短信的接口
class UserMobileView(ViewSet):
    ...
    # 发送短信接口
    @action(methods=['get'], detail=False, url_path='send_information')
    def send_sms(self, request):
        try:
            mobile = request.query_params['mobile']  # 取的手机号放在请求地址栏中
            code = get_code()  # 生成验证码
            cache.set('sms_code_%s' % mobile, code)  # 放在缓存中，以手机号做区
            t = Thread(target=common_send_sms, args=[code, mobile])
            t.start()  # 启动线程发送短信
            return APIResponse(msg='短信已发送')

        except MultiValueDictKeyError as e:
            raise APIException(detail='手机号必须携带')
        except Exception as e:
            raise APIException(detail=str(e))

短信登录功能及代码优化

# 因为短信登录和多方式登录代码有很多相同的地方，由此，我们优化了代码，进行封装

# apps/user/views.py
from rest_framework.decorators import action
from rest_framework.exceptions import APIException
from .serializer import MoreLoginSerializer,InformationLoginSerializer

# 多方式登录和短信登录接口
class UserLoginView(GenericViewSet):
    serializer_class = MoreLoginSerializer

    @action(methods=['POST'], detail=False)
    def more_login(self, request):
        return self._common_login(request)

    @action(methods=['POST'], detail=False)
    def informetion_login(self, request):
        return self._common_login(request)

    def get_serializer_class(self):
        if self.action == 'informetion_login':
            return InformationLoginSerializer
        else:
            return super().get_serializer_class()

    def _common_login(self, request):
        ser = self.get_serializer(data=request.data, context={'request': request})
        ser.is_valid(raise_exception=True)  # 校验数据，就会执行serializer
        token = ser.context.get('token')
        username = ser.context.get('username')
        icon = ser.context.get('icon')
        return APIResponse(data={'token': token, 'username': username, 'icon': icon})

# apps/user/serializer.py
from rest_framework import serializers
from .models import User
import re
from rest_framework.exceptions import APIException
from rest_framework_simplejwt.tokens import RefreshToken
from django.conf import settings
from django.core.cache import cache


# 只用来做继承
class BaseLoginSerializer(serializers.Serializer):
    # 验证数据
    def validate(self, attrs):
        user = self._get_user(attrs)  # 获取用户
        token = self._get_token(user)  # 签发token
        self._set_context(token, user)  # 放到context中
        return attrs

    #  校验成功获取用户
    def _get_user(self, attrs):
        raise Exception('这个方法必须被重写')

    # 拿到user签发token
    def _get_token(self, user):
        refresh = RefreshToken.for_user(user)
        return str(refresh.access_token)

    #  将token和user放到context中
    def _set_context(self, token, user):
        self.context['token'] = token
        self.context['username'] = user.username
        self.context['icon'] = settings.BACKEND_URL + '/media/' + str(user.icon)  # user.icon 文件对象


# 这个序列化类只用来做反序列化，不需要将数据传到前端
# 继承就行,修改获得的用户，因为一个是多方式取手机号、邮箱、用户名等，一个是短信
class MoreLoginSerializer(BaseLoginSerializer):
    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):
            user = User.objects.filter(mobile=username).first()
        elif re.match(r'^.+@.+$', username):  # 邮箱登录
            user = User.objects.filter(email=username).first()
        else:
            user = User.objects.filter(username=username).first()
        if user and user.check_password(password):  # auth表里验证密码
            return user
        else:
            raise APIException(detail='用户名或密码错误')


class InformationLoginSerializer(BaseLoginSerializer):
    mobile = serializers.CharField()
    code = serializers.CharField()

    def _get_user(self, attrs):
        # 取出验证码,在序列化类里取值是attrs
        code = attrs.get('code')
        mobile = attrs.get('mobile')
        old_code = cache.get('sms_code_%s' % mobile)
        # 验证码验证
        if code == old_code or (settings.DEBUG and code == '8888'):
            # 验证码正确的情况，拿着手机号查询用户，看是否已经注册
            user = User.objects.filter(mobile=mobile).first()
            if user:
                return user
            else:
                raise  APIException(detail='用户不存在')
        else:
            raise APIException(detail='验证码错误')

短信注册功能

# 前端传入的 {mobile,code,password}

   User表中字段：username必填，自动生成 fake 我们让手机号做用户名

# apps/user/views.py
# 短信注册功能
from rest_framework.viewsets import ViewSet, GenericViewSet
from .serializer import RegisterSerializer


class UserRegisterView(GenericViewSet):
    serializer_class = RegisterSerializer

    # @action(methods=['POST'], detail=False)
    # def register(self, request):
    def create(self, request):
        ser = self.get_serializer(data=request.data)
        ser.is_valid(raise_exception=True)
        ser.save()
        return APIResponse(msg='注册成功')

# apps/user/serializer.py
# 短信注册功能
class RegisterSerializer(serializers.ModelSerializer):
    code = serializers.CharField()  # 因为code不是表的字段，所以必须重写

    class Meta:
        model = User
        fields = ['mobile', 'code', 'password']

    def validate(self, attrs):
        # 验证验证码
        code = attrs.pop('code')
        mobile = attrs.get('mobile')
        old_code = cache.get('sms_code_%s' % mobile)
        if code == old_code or (settings.DEBUG and code == '6666'):
            # 把手机号作为用户名存入
            attrs['username'] = mobile
        else:
            raise APIException(detail='验证码错误')
        return attrs

    #  重写create方法，因为create_user，密码用的是明文
    # validated_data拿的是上面的attrs数据
    def create(self, validated_data):
        user = User.objects.create_user(**validated_data)
        return user

# apps/user/urls.py
from django.urls import path
from .views import TestLoggerView,TestExceptionView,TestResponseView
from rest_framework.routers import SimpleRouter
from  .views import UserRegisterView

router = SimpleRouter()
router.register('register',UserRegisterView,'register')
urlpatterns = [
]
urlpatterns += router.urls

今日思维导图：