flask官网文档——信号

Flask 框架中的信号基于 blinker，其主要就是让开发者可是在 flask 请求过程中定制一些用户行为

安装：pip3 install blinker

flask 内置信号

是 flask 内置就提供了很多的信号，导入之后就可以直接监听到。

信号官方文档：https://dormousehole.readthedocs.io/en/latest/signals.html
内置信号：https://dormousehole.readthedocs.io/en/latest/api.html#core-signals-list

from flask import Flask, request_started


app = Flask(__name__)


def request_started_fun(sender):
    print('信号接收:', sender)


request_started.connect(request_started_fun)  # flask内置的信号，模板渲染的信号


# run_task_fib(20)
@app.route('/signal/')
def template_signal():
    return '请求发生发送信号！！'

自定义信号

在开发的过程中，除了使用默认的之外，经常需要自己自定义进行二次开发。

from flask import Flask, request_started

from signal_decorator import signal_handle
from blinker import signal

app = Flask(__name__)


def wx_notify_third_inters_error(sender, **kw):
    print("接收到了第三方接口请求处理异常信号通知 by %r, data %r" % (sender, kw))


name_signal = signal("wx_notify_third_inters_error")  # 这里其实没有创建新的信号，就是之前的name信号
name_signal.connect(wx_notify_third_inters_error, weak=False)  # 绑定了订阅者


@app.route("/wx_notify")
def wx_notify():
    name_signal.send(source='ThirdInternalErrorException', traceback='以长沙哈哈')
    return "信号自定义演示"

自定义信号装饰器

为了更方便进行项目开发，可以自定义装饰器对信号的创建与发送进行封装，使项目开发变的更加简单。

首先封装装饰器代码

# filename: signal_decorator.py

from blinker import signal


def signal_send(name, source='anoymous', **kw):
    """
    创建信号并发送消息
    参数：name 信号名，source:信号的发送者
    作用：根据信号名创建信号，然后发送信号，参数是发送者
    """
    name_signal = signal(name)  # 这里根据name创建一个信号
    ret = name_signal.send(source, **kw)  # 发送一个信号
    return ret


def signal_listen(name, handler):
    """
    接受信号
    参数：信号名，订阅者(用于收到信号就调用函数)
    作用：得到信号对象，绑定订阅者
    """
    name_signal = signal(name)  # 这里其实没有创建新的信号，就是之前的name信号\
    name_signal.connect(handler, weak=False)  # 绑定了订阅者


def signal_handle(name, *args, **kw):
    """
    信号接受装饰器：
    参数：信号名
    针对的 func：装饰器原理是针对 func 的，传入的 func 就是这个信号的订阅者
    """
    s_name = name

    def wrapper(func):
        def inner(*args, **kwargs):
            func(*args, **kwargs)

        signal_listen(s_name, func)
        return inner

    return wrapper

在主程序中导入装饰器并进行使用

from flask import Flask, request_started

from signal_decorator import signal_handle

app = Flask(__name__)


@signal_handle("wx_notify_third_inters_error")
def wx_notify_third_inters_error(sender, **kw):
    print("接收到了第三方接口请求处理异常信号通知 by %r, data %r" % (sender, kw))


@app.route("/wx_notify")
def wx_notify():
    # 发送信号
    from signal_decorator import signal_send
    signal_send('wx_notify_third_inters_error', source='ThirdInternalErrorException', traceback='以长沙哈哈')
    return "信号自定义演示"