使用事件

事件 是在应用程序的生命周期中, 在某些特殊的时间点被 repoze.bfg 框架 "广播" 出来的一种对象. 在大多数 repoze.bfg 应用中, 我们都不必使用, 关注或者理解它, 但是在我们做一些进阶的操作时, 比如对于个站点进行"更换皮肤"(skinning)操作,而这个操作是跟访问这个站点的域名相关的, 在这种情况之下, 事件机制可能会帮到你.

在 repoze.bfg 中, 事件永远是被框架所广播的. 我们注册一个 订阅者 (subscriber)就可以利用事件了. 一个订阅者就是一个function, 接受一个参数`event`:

def mysubscriber(event):
    print event

上面的代码就是一个订阅者, 被调用的时候它简单地把事件输出到控制台.

如果只有一个订阅者function, 还不足以让它在事件发生的时候被调用. 要做到这一点, 我们需要修改 应用程序注册表 (application registry), 也就是修改应用的 configure.zcml 文件. 这里有一段XML文档, 示例了我们如何把上面的 mysubscriber 函数作为一个订阅者加入到 configure.zcml 中, 在这里我们假设它存在于 subscribers.py 模块中.

<subscriber
  for="repoze.bfg.interfaces.INewRequest"
  handler=".subscribers.mysubscriber"
/>

上面例子的意思是，每当 repoze.bfg 框架抛出一个提供 INewRequest 接口的事件对象, mysubscriber 函数就会被调用, 如我们所见, 订阅是针对某（几）个 接口interface 的. 发送到订阅者的事件对象一定会有一个interface. 你可以利用这个interface自身来判断有哪些事件属性可资利用.

举例而言, 如果我们在 subscribers.py 中创建了一个如下的事件监听函数:

def handle_new_request(event):
    print 'request', event.request

def handle_new_response(event):
    print 'response', event.response

我们可以配置这些方法, 让它们在恰当的时间点被框架调用，只需要我们把如下代码添加到应用的 configure.zcml 文件:

<subscriber
  for="repoze.bfg.interfaces.INewRequest"
  handler=".subscribers.handle_new_request"
/>

<subscriber
  for="repoze.bfg.interfaces.INewResponse"
  handler=".subscribers.handle_new_response"
/>

这样的配置会让两个函数在 应用程序注册表 中注册为订阅者. 当应用程序运行时, 每一个新的请求和应答都会被输出到控制台. 我们知道 INewRequest 事件拥有一个 request 属性, 并且知道它是一个 WebOb 请求, 因为根据 repoze.bfg.interfaces.INewRequest 的定义上说明必然如此. 类似的, 我们也可以知道, INewResponse 拥有一个 response 属性, 它是由应用程序构建的, 根据 repoze.bfg.interfaces.INewResponse 的定义, 这也是必然的. 这两个接口的定义可以在 events_module API一章中找到.

ZCML的 subscriber 元素包含两个值: for 是这个订阅者为哪些接口注册(它限制了订阅者只能接受指定类型的事件), handler 是一个Python的以点分隔的路径, 指向订阅者函数.

订阅者函数的返回值将会被框架忽略.

from zope.interface import alsoProvides
from zope.interface import Interface

class IJSONRequest(Interface):
    """ A request from a JSON client that sets and Accept:
    application/json header """

def categorize_request(event):
    request = event.request
    accept = request.headers.get('accept', '')
    if 'application/json' in accept:
        alsoProvides(request, IJSONRequest)

<subscriber
  for="repoze.bfg.interfaces.INewRequest"
  handler=".subscribers.categorize_request"
/>

<!-- html default view -->
<view
  for=".models.MyModel"
  request_type="repoze.bfg.interfaces.IRequest"
  view=".views.html_view"/>

<!-- JSON default view -->
<view
  for=".models.MyModel"
  request_type=".interfaces.IJSONRequest"
  view=".views.json_view"/>