前言

当我们的一个请求任务，里面功能不叫复杂，逻辑处理比较多，涉及业务函数处理也比较多的时候，为做好业务解耦，和更好的维护我们此时需要引入信号机制。信号的主要作用其实在框架核心功能或者一些Flask扩展发生工作时定制一些用户行为信息进行通知，便于帮助你解耦应用。

而且本身Flask也内置了一些内部的信号信息，进行广播通知如：

_signals = Namespace()

• template_rendered = _signals.signal("template-rendered")
• before_render_template = _signals.signal("before-render-template")
• request_started = _signals.signal("request-started")
• request_finished = _signals.signal("request-finished")
• request_tearing_down = _signals.signal("request-tearing-down")
• got_request_exception = _signals.signal("got-request-exception")
• appcontext_tearing_down = _signals.signal("appcontext-tearing-down")
• appcontext_pushed = _signals.signal("appcontext-pushed")
• appcontext_popped = _signals.signal("appcontext-popped")
• message_flashed = _signals.signal("message-flashed")

1 安装信号依赖库

 
pip install blinker

2 请求开始前的信号发送示例代码：

if __name__ == '__main__':
    app = create_app()


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

    from flask import Flask,request_started

    request_started.connect(request_started_fun)  # flask内置的信号，模板渲染的信号
    # run_task_fib(20)
    @app.route('/signal/')
    def template_signal():
        return '请求发生发送信号！！'


    print(app.url_map)
    app.run(host='127.0.0.1', port='8808', debug=True,threaded=False)

启动访问我们的接口：http://127.0.0.1:8808/signal/

127.0.0.1 - - [01/Mar/2021 17:04:38] "GET /signal/ HTTP/1.1" 200 -
信号接收: <Flask 'app'>
MiddlewareTraceLogger-----before_request
MiddlewareTraceLogger-----after_request=
sssssssssss 200 OK

2 使用装饰器自定义信号

2.1定义装饰器信号：

# 参数：信号名，信号的发送者
# 作用：根据信号名创建信号，然后发送信号，参数是发送者
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, **kw):
            func(*args, **kw)

        signal_listen(s_name, func)
        return inner

    return wrapper

2.2定义装饰器使用

if __name__ == '__main__':
    app = create_app()

    from common.ext.signal_wrapper import signal_handle


    @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 common.ext.signal_wrapper import signal_send
        signal_send('wx_notify_third_inters_error', source='ThirdInternalErrorException', traceback='以长沙哈哈')
        return "信号自定义演示"


    print(app.url_map)
    app.run(host='127.0.0.1', port='8808', debug=True, threaded=False)

启动服务访问地址：http://127.0.0.1:8808/wx_notify 查看控制台日志输出：

2021-03-01 17:11:43.378 | INFO     | MiddlewareTraceLogger-----before_request
common.ext.trace_logger:接收到了第三方接口请求处理异常信号通知 by 'ThirdInternalErrorException', data {'traceback': '以长沙哈哈'}
trace_add_log_recordMiddlewareTraceLogger-----after_request=
:sssssssssss 200 OK
50 - {"traceid": "442986cbb7344c089f14d7e34d86abae", "trace_index": 1, "event_des": "请求开始", "msg_dict": {"headers": {"X-Access-Token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ4aWFvemhvbmd0b25neHVlIiwiZXhwIjoxNjE0NDExMTE4LCJpYXQiOjE2MTQyMzgzMTgsImF1ZCI6Ind3dy54aWFvemhvbmcuY29tIiwic3ViIjoienl4Iiwic2NvcGVzIjpbIm9wZW4iXSwiZGF0YSI6eyJ1c2VybmFtZSI6InhpYW96aG9uZyIsInVzZXJpZCI6IjEifX0.lDSBGm6houMka35uS_JFBbQYs1EYn4EpBjygfUS0cLU", "User-Agent": "PostmanRuntime/7.26.8", "Accept": "*/*", "Cache-Control": "no-cache", "Postman-Token": "bcfad948-f89a-4bb9-9fd6-075cacaf117f", "Host": "127.0.0.1:8808", "Accept-Encoding": "gzip, deflate, br", "Connection": "keep-alive"}, "url": "http://127.0.0.1:8808/wx_notify", "method": "GET", "ip": "127.0.0.1", "params": {"args": "", "form": "", "json": ""}, "start_time": "2021-03-01 17:11:43.377022"}}
2021-03-01 17:11:43.379 | INFO     | common.ext.trace_logger:trace_add_log_record:50 - {"traceid": "442986cbb7344c089f14d7e34d86abae", "trace_index": 2, "event_des": "请求结束", "msg_dict": {"cost_time": "5.0ms", "rsp_data": "信号自定义演示"}}
127.0.0.1 - - [01/Mar/2021 17:11:43] "GET /wx_notify HTTP/1.1" 200 -

End

纯属个人实践中相关经验之谈，如有纰漏，还希望大佬们多多提点！

小钟同学 | 文  【原创】| QQ：308711822