Ruby世界里有很多非常可爱的plugin供我们来使用,AASM就是其中之一,通过使用这个plugin,我们可以把我们的Entity变成一个有状态的对象。下图就是一个对象的状态变化图:
(图片来自 http://coredotnet.blogspot.com/2008/03/creating-state-machine-workflows-using.html)
状态机的概念并不陌生,我们在用面向对象的方式编写代码时,有很多情况下,需要对一个对象的状态变化进行规范化的管理。拿蓝点来说,一个文章在刚刚创建时是"新建"的状态,而从"新建"的状态必须要经过“待审核”的状态才可以转换成后续的“审核通过”或是“审核失败”等状态。
在上述情况下,最简单的方法就是使用代码逻辑来直接设置文章的状态。所有的状态变化过程的业务逻辑正确性,全部由程序员在代码逻辑中保证。这样的编写方式下,我们不得不依靠业务代码的程序逻辑来保证状态的正确性,如果一旦程序逻辑编写错误,那么业务逻辑也将错误。
有没有什么办法,可以让我们不要自己手工地去管理对象的状态变化,而且如果程序员错误地从一个状态转向另一个不允许的状态时,给我们一些警告信息呢?AASM就是来帮助我们完成这项工作的工具。特别是在与Rails框架结合,管理持久层的对象时,AASM非常方便。
下面通过一个例子来展示这个模块的使用方法,我们首先创建一个rails项目:
然后进入项目目录,创建一个Model:
这个Model叫做Invoice,并具有一个状态字段,叫做State。接下来持久化这个类:
最后,我们要在Invoice中添加AASM的标记,使它具备业务要求的状态:
如上面的代码所示,通过AASM,我们可以控制Invoice的状态定义,和状态变化的流程。我们玩玩看这个代码:
从上面的示例中可以看到,状态在随着预设的情况进行变化。
AASM的源代码位于github:
https://github.com/rubyist/aasm
(图片来自 http://coredotnet.blogspot.com/2008/03/creating-state-machine-workflows-using.html)
状态机的概念并不陌生,我们在用面向对象的方式编写代码时,有很多情况下,需要对一个对象的状态变化进行规范化的管理。拿蓝点来说,一个文章在刚刚创建时是"新建"的状态,而从"新建"的状态必须要经过“待审核”的状态才可以转换成后续的“审核通过”或是“审核失败”等状态。
在上述情况下,最简单的方法就是使用代码逻辑来直接设置文章的状态。所有的状态变化过程的业务逻辑正确性,全部由程序员在代码逻辑中保证。这样的编写方式下,我们不得不依靠业务代码的程序逻辑来保证状态的正确性,如果一旦程序逻辑编写错误,那么业务逻辑也将错误。
有没有什么办法,可以让我们不要自己手工地去管理对象的状态变化,而且如果程序员错误地从一个状态转向另一个不允许的状态时,给我们一些警告信息呢?AASM就是来帮助我们完成这项工作的工具。特别是在与Rails框架结合,管理持久层的对象时,AASM非常方便。
下面通过一个例子来展示这个模块的使用方法,我们首先创建一个rails项目:
- rails invoice
然后进入项目目录,创建一个Model:
- script/generate model invoice state
这个Model叫做Invoice,并具有一个状态字段,叫做State。接下来持久化这个类:
- rake db:migrate
最后,我们要在Invoice中添加AASM的标记,使它具备业务要求的状态:
- require 'AASM'
- require 'ActiveRecord'
- class Invoice < ActiveRecord::Base
- include AASM
- aasm_column :state
- aasm_initial_state :pending
- aasm_state :pending
- aasm_state :viewed, :enter => :view_invoice
- aasm_state :printed, :enter => :print_invoice
- aasm_event :view do
- transitions :to => :viewed, :from => [:pending]
- end
- aasm_event :print do
- transitions :to => :printed, :from => [:viewed, :pending]
- end
- aasm_event :reset do
- transitions :to => :pending, :from => [:viewed, :printed]
- end
- def view_invoice
- puts "viewing invoice..."
- end
- def print_invoice
- puts "printing invoice..."
- end
- end
如上面的代码所示,通过AASM,我们可以控制Invoice的状态定义,和状态变化的流程。我们玩玩看这个代码:
- script/console
- Loading development environment (Rails 2.3.2)
- >> i = Invoice.new
- => #Invoice id: nil, state: nil, created_at: nil, updated_at: nil
- >> i.view
- viewing invoice...
- => true
- >> i
- => #Invoice id: nil, state: "viewed", created_at: nil, updated_at: nil
- >> i.print
- printing invoice...
- => true
- >> i.reset
- => true
- >> i
- => #Invoice id: nil, state: "pending", created_at: nil, updated_at: nil
- >>
从上面的示例中可以看到,状态在随着预设的情况进行变化。
AASM的源代码位于github:
https://github.com/rubyist/aasm