AASM 状态机库使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00439/article/details/142193944

AASM 状态机库使用教程

aasm AASM - State machines for Ruby classes (plain Ruby, ActiveRecord, Mongoid, NoBrainer, Dynamoid) 项目地址: https://gitcode.com/gh_mirrors/aa/aasm

1. 项目介绍

AASM（Acts As State Machine）是一个用于为 Ruby 类添加有限状态机的库。AASM 最初作为 acts_as_state_machine 插件开发，但已经发展成为一个更通用的库，不再仅限于 ActiveRecord 模型。AASM 目前支持多种 ORM，包括 ActiveRecord、Mongoid、NoBrainer 和 Dynamoid，并且可以用于任何 Ruby 类，无论其父类是什么。

AASM 的主要功能包括：

定义状态和事件
支持回调和守卫
支持多个状态机在同一个类中
自动生成状态常量
支持 ActiveRecord 的自动保存和事务支持

2. 项目快速启动

安装

首先，你需要在你的 Ruby 项目中安装 AASM gem。可以通过 Bundler 来安装：

# Gemfile
gem 'aasm'

然后运行 bundle install 来安装 gem。

基本使用

以下是一个简单的例子，展示如何在一个 Ruby 类中使用 AASM 定义状态机。

class Job
  include AASM

  aasm do
    state :sleeping, initial: true
    state :running, :cleaning

    event :run do
      transitions from: :sleeping, to: :running
    end

    event :clean do
      transitions from: :running, to: :cleaning
    end

    event :sleep do
      transitions from: [:running, :cleaning], to: :sleeping
    end
  end
end

在这个例子中，我们定义了一个 Job 类，并使用 AASM 定义了三个状态：sleeping、running 和 cleaning。我们还定义了三个事件：run、clean 和 sleep，每个事件都有相应的转换规则。

使用状态机

创建一个 Job 实例并触发事件：

job = Job.new
job.sleeping? # => true

job.may_run? # => true
job.run
job.running? # => true

job.may_run? # => false
job.run # => raises AASM::InvalidTransition

3. 应用案例和最佳实践

应用案例

AASM 广泛应用于需要状态管理的场景，例如订单处理、任务调度、工作流管理等。以下是一个订单处理的例子：

class Order
  include AASM

  aasm do
    state :pending, initial: true
    state :paid, :shipped, :cancelled

    event :pay do
      transitions from: :pending, to: :paid
    end

    event :ship do
      transitions from: :paid, to: :shipped
    end

    event :cancel do
      transitions from: [:pending, :paid], to: :cancelled
    end
  end
end