Django FSM Log 使用教程

Django FSM Log 使用教程

django-fsm-logAutomatic logging for Django FSM项目地址:https://gitcode.com/gh_mirrors/dj/django-fsm-log

项目介绍

django-fsm-log 是一个用于记录 Django FSM（有限状态机）模型状态转换历史的开源项目。它基于 Django FSM 包，提供了对状态转换的持久化记录功能。通过使用 django-fsm-log，开发者可以轻松地跟踪和管理模型的状态变化历史。

项目快速启动

安装

首先，使用 pip 安装 django-fsm-log：

pip install django-fsm-log

配置

在 Django 项目的 settings.py 文件中，将 django_fsm_log 添加到 INSTALLED_APPS 中：

INSTALLED_APPS = (
    ...
    'django_fsm_log',
    ...
)

使用示例

假设你有一个模型 Order，并且已经定义了 FSM 状态转换：

from django_fsm import FSMField, transition
from django.db import models

class Order(models.Model):
    state = FSMField(default='new')

    @transition(field=state, source='new', target='paid')
    def mark_as_paid(self):
        pass

    @transition(field=state, source='paid', target='shipped')
    def mark_as_shipped(self):
        pass

为了记录状态转换历史，你需要在模型中添加 StateLog 模型：

from django_fsm_log.models import StateLog

class Order(models.Model):
    state = FSMField(default='new')

    @transition(field=state, source='new', target='paid')
    def mark_as_paid(self):
        pass

    @transition(field=state, source='paid', target='shipped')
    def mark_as_shipped(self):
        pass

    def __str__(self):
        return f"Order {self.id} - {self.state}"

记录状态转换

每次状态转换时，django-fsm-log 会自动记录转换历史。你可以在管理界面中查看这些记录，或者通过代码查询：

order = Order.objects.create()
order.mark_as_paid()
order.mark_as_shipped()

logs = StateLog.objects.filter(content_object=order)
for log in logs:
    print(f"Transition from {log.state_from} to {log.state_to} on {log.timestamp}")

应用案例和最佳实践

应用案例

django-fsm-log 适用于需要跟踪复杂状态转换的场景，例如订单管理系统、工作流引擎等。通过记录状态转换历史，可以方便地进行审计和故障排查。

最佳实践

1. 状态转换描述：使用 fsm_log_description 装饰器为每个状态转换添加描述信息，以便更好地理解每次转换的上下文。
2. 权限控制：在状态转换方法中添加权限检查，确保只有授权用户可以执行特定的状态转换。
3. 日志查询优化：使用 Django 的查询优化技巧，提高日志查询的性能。

典型生态项目

django-fsm-log 与以下项目结合使用可以发挥更大的作用：

1. Django FSM：django-fsm-log 依赖于 Django FSM，提供了强大的状态机功能。
2. Django Admin：通过 Django 管理界面，可以方便地查看和管理状态转换历史。
3. Django REST Framework：结合 DRF，可以构建 RESTful API 来管理状态转换和查询历史记录。

通过这些项目的结合使用，可以构建出功能强大且易于维护的状态管理系统。

django-fsm-logAutomatic logging for Django FSM项目地址:https://gitcode.com/gh_mirrors/dj/django-fsm-log