使用llfsm(连理状态机)实现一个带状态的Dog类

llfsm(连理状态机)是一个开源的状态机项目, 使用编程语言C++. 它在github的下载地址是:

https://github.com/stefangao/llfsm

 

llfsm的一个状态呈树状的可嵌套的状态机. 功能强大, 扩展性强, 可以满足多种应用的需求, 使用llfsm作为应用的基本框架. 

本文通过使用llfsm创建一个带状态Dog类来讲述llfsm的使用.

 

这只狗Dog类的需求如下:

1. 可以汪汪叫 bark()

2. 可以打呼噜 snore()

3. 可以遛弯 walk()

这是Dog提供的三个接口, 对于无状态的Dog, 它的实现比较简单:

class Dog
{
public:
    void snore()
    {
        LLLOG("z~~Z~~~\n");
    }

    void bark()
    {
        LLLOG("wang wang ~~\n");
    }

    void walk()
    {
        LLLOG("walk..\n");
    }
}

这是一只无状态的狗, 外部类通过创建Dog的实例来使用它的功能, 什么时候调用Dog的接口由调用者控制, 逻辑和状态都在外部实现.

下面我们要通过llfsm对上述这个Dog做扩展, 使之成为一个有心跳,有状态的机器狗.

新的需求如下:

1. 狗在睡觉的时候每隔2秒打一次呼噜.

2. 狗在睡觉的时候听到响声, 会醒来, 吠叫一声. Dog在醒着的时候, 听见响声, 也会吠叫一声.

3. 狗在醒来时不停的走步, 走5步后, 再次进入睡觉状态.

 

欲让Dog有状态, 需使Dog继承自liani::FSM:

class Dog: public FSM

根据需求, Dog包含两个状态: 醒着(awake)　和　睡觉(sleep)，定义这两个状态的ID：

enum {AWAKE, SLEEP};

每个状态类继承自State，实现该状态内的功能．分别为：

    class Awake: public State
    {
    protected:
        virtual void onEnter() override;
        virtual void onExit() override;
        virtual bool onEventProc(const std::string& evtName, EvtStream& evtData) override;
        virtual void onHeartBeat() override;

    DEFINE_STATE_FACTORY_OF_FSM(Awake, Dog)
    };

    class Sleep: public State
    {
    protected:
        virtual void onEnter() override;
        virtual void onExit() override;
        virtual void onHeartBeat() override;

    DEFINE_STATE_FACTORY_OF_FSM(Sleep, Dog)
    };

onEnter：当进入该状态时调用的函数

onExit：当退出该状态时调用的函数

onEventProc: 在该状态激活时，收到event时的处理函数

onHeartBeat: 状态的心跳函数，启动后，每隔一定时间调用

 

下面对状态进行配置，llfsm是状态按树形分布的状态机，每个状态有一个父状态，根状态是S_ROOT，S_ROOT是每个状态机内置的隐藏节点，不可编程．每个状态的子状态最多只能有一个激活状态，状态只有在激活时才能处理事件或进行其它操作．

Dog的两个状态AWAKE和SLEEP是互斥的，他们不会同时激活．可以配置它们的父状态为S_ROOT．即：

在程序中的配置如下：

BEGIN_STATE_TABLE(Dog)
    STATE_ENTRY(AWAKE, Awake, S_ROOT, 0)
    STATE_ENTRY(SLEEP, Sleep, S_ROOT, SFL_ACTIVE)
END_STATE_TABLE()

STATE_ENTRY的第一个参数是待配置状态的ID，第二个参数为实现该状态的类，第三个参数为该状态的父状态，第四个参数是状态的标记．SFL_ACTIVE表示该状态默认激活．在上述配置中，AWAKE和SLEEP的父状态都是S_ROOT，SLEEP是默认激活状态，意味着当状态机启动后，首先会进入S_ROOT状态，因为S_ROOT的子状态中有默认激活状态SLEEP，所以SLEEP也会自动激活．

 

下面设置状态迁移：

Dog在SLEEP状态时，如果听到响声 (事件"SoundEvt"), 从SLEEP切换到AWAKE

Dog在AWAKE状态时，如果收到睡觉的事件 (事件"SleepEvt"), 从AWAKE切换到SLEEP

BEGIN_TRANS_TABLE(Dog, FSM)
    TRANS_ENTRY(SLEEP, "SoundEvt", AWAKE, TFL_TOPROC)
    TRANS_ENTRY(AWAKE, "SleepEvt", SLEEP)
END_TRANS_TABLE()

TRANS_ENTRY第一参数为源状态，第二个参数为事件（字符串类型），第三个参数为目标状态，即收到事件后从源状态切换到目标状态，第四个参数为迁移标记，TFL_TOPROC为在目标状态的事件函数（onEventProc）处理该事件，如果没有TFL_TOPROC, 则默认是在源状态的事件函数中处理．

 

Dog的全部源码如下：

//.h
class Dog: public FSM
{
protected:
    virtual void onStart() override;

public:
    void snore()
    {
        LLLOG("z~~Z~~~\n");
    }

    void bark()
    {
        LLLOG("wang wang ~~\n");
    }

    void walk()
    {
        LLLOG("walk..\n");
    }

DECLARE_STATE_TABLE()
DECLARE_TRANS_TABLE()

public:
    enum {AWAKE, SLEEP};

    class Awake: public State
    {
    protected:
        virtual void onEnter() override;
        virtual void onExit() override;
        virtual bool onEventProc(const std::string& evtName, EvtStream& evtData) override;
        virtual void onHeartBeat() override;

    DEFINE_STATE_FACTORY_OF_FSM(Awake, Dog)
    };

    class Sleep: public State
    {
    protected:
        virtual void onEnter() override;
        virtual void onExit() override;
        virtual void onHeartBeat() override;

    DEFINE_STATE_FACTORY_OF_FSM(Sleep, Dog)
    };
};

//.cpp
BEGIN_STATE_TABLE(Dog)
    STATE_ENTRY(AWAKE, Awake, S_ROOT, 0)
    STATE_ENTRY(SLEEP, Sleep,  S_ROOT, SFL_ACTIVE)
END_STATE_TABLE()

BEGIN_TRANS_TABLE(Dog, FSM)
    TRANS_ENTRY(SLEEP, "SoundEvt", AWAKE, TFL_TOPROC)
    TRANS_ENTRY(AWAKE, "SleepEvt", SLEEP)
    TRANS_ENTRY(AWAKE, "SoundEvt", S_NONE)
END_TRANS_TABLE()

void Dog::onStart()
{
　　 //post SoundEvt after 5 seconds
    delayPostEvent(5000, "SoundEvt");
}

void Dog::Awake::onEnter()
{
    LLLOG("[AWAKE enter]\n");
    startHeartBeat(1000);
}

bool Dog::Awake::onEventProc(const std::string& evtName, EvtStream& evtData)
{
    if (evtName == "SoundEvt")
    {
        self()->bark();
    }
    return true;
}

void Dog::Awake::onHeartBeat()
{
    self()->walk();

    int hbCount = getHeartBeatCount();
    if (hbCount == 5)
        postEvent("SleepEvt");
}

void Dog::Awake::onExit()
{

}

void Dog::Sleep::onEnter()
{
    LLLOG("[SLEEP enter]\n");
    startHeartBeat(2000);
}

void Dog::Sleep::onHeartBeat()
{
    self()->snore();
}

void Dog::Sleep::onExit()
{

}

下载全部工程请访问github:

https://github.com/stefangao/llfsm

运行TestCase1，即可调试和查看运行结果．运行结果粘贴如下：

 

Please type the number of test case to run:

[TestCase1]: 1

[TestCase2]: 2

[TestCase3]: 3

[TestCase4]: 4

[TestCase5]: 5

(type 0 to stop the running test case)

1
1=>()
[SLEEP enter]

z~~Z~~~

z~~Z~~~

[AWAKE enter]

wang wang ~~

walk..

walk..

walk..

walk..

walk..

[SLEEP enter]

z~~Z~~~

z~~Z~~~

z~~Z~~~

z~~Z~~~

z~~Z~~~

z~~Z~~~

z~~Z~~~

z~~Z~~~

z~~Z~~~