Python实战项目

您所在的位置:网站首页 qq如何短信验证码登录 Python实战项目

Python实战项目

2024-07-17 03:29| 来源: 网络整理| 查看: 265

腾讯云短信开发申请

API和SDK,有SDK优先用SDK SDK: 3.0版本云操作:云操作的sdk,不仅仅有发送短信,还有云功能的其他功能 2.0版本,简单,只有发送短信功能

# 安装sdk -方式一:pip install tencentcloud-sdk-python -方式二源码安装: -下载源码 -执行 python setup.py install # 发送短信测试 查询手机号是否存在接口 class UserView(ViewSet): @action(methods=['get'], detail=False) def check_mobile(self, request): try: # 如果布报错就说明手机号存在 mobile = request.query_params.get('mobile') UserInfo.objects.get(mobile=mobile) return APIResponse('手机号存在') except Exception as e: raise APIException('手机号不存在!') 短信验证码功能

发短信的功能是公共的,我们可以将这个功能封装到公共的目录下面 libs目录下: send_tx_sms(包) init.py settings.py sms.py sms.py

# 获取n位随机数字验证码 import json from utils.common_log import logger import random def get_code(num=4): # // 获取随机验证码 code = '' for i in range(num): random_num = random.randint(0, 9) code += str(random_num) return code from tencentcloud.common import credential from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException import os # 导入对应产品模块的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 # 发送短信的函数 from . import settings def send_phone_sms(mobile,code): # 将它封装成函数,方便我们在调用的时候使用它 try: # 必要步骤: # 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。 # 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。 # 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人, # 以免泄露密钥对危及你的财产安全。 # SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi cred = credential.Credential(settings.SECRET_ID, settings.SECRET_KEY) # cred = credential.Credential( # os.environ.get("secretId"), # os.environ.get("secretKey") #我们可以将 sercetId 和 sercetKey放在环境变量中 # 这样我们的安全性更高 # ) # 实例化一个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 = settings.AppID # 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名 # 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看 req.SignName = settings.SignName # 模板 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, '30'] # 下发手机号码,采用 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格式的字符串回包 # print(resp.to_json_string(indent=2)) logger.warning(f'发送短信{code},给手机号{mobile}成功!') res = json.loads(resp.to_json_string(indent=2)) # 当出现以下错误码时,快速解决方案参考 # - [FailedOperation.SignatureIncorrectOrUnapproved](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Afailedoperation.signatureincorrectorunapproved-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - [FailedOperation.TemplateIncorrectOrUnapproved](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Afailedoperation.templateincorrectorunapproved-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - [UnauthorizedOperation.SmsSdkAppIdVerifyFail](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Aunauthorizedoperation.smssdkappidverifyfail-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - [UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Aunsupportedoperation.containdomesticandinternationalphonenumber-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - 更多错误,可咨询[腾讯云助手](https://tccc.qcloud.com/web/im/index.html#/chat?webAppId=8fa15978f85cb41f7e2ea36920cb3ae1&title=Sms) return res except TencentCloudSDKException as err: print(err) return False

settings.py

我们将sms.py中的配置项放在settings.py文件中 SECRET_ID = '' ## 当然可以采用环境变量放置给其赋值 SECRET_KEY = '' APP_ID = '' SIGN_NAME = '' TEMPLATE_ID = '' 发送验证码接口

view视图层

from rest_framework.viewsets import ViewSet from rest_framework.decorators import action from libs.send_tx_sms import send_phone_sms, get_code from utils.response import APIResponse class UserView(ViewSet): @action(method=['get'],detail=False) # 我们使用action装饰器自动生成路由 def send_sms(self,request) # 不一定是GET请求我们也可以更换action装饰器变成post请求 # 出了在手机号取值方面不一样,其余都是一样的 mobile = request.query_params.get('mobile') code = get_code() # 获取验证码 ''' 我们虽然拿到了验证码,但是等一下我们需要对其进行登录校验 所以我们暂时先将验证码放在缓存中(django项目重启,缓存中内容就会消失) ''' cache.set('sms_code_%s' % mobile, code) # 内存中的Key需要唯一,如果不唯一,key会被覆盖! res = send_phone_sms(mobile,code) print(res.get('SendStatusSet')[0]['Code']) #我们可以通过判断 这个值 if res: # 我在发送短信函数中失败处返回了False这样我们可以对res进行判断 return APIresponse(msg='发送成功') else: return APIresponse(msg='发送验证码失败',code=1002)

这样我们就完成了短信发送的接口,测试一下!

image.png image.png

logger.warning(f'发送短信{code},给手机号{mobile}成功!') 我在发送短信函数中增加了日志信息

短信登录接口

需求分析: 短信登录需要填写 手机号 验证码 前端返回格式:{mobile:1213121,code:123} 思路: 先获取用户输入手机号和验证码 对验证码进行校验,是否与缓存中验证码一致 在通过手机号查询用户信息,判断用户是否存在,如果存在签发token 短信登录接口其实与多方式登录接口思路是一致的,校验逻辑我们可以放在序列化类中 而视图层只需要几行代码即可 view视图层

class UserView(ViewSet): @action(methods=['post'], detail=False) # 我们可以通过Post请求携带数据 def mobile_login(self,request): # 产生序列化对象,通过序列化类来进行判断 ser_obj = self._get_serializer(data=self.request.data) ser_obj.is_valid(raise_exception=True) token = ser_obj.context.get('token') icon = ser_obj.context.get('icon') username = ser_obj.context.get('username') return APIResponse(token=token, icon=icon, username=username)

至此我们可以发现,短信登录与多方式登录视图层的代码都是一样的,除了序列化类不一样而已 所以我们就可以专门编写替换序列化类的函数,判断他们的区别,让他们获取不同的序列化类对象

获取序列化类

class UserView(ViewSet): def _get_serializer(self,data): # 因为登录的请求的路径是不同的,我们可以通过请求路径进行判断 if res == '/api/v1/userinfo/user/mobile_login/': return MobileLoginSerializer(data=data)# 如果手机登录返回它 return UserMulLoginSerializer(data=data) class UserView(ViewSet): def _get_serializer(self,data): # 因为请求的action装饰器不同,我们也可以通过action装饰器的值进行判断 if self.action == 'login' return UserMulLoginSerializer(data=data) else: return MobileLoginSerializer(data=data)

现在我们就可以将多方式登录和短信登录汇总到一起

def common_login(self): ser_obj = self._get_serializer(data=self.request.data) # 将我们所需要验证的数据传入获取不同的序列化类即可 ser_obj.is_valid(raise_exception=True) token = ser_obj.context.get('token') icon = ser_obj.context.get('icon') username = ser_obj.context.get('username') return APIResponse(token=token, icon=icon, username=username)

至此我们的视图类就变成了

class UserView(ViewSet): @action(methods=['post'], detail=False, ) def login(self, request): return self.common_login() @action(methods=['post'], detail=False) def mobile_login(self, request): return self.common_login()

让我们在看一下序列化类中的变化

序列化类 我的思路是进行了三合一的封装,封装的有些多.. 总体来说: 多方式登录序列化类/手机登录序列化类 签发Token步骤/序列化全局校验步骤都是一样的 所以我们可以将token部分/全局钩子校验 封装起来 除了_get_user方法是登录部分上的不同,其余基本一致,

import re from django.contrib.auth import authenticate from rest_framework.exceptions import ValidationError,APIException from django.core.cache import cache from rest_framework_jwt.serializers import jwt_payload_handler, jwt_encode_handler from user.models import UserInfo class Verification(): def _get_token(self, user_obj): pay_load = jwt_payload_handler(user_obj) token = jwt_encode_handler(pay_load) return token def _validate(self,attrs): user_obj = self._get_user(attrs) token = self._get_token(user_obj) self.context['token'] = token # self 是 序列化类对象 所以可以点context传值进去 self.context['username'] = user_obj.username self.context['icon'] = 'http://127.0.0.1:8000/media/' + str(user_obj.icon) return attrs def _get_user(self, attrs): username = attrs.get('username') password = attrs.get('password') mobile = attrs.get('mobile') if mobile: if not re.match(r'^1[3-9][0-9]{9}$', mobile): raise ValidationError('手机号格式输入错误') code = attrs.get('code') old_code = cache.get('sms_code_%s' % mobile) if code == old_code: try: user_obj = UserInfo.objects.get(mobile=mobile) return user_obj except Exception as e: raise APIException('手机号不存在') raise APIException('验证码错误') if re.match(r'^1[3-9][0-9]{9}$', username): user_obj = UserInfo.objects.filter(mobile=username).first() if user_obj and user_obj.check_password(password): return user_obj raise APIException('用户名或密码错误') # user_obj = authenticate(mobile=username, password=password) elif re.match(r'^.+@.+$', username): user_obj = authenticate(email=username, password=password) else: user_obj = authenticate(username=username, password=password) if not user_obj: raise APIException('用户名或密码错误') return user_obj

因为这个类也是单独抽出来的重复代码,所以我将它封装到了utils下的common_serializer.py中 这样我们在序列化类中直接调用它(并继承)即可

from rest_framework import serializers from .models import UserInfo from utils.common_serializer import Verification from rest_framework.exceptions import APIException,ValidationError from django.core.cache import cache class UserMulLoginSerializer(serializers.ModelSerializer, Verification): username = serializers.CharField() class Meta: model = UserInfo fields = ['username', 'password'] def validate(self, attrs): attrs = self._validate(attrs) return attrs class MobileLoginSerializer(serializers.ModelSerializer, Verification): mobile = serializers.CharField() # 需要重写这两个字段,因为数据库中mobile字段携带unique 并且code在内存中 code = serializers.CharField() class Meta: model = UserInfo fields = ['mobile', 'code'] # code存储再内存中 def validate(self, attrs): attrs = self._validate(attrs) return attrs 短信注册接口

短信注册接口分析: 前端返回格式:{mobile:123123123,code:1232,password:12312} 我们需要先获取前端发送的数据, 与登录同理,我们也在序列化类中进行校验 先判断手机号是否存在,并且判断验证码是否与内存中验证码一致 如果一致,我们需要调用auth的create_user方法,因为我们的密码没有进行加密,所以通过此方法进行加密处理 序列化类:

from rest_framework import serializers from .models import UserInfo from utils.common_serializer import Verification from rest_framework.exceptions import APIException,ValidationError from django.core.cache import cache class MobileRegisterSerializer(serializers.ModelSerializer): mobile = serializers.CharField() code = serializers.CharField(max_length=4,min_length=4) class Meta: model = UserInfo fields = ['mobile', 'code', 'password'] def validate(self, attrs): mobile = attrs.get('mobile') code = attrs.get('code') password = attrs.get('password') user_obj = UserInfo.objects.filter(username=mobile) if user_obj: raise APIException('手机号已存在') old_code = cache.get('sms_code_%s' % mobile) if code != old_code: raise APIException('验证码错误') UserInfo.objects.create_user(username=mobile, password=password,mobile=mobile) self.context['username'] = mobile return attrs

** 视图层**

class UserView(ViewSet): @action(methods=['post'], detail=False) def mobile_register(self, request): ser_obj = MobileRegisterSerializer(data=request.data) ser_obj.is_valid(raise_exception=True) return APIResponse(msg='注册成功', code=108, username=ser_obj.context.get('username'))


【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3