还在篮子里

beehive 源码详解 · 语雀

beehive 源码详解

Overview

看一下作者本人的注释

// Package bees is Beehive's central module system.

beehive 非常有趣的在于各逻辑的解耦设计,这不仅让本身功能操作简单,也让扩展变得关注点少了很多,只需要一点学习成本就可以扩展自己的 beehive

首先解释一下 bee hive 中 的概念

bee 代表的是我们常见的 Worker 也就是说,实际的行为是由这些 小蜜蜂执行的。他们就类似于采蜜的工人,采集到了之后统一放回来处理

hive 是蜂房,也就是我们常见的 WorkerPool 不同的是,她更像一个 Facotry ,什么意思呢?她可以创建专属的 bee 。在极少的配置下,比如只需要配置上一个 token 即可。就可以生成一只 bee 专门针对某一种蜜工作了。

chain 又是什么? chain 就是链接事件与处理的工具,我们认为 bee 采回蜜是一个事件,总不可能采回来啥都不干吧。针对不同的 蜜 我们就有不同的反应,就有不同的 action

比如某人的 blog 更新了 ,rss bee 接收到了之后飞回来,我们就可以再要求 email bee 把这其中的信息通过邮件发给我们或者我们想发给的人。

这就需要 chain 来联系 event 和 action 了

Landscape

API Register

beehive-api (1).svg

成组的 API 实现了 Resource 接口注册到 Container 的路由 Route 中。

帮助理解

在文件中写好了 作者 实现的 Handle 的实现来注册 http 请求

image.png

API 只是供调用,逻辑重点在 bees 这个包里的实现。

Bee

首先是有的接口

 1
 2// BeeInterface is an interface all bees implement.
 3type BeeInterface interface {
 4    // Name of the bee
 5    Name() string
 6    // Namespace of the bee
 7    Namespace() string
 8
 9    // Description of the bee
10    Description() string
11    // SetDescription sets a description
12    SetDescription(s string)
13
14    // Config returns this bees config
15    Config() BeeConfig
16    // Options of the bee
17    Options() BeeOptions
18    // SetOptions to configure the bee
19    SetOptions(options BeeOptions)
20
21    // ReloadOptions gets called after a bee's options get updated
22    ReloadOptions(options BeeOptions)
23
24    // Activates the bee
25    Run(eventChannel chan Event)
26    // Running returns the current state of the bee
27    IsRunning() bool
28    // Start the bee
29    Start()
30    // Stop the bee
31    Stop()
32
33    LastEvent() time.Time
34    LogEvent()
35    LastAction() time.Time
36    LogAction()
37
38    Logln(args ...interface{})
39    Logf(format string, args ...interface{})
40    LogErrorf(format string, args ...interface{})
41    LogFatal(args ...interface{})
42
43    SetSigChan(c chan bool)
44    WaitGroup() *sync.WaitGroup
45
46    // Handles an action
47    Action(action Action) []Placeholder
48}

和他的基础实现

 1// Bee is the base-struct to be embedded by bee implementations.
 2type Bee struct {
 3    config BeeConfig
 4
 5    lastEvent  time.Time
 6    lastAction time.Time
 7
 8    Running   bool
 9    SigChan   chan bool
10    waitGroup *sync.WaitGroup
11}

这里需要注意的是 Run 接口,在 Base-Struct Bee 中该方法 是空的实现,因为 Run 是 Bee 的生命周期开始处,是自动开始的。

WebBee 实现

简单的看某一个实现即可

1// WebBee is a Bee that starts an HTTP server and fires events for incoming
2// requests.
3type WebBee struct {
4    bees.Bee
5
6    addr string
7
8    eventChan chan bees.Event
9}

可以很清楚的指导,这个 WebBee 中的 eventChan 正是通知的地方,也就是上文所说的 Chain 的开始处。注意的是由于松耦合的设计,任何 Bee 都可以成为 Chain 上的一环,只要它能触发事件。或者监听事件。

func (mod *WebBee) Run(cin chan bees.Event)
 1
 2// Run executes the Bee's event loop.
 3func (mod *WebBee) Run(cin chan bees.Event) {
 4    mod.eventChan = cin
 5
 6    srv := &http.Server{Addr: mod.addr, Handler: mod}
 7    l, err := net.Listen("tcp", mod.addr)
 8    if err != nil {
 9        mod.LogErrorf("Can't listen on %s", mod.addr)
10        return
11    }
12    defer l.Close()
13
14    go func() {
15        err := srv.Serve(l)
16        if err != nil {
17            mod.LogErrorf("Server error: %v", err)
18        }
19        // Go 1.8+: srv.Close()
20    }()
21
22    select {
23    case <-mod.SigChan:
24        return
25    }
26}

同时 WebBee 也有一个方法 ServeHTTP 来实现 http.Handle 来处理请求。

这里也就是前文所说的 注册的那些 API 的部分来源,每一个 bee 自身实现的自动注册暴露给外界调用。

1func (mod *WebBee) ServeHTTP(w http.ResponseWriter, req *http.Request)

Event

package:beehive/bees/event.go

刚才讲到了 触发事件 event 的 WebBee 实现,现在我们来看 event 的实现

实际上是通过 这个函数实现的

 1// handleEvents handles incoming events and executes matching Chains.
 2func handleEvents() {
 3    for {
 4        event, ok := <-eventsIn
 5        ···
 6        bee := GetBee(event.Bee)
 7        (*bee).LogEvent()
 8
 9        ···
10        go func() {
11            defer func() {
12                if e := recover(); e != nil {
13                    log.Printf("Fatal chain event: %s %s", e, debug.Stack())
14                }
15            }()
16
17            execChains(&event)
18        }()
19    }
20}

省略了 日志部分。可以看到 handleEvents 通过接受通道里的 event,并检查 event 中的 Bee 作为 标志找到对应的 Bee 唤醒。

这里我们可以看到 最后进入了 Chains 中执行,即上文所说的 Chain 将 Event 和 Action 链接了起来,让 Bee 之间能够协作。

chain

package:beehive/bees/chains.go

chain 中实际上是调用 Actions 通过下面的 execActions 函数

1    for _, el := range c.Actions {
2            action := GetAction(el)
3            if action == nil {
4                log.Println("\t\tERROR: Unknown action referenced!")
5                continue
6            }
7            execAction(*action, m)
8        }

我们来看看 Action 的执行。

Action Exec

package: beehive/bees/actions.go

actions 既可以运行设置中的 options 也可以直接在 运行函数中传入需要运行的 options

func execAction(action Action, opts map[string]interface{}) bool

bee-actions (1).svg

Summary

整个执行逻辑是如此了,其他还有一些

  • 日志处理:用于跟踪 bee 和 hive 的情况
  • Config:保存配置文件,每一次启动可以重新放飞以前的 Bee 们
  • Signal:beehive 拦截了一些 Signal 的 Kill 等信号来执行优雅退出,避免了 Config 等的丢失。
  • Run Flag:执行的附带参数,设定 Beehive 整个应用的监听端口和版本配置。

发表评论

电子邮件地址不会被公开。 必填项已用*标注