Django+celery+腾讯云 异步发送短信验证码

Django+celery+腾讯云 异步发送短信验证码

一、配置腾讯云短信

腾讯云短信申请：https://console.cloud.tencent.com/smsv2

• 首先创建签名

  

• 实例通过后创建模板

  

• 模板内的{1} 代表一个参数

  

• 此时我们的腾讯云已经配置好了，接下来配置Python后端 代码

二、Python后端配置

Python SDK 配置官方文档

https://cloud.tencent.com/document/product/382/43196

• 安装 SDK

  • pip安装

    pip install tencentcloud-sdk-python
    

  • 通过源码包安装

    github：https://github.com/tencentcloud/tencentcloud-sdk-python

    快速下载地址：https://tencentcloud-sdk-1253896243.file.myqcloud.com/tencentcloud-sdk-python/tencentcloud-sdk-python.zip

    #切换到下载下来的源码包目录
    cd tencentcloud-sdk-python
    python setup.py install
    

  • 发送短信实例

    # -*- 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。
      # 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
      # 你也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
      # 以免泄露密钥对危及你的财产安全。
      # CAM密匙查询: https://console.cloud.tencent.com/cam/capi
      cred = credential.Credential("secretId", "secretKey")
      # cred = credential.Credential(
      #     os.environ.get(""),
      #     os.environ.get("")
      # )
       # 实例化一个http选项，可选的，没有特殊需求可以跳过。
      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
       # 实例化要请求产品(以sms为例)的client对象
      # 第二个参数是地域信息，可以直接填写字符串ap-guangzhou，或者引用预设的常量
      client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile)
       # 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
      # 你可以直接查询SDK源码确定SendSmsRequest有哪些属性可以设置
      # 属性可能是基本类型，也可能引用了另一个数据结构
      # 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明
      req = models.SendSmsRequest()
       # 基本类型的设置:
      # SDK采用的是指针风格指定参数，即使对于基本类型你也需要用指针来对参数赋值。
      # SDK提供对基本类型的指针引用封装函数
      # 帮助链接：
      # 短信控制台: https://console.cloud.tencent.com/smsv2
      # sms helper: https://cloud.tencent.com/document/product/382/3773
       # 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666
      req.SmsSdkAppId = "1400787878"
      # 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名，签名信息可登录 [短信控制台] 查看
      req.SignName = "xxx"
      # 短信码号扩展号: 默认未开通，如需开通请联系 [sms helper]
      req.ExtendCode = ""
      # 用户的 session 内容: 可以携带用户侧 ID 等上下文信息，server 会原样返回
      req.SessionContext = "xxx"
      # 国际/港澳台短信 senderid: 国内短信填空，默认未开通，如需开通请联系 [sms helper]
      req.SenderId = ""
      # 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号]
      # 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号
      req.PhoneNumberSet = ["+8613711112222"]
      # 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看
      req.TemplateId = "449739"
      # 模板参数: 若无模板参数，则设置为空
      req.TemplateParamSet = ["666"]
        # 通过client对象调用DescribeInstances方法发起请求。注意请求方法名与请求对象是对应的。
      # 返回的resp是一个DescribeInstancesResponse类的实例，与请求对象对应。
      resp = client.SendSms(req)
       # 输出json格式的字符串回包
      print(resp.to_json_string(indent=2))
    except TencentCloudSDKException as err:
      print(err)
    

三、配置celery

• Python3.7版本配置，celery4.+版本

  • 安装模块

    pip install celery==4.3
    

  • 但是在windows下启动worker的时候还会有另外的错误，win10需要用协程的方式启动celery worker

    pip install eventlet
    

  • 启动worker的时候加一个参数 -P eventlet

    celery  -A mycelery.main worker --loglevel=info -P eventlet
    

四、Django+celery 异步发送短信验证码

• 在项目目录下创建一个文件夹mycelery

  projectapi/
  ├── mycelery/
      ├── config.py     # 配置文件
      ├── __init__.py   
      ├── main.py       # 主程序
      └── sms/          # 一个目录可以放置多个任务,该目录下存放当前任务执行时需要的模块或依赖,也可以每个任务单独一个目录
          └── tasks.py  # 任务的文件，名称必须是这个!!!
  

  • tasks.py:

    from mycelery.main import app
    from tencentcloud.common import credential
    from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
    # 导入 SMS 模块的client models
    from tencentcloud.sms.v20190711 import sms_client, models
    # 导入可选配置类
    from tencentcloud.common.profile.client_profile import ClientProfile
    from tencentcloud.common.profile.http_profile import HttpProfile
    import json
    
    @app.task(name='sms') # 将这个函数指定成一个任务
    def send_sms():
        """发送短信的任务"""
        print('发送短信')
    
        return '发送短信'
    @app.task(name='send_code')
    def send_code(phone,rand_code):
        phone="+86"+str(phone).strip()
        try:
            # 必要步骤：
            # 实例化一个认证对象，入参需要传入腾讯云账户密钥对 secretId 和 secretKey
            # 本示例采用从环境变量读取的方式，需要预先在环境变量中设置这两个值
            # 您也可以直接在代码中写入密钥对，但需谨防泄露，不要将代码复制、上传或者分享给他人
            # CAM 密钥查询：https://console.cloud.tencent.com/cam/capi
    
            cred = credential.Credential("AKIDJNTJsACwPcYDbiY7i6D3ey1nJYXFhrkM", "MSHo44nFQLzWt1uWuwkVRCn9HF9wZ5MX")
            # cred = credential.Credential(
            #     os.environ.get(""),
            #     os.environ.get("")
            # )
            # 实例化一个 http 选项，可选，无特殊需求时可以跳过
            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
            # 实例化 SMS 的 client 对象
            # 第二个参数是地域信息，可以直接填写字符串 ap-guangzhou，或者引用预设的常量
            client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile)
            # 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
            # 您可以直接查询 SDK 源码确定 SendSmsRequest 有哪些属性可以设置
            # 属性可能是基本类型，也可能引用了另一个数据结构
            # 推荐使用 IDE 进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明
            req = models.SendSmsRequest()
            # 基本类型的设置:
            # SDK 采用的是指针风格指定参数，即使对于基本类型也需要用指针来对参数赋值
            # SDK 提供对基本类型的指针引用封装函数
            # 帮助链接：
            # 短信控制台：https://console.cloud.tencent.com/smsv2
            # sms helper：https://cloud.tencent.com/document/product/382/3773
            # 短信应用 ID: 在 [短信控制台] 添加应用后生成的实际 SDKAppID，例如1400006666
            req.SmsSdkAppid = "1#######4"
            # 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名，可登录 [短信控制台] 查看签名信息
            req.Sign = "好###"
            # 短信码号扩展号: 默认未开通，如需开通请联系 [sms helper]
            req.ExtendCode = ""
            # 用户的 session 内容: 可以携带用户侧 ID 等上下文信息，server 会原样返回
            req.SessionContext = "3###53"
            # 国际/港澳台短信 senderid: 国内短信填空，默认未开通，如需开通请联系 [sms helper]
            req.SenderId = ""
            # 下发手机号码，采用 e.164 标准，+[国家或地区码][手机号]
            # 例如+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号
            req.PhoneNumberSet = [phone]
            # 模板 ID: 必须填写已审核通过的模板 ID，可登录 [短信控制台] 查看模板 ID
            req.TemplateID = "9###17"
            # 模板参数: 若无模板参数，则设置为空
            req.TemplateParamSet = [str(rand_code)]
            # 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
            resp = client.SendSms(req)
            # 输出 JSON 格式的字符串回包
            request_json=resp.to_json_string(indent=2)
            request_json=json.loads(request_json)
            status=request_json['SendStatusSet'][0]['Fee']
            print(request_json)
            if status==0:
                return False
            elif status==1:
                return True
            return False
        except TencentCloudSDKException as err:
            print(err)
            return False
    
    

  • config.py:

    # 任务队列的链接地址(变量名不能变)
    broker_url = "redis://127.0.0.1:6379/14"
    
    # 结果队列的链接地址(变量名不能变)
    result_backend = "redis://127.0.0.1:6379/15"
    

  • main.py: #自动发现任务

    from celery import Celery
    import os
    import django
    os.environ.setdefault('FORKED_BY_MULTIPROCESSING', '1')
    
    # 引入django项目的环境
    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'luffyapi.settings.dev')
    django.setup()
    
    # 1. 创建celery对象实例 (可以创建多个应用)
    app = Celery('luffy',)
    # app2 = Celery('luffy_shop')
    
    # 2. 加载配置 (给应用对象指定任务队列以及结果队列)
    app.config_from_object('mycelery.config')
    
    # 3. 自动发现任务
    app.autodiscover_tasks(['mycelery.sms', 'mycelery.send_code'])
    
    

  • 在项目目录下输入命令

    celery -A mycelery.main worker --loglevel=info -P eventlet
    

  • 此时将任务加载到队列中了

    

  • 此时项目中使用

                from mycelery.sms.tasks import send_code
                send_code.delay(mobile,sms_code)
    

  • 启动任务

    celery  -A mycelery.main worker --loglevel=info -P eventlet
    

  此时发送的验证码是异步发送的，所有效率是很高的！