StateMachine 审计跟踪使用文档
2024-12-26 12:13:40作者:瞿蔚英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 生成器创建审计跟踪模型和迁移文件,并按照上述使用说明配置模型。
登录后查看全文
热门项目推荐
PaddleOCR-VL
PaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
openPangu-Ultra-MoE-718B-V1.1
昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0123AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-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).Dockerfile011
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
23
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
226
2.28 K

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

暂无简介
Dart
527
116

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

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

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
61
17

GLM-4.6在GLM-4.5基础上全面升级:200K超长上下文窗口支持复杂任务,代码性能大幅提升,前端页面生成更优。推理能力增强且支持工具调用,智能体表现更出色,写作风格更贴合人类偏好。八项公开基准测试显示其全面超越GLM-4.5,比肩DeepSeek-V3.1-Terminus等国内外领先模型。【此简介由AI生成】
Jinja
47
0

喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0

React Native鸿蒙化仓库
JavaScript
214
288