Django记录操作⽇志、LogEntry的使⽤
LogEntry是在后台开发中经常⽤到的模块,它在admin是默认开启的。
可以使⽤LogEntry模块记录所有⽤户的操作记录。⼀⽅⾯可以⽤来监督,另⼀⽅⾯可以⽤来做回滚。
1. 使⽤LogEntry
ModelAdmin本⾝就有⽇志记录功能。当新建⼀个实体(Post、Category、Tag)时,ModelAdmin会创建⼀条变更⽇志记录。当修改⼀条内容时,ModelAdmin⼜会调⽤LogEntry来创建⼀条⽇志,记录这个变更。
ModelAdmin内部提供了两个⽅法,分别是log_addition和log_change。
log_addition记录新增⽇志。
log_change记录变更⽇志。
我们可以看它们的定义来学习LogEntry模块
代码位置:django/admin/contrib/options.py
def log_addition(self, request, object, message):
"""
Log that an object has been successfully added.
The default implementation creates an admin LogEntry object.
"""
dels import LogEntry, ADDITION
return LogEntry.objects.log_action(
user_id=request.user.pk,
content_type_id=get_content_type_for_model(object).pk,
object_id=object.pk,
object_repr=str(object),
action_flag=ADDITION,
change_message=message,
)
def log_change(self, request, object, message):
"""
Log that an object has been successfully changed.
The default implementation creates an admin LogEntry object.
"""
dels import LogEntry, CHANGE
return LogEntry.objects.log_action(
user_id=request.user.pk,
content_type_id=get_content_type_for_model(object).pk,
object_id=object.pk,
object_repr=str(object),
action_flag=CHANGE,
change_message=message,
)
从以上代码可以看出:这两个⽅法都调⽤了LogEntry.objects.log_action⽅法,只是参数略有不同,可以看到,如果需要⾃定义变更记录的话,只需要传递对应的参数即可。以下简要介绍⼀下这些参数。
user_ id
当前⽤户id。
content_type_id
要保存内容的类型,上⾯的代码中使⽤的是get_.content_type_for_model⽅法拿到对应Model的类型id。这可以简单理解为ContentType为每个Model定义了⼀个类型id。
object_id
记录变更实例的id,⽐如PostAdmin中它就是post. id。
object_repr
实例的展⽰名称,可以简单理解为我们定义的__str__所返回的内容。
action flag
操作标记。admin的Model⾥⾯定义了⼏种基础的标记: ADDITION、CHANGE和DELETION。它⽤来标记当前参数是数据变更、新增,还是删除。
change_ message
这是记录的消息,可以⾃⾏定义。我们可以把新添加的内容放进去(必要时可以通过这⾥来恢复),也可以把新旧内容的区别放进去。
理解了这⼏个参数,如果遇到类似的需求,就能直接使⽤Django现成的⼯具来完成了。
2. 查询某个对象的变更
上⾯我们知道如何记录某个对象的变更⽇志了,那么问题来了,如何在询已经记录的变更呢?
其实这是简单的Model查询问题。假设我们记录的对象是Post的操作,现在来获取Post中id为1的所有变更⽇志,⼤概代码如下:
dels import LogEntry, CHANGE
ib.admin.options import get_content_type_for_model
post = (id=1)
log_entries = LogEntry.objects.filter(
content_type_id=get_content_type_for_model(post).pk,
object_id=post.id,
这样我们就拿到了⽂章id为1的所有变更记录了。
3. 在admin页⾯上查看操作⽇志
我们既知道如何记录变更⽇志,也知道如何获取变更⽇志,那么如何才能够在admin后台⽅便地查看操作⽇志呢?
新增如下配置:
#最上⾯增加import
dels import LogEntry
django admin 自定义页面#⽂件最下⽅增加
@ister(LogEntry, site=custom_site)
class LogEntryAdmin(admin.ModelAdmin):
list_display = ['object_repr','object_ id','action_flag','user','change_message']
如果你配置过xadmin,则在adminx.py进⾏配置:
#最上⾯增加import
dels import LogEntry
#⽂件最下⽅增加
ister(LogEntry,LogEntryAdmin)
class LogEntryAdmin(object):
list_display = ['object_repr','object_id','action_flag','user','change_message']
这样就可以看到所有的变更记录了。如下图所⽰:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论