Flask Signals 入门

Flask Signals 入门

本文首发于Gevin的博客

原文链接:Flask Signals 入门

未经 Gevin 授权,禁止转载

1. 如何理解Flask Signals

Flask Signal非常简单易用,能大大降低代码的耦合度,也能够让基于Flask开发的系统更加健壮。然而,虽然Flask Signal上手很容易,但它却不是Flask开发中一个入门级的功能,也不是每个开发者都会想到去使用的功能,这主要是由于不理解这个机制造成的。因此,使用Flask Signal前,首先要理解Flask Signal是什么。

什么是Signal?Flask官方文档的描述的过于言简意赅,资深开发者能够马上明白,而初学者恐怕摸不到头脑,因此Gevin对官方文档的描述做简单扩展:Signal用于解耦系统的行为和业务逻辑,这种解耦是通过当某些行为被触发时,自动发送定义好的一种信号,与这个信号绑定的一些业务逻辑或行为,接收到这个信号后,会自动执行各自相应的业务逻辑。与该信号绑定的业务逻辑,可以是事先预定义好的,也可以是在后续开发中随需求变动新增上去的,基于signal的机制,系统会更加稳定和易于扩展,也使得系统的业务逻辑更加清晰 —— 当某个行为触发时,发送一个信号即可,所有与该行为有关的业务逻辑或行为都会自动触发,从而实现了解耦。换句话说,Flask Signal是观察者模式的一种实现,它使得我们开发的系统,更加符合开闭原则

『设计模式』既是编码典型问题的经典解决方案,也算是一种『行话』,不是代码初学者需要接触的内容,所以才导致了Flask Signal对资深开发者和初学者而言,在理解上出现这么大的差异。理解了Signal的本质,使用就不是问题了,如果Gevin的解释还无法让你理解,恐怕你要从『观察者模式』入手了,但Gevin建议,没有足够的代码积累,不要过早接触太多设计模式,否则无异于揠苗助长。

2. Flask Signals的使用

Flask signal的使用非常简单,Flask 官方文档把signal介绍的过于复杂,不利于入门,在理解了signal后,只要学会以下几点便可以轻松掌握signal的使用。

(1)Signal的创建

Signal的创建只需下面3行代码即可完成:


from blinker import Namespace
my_signals = Namespace()
model_saved = my_signals.signal('model-saved')

(2)Signal的发送

Signal的发送通过成员函数 send()即可完成,send()函数的第一个参数为signal的sender,在class中发送signal和在function中传递的sender参数略有不同,class中sender=selffunctionsender=current_app._get_current_object(),即:


# In case send signal in a class:
class Model(object):
    ...

    def save(self):
        model_saved.send(self)


# In case send signal in a function:
def save_model():
    ...
    
    model_saved.send(current_app._get_current_object())

sender()函数除了sender参数外,还可以添加多个可选参数,这些可选参数是为signal的订阅者使用的,具体例子见下一小节。

(3)编写Signal的订阅者

Signal的订阅者是一些订阅了指定signal(如上文中的model_saved)的函数,当signal被激活(即调用send()函数发送signal)时,会自动触发这些订阅者的调用,以完成某些功能。将一个普通函数变为signal的订阅函数非常简单,只要加一个decorator即可,仍以上面signal为例,定义一个订阅者方法如下:


@model_saved.connect_via(app)
def on_model_saved():
    # do something ...

对于大型项目,代码组织比较复杂,也许app是在系统运行时创建的,上面代码中的app可以用current_app._get_current_object()取代。

除了connect_viaconnect也可以,即:


@model_saved.connect
def on_model_saved():
    # do something ...

如果订阅者函数有参数,需要在发送signal时,将相关参数作为signal.send()函数的可选参数传入,这样订阅者函数可以接收到相应参数,举个详细的例子:


from blinker import Namespace
from . import models

# Define a signal
octblog_signals = Namespace()
post_visited = octblog_signals.signal('post-visited')


# Define a subscriber
@post_visited.connect
def on_post_visited(sender, post, **extra):
    tracker = models.Tracker()
    tracker.post = post

    ...

    tracker.save()

# Emit signal in a function    
def post_detail(slug, is_preview=False):
    post = models.Post.objects.get_or_404(slug=slug, post_type=post_type)
    data['post'] = post

    # do something
    ...

    # send signal
    if not is_preview:
        signals.post_visited.send(current_app._get_current_object(), post=post)
    
    ...

总结

Flask Signal上手简单,功能强大,最关键的是它能够解耦业务和行为,使代码的逻辑更简洁,推荐使用。

稍后有时间我会在GitHub上放一个简单但完整的Flask Signal使用的小案例,如果大家有好的应用场景,欢迎给我留言~

点击获取转载授权

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容