Finitomata 项目教程

1. 项目介绍

Finitomata 是一个基于 Elixir 语言的有限状态机（FSM）实现库。它提供了一个模板，允许开发者专注于业务逻辑，而不是过程管理和状态转换的一致性调整。Finitomata 可以从 PlantUML 或 Mermaid 的文本表示中生成 FSM 实现，支持多种配置和回调，适用于复杂的业务流程管理。

2. 项目快速启动

安装

首先，确保你已经安装了 Elixir 和 Mix。然后，在你的项目中添加 Finitomata 作为依赖：

def deps do
  [
    {:finitomata, "~> 0.26"}
  ]
end

运行 mix deps.get 来安装依赖。

定义 FSM

创建一个新的 Elixir 模块来定义你的 FSM：

defmodule MyFSM do
  @fsm """
  [*] --> s1 : to_s1
  s1 --> s2 : to_s2
  s1 --> s3 : to_s3
  s2 --> [*] : ok
  s3 --> [*] : ok
  """

  use Finitomata, fsm: @fsm, syntax: :state_diagram

  @impl Finitomata
  def on_transition(:s1, :to_s2, _event_payload, state_payload) do
    {:ok, :s2, state_payload}
  end

  def on_transition(:s1, :to_s3, _event_payload, state_payload) do
    {:ok, :s3, state_payload}
  end
end

启动 FSM

在你的应用中启动 FSM：

{:ok, _pid} = Finitomata.start_link()
Finitomata.start_fsm(MyFSM, "My first FSM", %{foo: :bar})

# 触发状态转换
Finitomata.transition("My first FSM", [:to_s2, nil])

# 获取当前状态
Finitomata.state("My first FSM")

3. 应用案例和最佳实践

应用案例

Finitomata 可以用于各种需要状态管理的场景，例如：

• 订单处理：订单从创建到完成的各个状态转换。
• 工作流管理：任务从开始到结束的各个阶段。
• 用户状态管理：用户从注册到激活的各个状态。

最佳实践

• 明确状态和事件：在定义 FSM 时，确保每个状态和事件都有明确的含义。
• 使用回调：利用 on_transition 等回调函数来处理状态转换时的业务逻辑。
• 测试覆盖：编写单元测试来确保 FSM 的每个状态转换都能正确执行。

4. 典型生态项目

Finitomata 可以与其他 Elixir 生态项目结合使用，例如：

• GenStage：用于处理数据流和任务分发。
• NimbleOptions：用于配置管理。
• NimbleParsec：用于解析复杂的文本格式。

通过结合这些项目，可以构建更加复杂和强大的应用。