第十阶段 -- Flask框架05：【Flask高级04：信号机制】

1. 信号机制

​ 大白话来说，类似于两方属于敌对关系时，某人在敌对方阵营进行交谈，一旦遇到特殊情况，某人便会发送信号，他的同伙接收（监听）到他发的信号后，同伙便会做出一系列的应对策略(杀进去|撤退)。

​ flask中的信号使用的是一个第三方插件，叫做blinker。通过pip list看一下，如果没有安装，通过以下命令即可安装 blinker：pip install blinker

• 自定义信号步骤：第一是创建一个信号，第二是监听一个信号，第三是发送一个信号。

1. 创建信号：定义信号需要使用到blinker这个包的Namespace类来创建一个命名空间。比如定义一个在访问了某个视图函数的时候的信号。示例代码如下：

# Namespace的作用：为了防止多人开发的时候，信号名字冲突的问题
from blinker import Namespace
mysignal = Namespace()
signal1 = mysignal.signal('信号名称')

2. 监听信号：监听信号使用signal1对象的connect方法，在这个方法中需要传递一个函数，用来监听到这个信号后做该做的事情。示例代码如下：

def func1(sender,uname):
	print(sender)
    print(uname)
    
signal1.connect(func1)

3. 发送信号：发送信号使用signal1对象的send方法，这个方法可以传递一些其他参数过去。示例代码如下：

signal1.send(uname='momo')

• 代码演示：

from flask import Flask
from blinker import Namespace
app = Flask(__name__)

#【1】信号机制   3步走
# Namespace：命名空间
#1.定义信号
sSpace = Namespace()
fire_signal = sSpace.signal('发送信号火箭')

#2.监听信号
def fire_play(sender):
    print(sender)
    print("start play")
fire_signal.connect(fire_play)

#3.发送一个信号
fire_signal.send()

if __name__ == '__main__':
    app.run(debug=True)

• Flask官方中文网信号：http://docs.jinkan.org/docs/flask/signals.html

2. 信号使用场景：存储用户登录日志

1. 信号使用场景：

   • 定义一个登录的信号，以后用户登录进来以后
   • 就发送一个登录信号，然后能够监听这个信号
   • 在监听到这个信号以后，就记录当前这个用户登录的信息
   • 用信号的方式，记录用户的登录信息即登录日志

2. 编写一个signals.py文件创建登录信号

from blinker  import  Namespace
from datetime import datetime
from flask import request,g

namespace  = Namespace()

#创建登录信号
login_signal = namespace.signal('login')

def login_log(sender):
    # 用户名  登录时间  ip地址
    now = datetime.now()
    ip = request.remote_addr
    log_data = "{uname}*{now}*{ip}".format(uname=g.uname, now=now, ip=ip)
    with open('login_log.txt','a') as f:
        f.write(log_data + "\n")
        f.close()

#监听信号
login_signal.connect(login_log)

3. 使用信号存储用户登录日志

from flask import Flask,request,g

from signals import  login_signal
app = Flask(__name__)

@app.route('/login/')
def login():
    # 通过查询字符串的形式来传递uname这个参数
    uname = request.args.get('uname')
    if uname:
        g.uname = uname
        # 发送信号
        login_signal.send()
        return '登录成功！'
    else:
        return '请输入用户名！'

if __name__ == '__main__':
    app.run(debug=True)

3. 内置信号

Flask 内置了10个常用的信号：

1. template_rendered：模版渲染完成后的信号。

2. before_render_template：模版渲染之前的信号。

3. request_started：请求开始之前，在到达视图函数之前发送信号。

4. request_finished：请求结束时，在响应发送给客户端之前发送信号。

5. request_tearing_down：请求对象被销毁时发送的信号，即使在请求过程中发生异常也会发送信号。

6. got_request_exception：在请求过程中抛出异常时发送信号，异常本身会通过exception传递到订阅（监听）的函数中。一般可以监听这个信号，来记录网站异常信息。

7. appcontext_tearing_down：应用上下文被销毁时发送的信号。

8. appcontext_pushed：应用上下文被推入到栈上时发送的信号。

9. appcontext_popped：应用上下文被推出栈时发送的信号。

10. message_flashed：调用了Flask的flash方法时发送的信号。

• 代码演示
  1. template_rendered的使用：

from flask import Flask,request,g,template_rendered,got_request_exception,render_template

app = Flask(__name__)

# 内置信号
# 模版渲染完成后的信号。
def template_rendered_func(sender,template,context):
    print(sender)  # 发送者
    print(template)  # 跳转到的模版名称
    print(context)  # 跳转到模版时带过去的参数
template_rendered.connect(template_rendered_func) 

@app.route('/')
def hello_world():
    return render_template("index.html",data="momo")  # 去看发送信号的底层

if __name__ == '__main__':
    app.run(debug=True)

​ 2. got_request_exception的使用：

from flask import Flask,request,g,template_rendered,got_request_exception,render_template
app = Flask(__name__)

# 内置信号
# got_request_exception：在请求过程中抛出异常时发送信号，异常本身会通过exception传递到订阅（监听）的函数中。
# 一般可以监听这个信号，来记录网站异常信息。
# def request_exception_log(sender,*args,**kwargs):  # 掌握写参数技巧
#     print(sender)
#     print(args)
#     print(kwargs)

def request_exception_log(sender,exception):
    print(sender)
    print(exception)  # division by zero

got_request_exception.connect(request_exception_log)

@app.route('/')
def hello_world():
    # 制造bug
    a = 1/0
    return render_template("index.html",data="momo")

if __name__ == '__main__':
    app.run(debug=True)

4. 示例

• 【32_singal_demo.py】

from flask import Flask,request,g,template_rendered,flash,render_template,got_request_exception
from blinker import  Namespace
app = Flask(__name__)
from signals import login_signal
#自定义信号

#1.创建信号
sSpace = Namespace()
mysignal = sSpace.signal("发送一个火箭信号")
#2监听信号
def  fire_play(sender):
    print(sender)
    print("开火")

mysignal.connect(fire_play)

#3.发送信号
mysignal.send()

# 信号的使用场景
# 定义一个登录的信号，以后用户登录进来以后
# 就发送一个登录信号，然后能够监听这个信号
# 在监听到这个信号以后，就记录当前这个用户登录的信息
# 用信号的方式，记录用户的登录信息即登录日志


# @app.route('/')
# def hello_world():
#     return 'Hello World!'

@app.route('/login/')
def login():
    # 通过查询字符串的形式来传递uname这个参数
    uname = request.args.get('uname')
    if uname:
        g.uname = uname
        # 发送信号
        login_signal.send()
        return '登录成功！'
    else:
        return '请输入用户名！'

# flask内置信号的使用；个数：10个
# template_rendered：模版渲染完成后的信号
def  rendered_func(sender,template,context):
    print(sender)  #发送者  32_signal_demo
    print(template)  #跳转到的模版名称  index.html
    print(context)  #跳转到模版页面时带过去的参数  { }

template_rendered.connect(rendered_func)

# got_request_exception：在请求过程中抛出异常时发送信号，
# 异常本身会通过exception传递到订阅（监听）的函数中。
# 一般可以监听这个信号，来记录网站异常信息。
# def request_error(sender,*args,**kwargs):  #掌握写参数技巧
#     print(sender)
#     print(args)
#     print(kwargs)

def request_error(sender,exception):  # 掌握写参数技巧
    print(sender)
    print(exception)

got_request_exception.connect(request_error)

@app.route('/')
def hello_world():
    # 
    a = 1/0
    return render_template("index.html",data = "beijing")  # 去看源码；找到flask内置template_rendered信号  发送的部分代码

if __name__ == '__main__':
    app.run(debug=True)

• 【signals.py】

from blinker import Namespace
from datetime import  datetime
from flask  import  request,g

#创建一个登录信号
momoSpace = Namespace()
login_signal = momoSpace.signal("创建一个登录信号")

#监听信号
def  login_log(sender):
    #用户名   时间   ip
    uname = g.uname
    now = datetime.now()
    ip =request.remote_addr
    log_data="{uname}*{now}*{ip}".format(uname=uname,now=now,ip=ip)
    with  open('login_log.txt','a') as f:
        f.write(log_data+"\n")
        f.close()

login_signal.connect(login_log)

• 【index.html】

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
     <h2>我是用来渲染数据使用的</h2>
     <p>{{data}}</p>
</body>
</html>