使用django-simple-history实现简单审计功能

前言

本文依然是中台项目延伸的笔记

这个系列的文章太小众了,看的人都不多

我争取尽快把这系列完结了,然后进入新的项目

关于审计

之前我在 dotnet 的项目里已经自己实现了审计功能了,还是用切面思想搞的

详见:

Django 生态非常丰富,实现审计应该也有很多方法和现成的库

而且因为强绑定了自己的一套 ORM ,整个生态都围绕这个体系来展开,更加的开箱即用

simple-history

本文使用了的这个 simple-history 可以记录每个 model 的操作

搭配 DjangoStarter 框架使用,目前已经切换到 unfold admin 作为管理后台,可以无缝集成

安装(普通Django项目)

这里是普通 Django 项目的步骤

先安装依赖

bash 复制代码
pdm add django-simple-history

注册应用

python 复制代码
INSTALLED_APPS = [
    # ...
    'simple_history',
]

添加中间件

这个库的审计功能是通过中间件来实现的,当然也可以不用中间件,需要额外的方式折腾。

python 复制代码
MIDDLEWARE = [
    # ...
    'simple_history.middleware.HistoryRequestMiddleware',
]

然后修改 admin 继承 SimpleHistoryAdmin

python 复制代码
from simple_history.admin import SimpleHistoryAdmin

@admin.register(Movie)
class MovieAdmin(SimpleHistoryAdmin):
    ...

这样就可以在后台看到这个 model 的相关操作了

DjangoStarter集成

实际上是 unfold 的集成🤣

注册服务

确保按照以下顺序注册app

python 复制代码
INSTALLED_APPS = [
    "unfold",
    # ...
    "unfold.contrib.simple_history",
    # ...
    "simple_history",
]

修改admin

虽然不修改也能 work

不过就没那么好的集成度和样式

python 复制代码
from unfold.admin import ModelAdmin
from simple_history.admin import SimpleHistoryAdmin

@admin.register(Movie)
class MovieAdmin(SimpleHistoryAdmin, ModelAdmin):
    ...

如何使用

在需要记录操作历史的 model 添加 history = HistoricalRecords() 字段

python 复制代码
class Movie(ModelExt):
    title = models.CharField(max_length=100)
    description = models.TextField()
    year = models.IntegerField()
    rating = models.IntegerField()
    genre = models.CharField(max_length=100)
    director = models.CharField(max_length=100)
    actors = models.CharField(max_length=100)
    history = HistoricalRecords()

老规矩,修改了模型需要同步数据库

bash 复制代码
python src/manage.py makemigrations
python src/manage.py migrate

记得 admin 也要同步修改,方法在前面介绍过了

这时候进入 admin 管理界面,点击某一个具体数据,右上角就有个"历史"按钮,点进去可以看到所有操作记录了

实现效果

查看到操作历史类似下面这样

可以看到修改人和修改了哪些内容

记录对象 日期/时间 备注 修改人 修改原因 Changes
演员1 2025年7月19日 23:56 已修改 admin None City: Tokyo ➡️ Tokyo Sega
演员1 2025年7月19日 23:56 已创建 admin None

小结

这个库还有很多可以自定义的地方,文档也写得很详细了

我就没必要搬运了(其实是我用到的功能就这么简单)

unfold 还有很多集成的第三方库,感觉都不错(迟早要集成到 DjangoStarter 里)

相关推荐
计算机毕设残哥4 小时前
HDFS存储农业大数据的秘密是什么?高级大豆数据分析与可视化系统架构设计思路
大数据·hadoop·python·hdfs·数据分析·spark·django
诗句藏于尽头1 天前
DJANGO后端服务启动报错及解决
数据库·笔记·django
言之。1 天前
Django REST framework:SimpleRouter 使用指南
python·django·sqlite
工业互联网专业1 天前
基于Spark的新冠肺炎疫情实时监控系统_django+spider
python·spark·django·vue·毕业设计·源码·课程设计
BYSJMG1 天前
大数据毕业设计推荐:基于Spark的零售时尚精品店销售数据分析系统【Hadoop+python+spark】
大数据·hadoop·python·spark·django·课程设计
计算机毕设残哥2 天前
数据量太大处理不了?Hadoop+Spark轻松解决海洋气象大数据分析难题
大数据·hadoop·python·数据分析·spark·django·dash
言之。2 天前
Django全局异常处理全攻略
python·django·sqlite
言之。2 天前
Django REST Framework Serializer 进阶教程
python·django·sqlite
BYSJMG2 天前
计算机大数据毕业设计推荐:基于Spark的新能源汽车保有量可视化分析系统
大数据·分布式·python·spark·django·编辑器·课程设计
java1234_小锋2 天前
[免费]基于Python的Django+Vue图书借阅推荐系统【论文+源码+SQL脚本】
开发语言·python·django