StateMachine 审计跟踪使用文档
2024-12-26 05:44:51作者:瞿蔚英Wynne
1. 安装指南
首先,确保您的项目已经集成了 state_machine 插件。接下来,通过将以下内容添加到您的 Gemfile
文件中,并将 gem 安装到您的项目中:
gem 'state_machine-audit_trail'
完成添加后,执行 bundle install
命令来安装 gem。
2. 项目的使用说明
本项目为 state_machine 插件提供一个审计跟踪功能,能够为任何状态机维护一个完整的状态变更历史。以下是使用本项目的步骤:
-
创建一个模型/表格来存储审计跟踪信息。该表格需要包含指向原始对象的的外键、一个“事件”字段、一个“从”状态字段、一个“到”状态字段以及一个存储转换时间戳的“创建时间”字段。本项目提供了一个 Rails 3 生成器来创建这样的模型和迁移。
对于 Rails 3,使用以下命令:
rails generate state_machine:audit_trail <模型名> <状态属性>
对于 Rails 2,使用以下命令:
rails generate state_machine_audit_trail <模型名> <状态属性>
-
在您的模型中配置状态机,并指示状态机存储审计跟踪:
class <模型名> < ActiveRecord::Base state_machine :state, :initial => :起始状态 do store_audit_trail ... end end
-
如果您的审计跟踪模型使用了非默认命名方案,您需要通过
:to
选项指定它:class <模型名> < ActiveRecord::Base state_machine :state, :initial => :起始状态 do store_audit_trail :to => '<自定义审计跟踪模型名>' ... end end
-
完成这些步骤后,插件将注册一个
after_transition
回调,用于记录所有状态转换。如果存在初始状态,它也会记录初始状态。
3. 项目API使用文档
本项目通过 store_audit_trail
方法提供审计跟踪功能。以下是一些高级用法:
-
如果您想在审计跟踪中存储额外的消息,可以使用以下方式:
store_audit_trail :context_to_log => :状态消息方法名 # 将在模型上调用状态消息方法并存储到审计跟踪模型的状态消息字段
或者
store_audit_trail :context_to_log => [:字段1, :字段2] # 将在模型上调用字段1和字段2方法并将它们存储到审计跟踪模型对应的字段
-
存储虚拟属性:有时存储动态计算的信息可能很有用。在这些情况下,您只需在
DeploymentStateTransitions
表中定义一个新列,并配置context_to_log
。例如:
class <模型名> < ActiveRecord::Base state_machine :state, :initial => :起始状态 do store_audit_trail :context_to_log => :版本 ... end def 版本 # 动态计算字段,例如,基于其他模型 ... end end class 添加版本到DeploymentStateTransitions < ActiveRecord::Migration def change add_column :deployment_state_transitions, :版本, :string ... end end
4. 项目安装方式
本项目的安装方式已在“安装指南”部分说明,概括来说,就是通过修改 Gemfile
并执行 bundle install
命令。此外,需要通过 Rails 生成器创建审计跟踪模型和迁移文件,并按照上述使用说明配置模型。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0266cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.92 K

deepin linux kernel
C
22
6

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
192
274

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
929
553

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
422
392

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
65

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8