Django記錄操作日志與LogEntry的使用詳解
前言
LogEntry是在后臺(tái)開發(fā)中經(jīng)常用到的模塊,它在admin是默認(rèn)開啟的。
可以使用LogEntry模塊記錄所有用戶的操作記錄。一方面可以用來監(jiān)督,另一方面可以用來做回滾。
1. 使用LogEntry
ModelAdmin本身就有日志記錄功能。當(dāng)新建一個(gè)實(shí)體(Post、Category、Tag)時(shí),ModelAdmin會(huì)創(chuàng)建一條變更日志記錄。當(dāng)修改一條內(nèi)容時(shí),ModelAdmin又會(huì)調(diào)用LogEntry來創(chuàng)建一條日志,記錄這個(gè)變更。
ModelAdmin內(nèi)部提供了兩個(gè)方法,分別是log_addition和log_change。
log_addition記錄新增日志。
log_change記錄變更日志。
我們可以看它們的定義來學(xué)習(xí)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. """ from django.contrib.admin.models 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. """ from django.contrib.admin.models 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, )
從以上代碼可以看出:這兩個(gè)方法都調(diào)用了LogEntry.objects.log_action方法,只是參數(shù)略有不同,可以看到,如果需要自定義變更記錄的話,只需要傳遞對(duì)應(yīng)的參數(shù)即可。以下簡要介紹一下這些參數(shù)。
user_ id
當(dāng)前用戶id。
content_type_id
要保存內(nèi)容的類型,上面的代碼中使用的是get_.content_type_for_model方法拿到對(duì)應(yīng)Model的類型id。這可以簡單理解為ContentType為每個(gè)Model定義了一個(gè)類型id。
object_id
記錄變更實(shí)例的id,比如PostAdmin中它就是post. id。
object_repr
實(shí)例的展示名稱,可以簡單理解為我們定義的__str__所返回的內(nèi)容。
action flag
操作標(biāo)記。admin的Model里面定義了幾種基礎(chǔ)的標(biāo)記: ADDITION、CHANGE和DELETION。它用來標(biāo)記當(dāng)前參數(shù)是數(shù)據(jù)變更、新增,還是刪除。
change_ message
這是記錄的消息,可以自行定義。我們可以把新添加的內(nèi)容放進(jìn)去(必要時(shí)可以通過這里來恢復(fù)),也可以把新舊內(nèi)容的區(qū)別放進(jìn)去。
理解了這幾個(gè)參數(shù),如果遇到類似的需求,就能直接使用Django現(xiàn)成的工具來完成了。
2. 查詢某個(gè)對(duì)象的變更
上面我們知道如何記錄某個(gè)對(duì)象的變更日志了,那么問題來了,如何在詢已經(jīng)記錄的變更呢?
其實(shí)這是簡單的Model查詢問題。假設(shè)我們記錄的對(duì)象是Post的操作,現(xiàn)在來獲取Post中id為1的所有變更日志,大概代碼如下:
from django.contrib.admin.models import LogEntry, CHANGE from django.contrib.admin.options import get_content_type_for_model post = Post.objects.get(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后臺(tái)方便地查看操作日志呢?
新增如下配置:
#最上面增加import from django.contrib.admin.models import LogEntry #文件最下方增加 @adnin.register(LogEntry, site=custom_site) class LogEntryAdmin(admin.ModelAdmin): list_display = ['object_repr','object_ id','action_flag','user','change_message']
如果你配置過xadmin,則在adminx.py進(jìn)行配置:
#最上面增加import from django.contrib.admin.models import LogEntry #文件最下方增加 xadmin.site.register(LogEntry,LogEntryAdmin) class LogEntryAdmin(object): list_display = ['object_repr','object_id','action_flag','user','change_message']
這樣就可以看到所有的變更記錄了。如下圖所示:
總結(jié)
到此這篇關(guān)于Django記錄操作日志與LogEntry使用的文章就介紹到這了,更多相關(guān)Django記錄操作日志內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Django項(xiàng)目配置連接多個(gè)數(shù)據(jù)庫的方法記錄
最近在進(jìn)行django項(xiàng)目開發(fā)的時(shí)候,遇到了需要連接兩個(gè)MySQL數(shù)據(jù)庫的問題,下面這篇文章主要給大家介紹了關(guān)于Django項(xiàng)目配置連接多個(gè)數(shù)據(jù)庫的相關(guān)資料,需要的朋友可以參考下2022-05-05python實(shí)現(xiàn)打印類的所有屬性和方法
這篇文章主要介紹了python實(shí)現(xiàn)打印類的所有屬性和方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-05-05python實(shí)現(xiàn)將json多行數(shù)據(jù)傳入到mysql中使用
這篇文章主要介紹了python實(shí)現(xiàn)將json多行數(shù)據(jù)傳入到mysql中使用,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-12-12Python OpenCV對(duì)本地視頻文件進(jìn)行分幀保存的實(shí)例
今天小編就為大家分享一篇Python OpenCV對(duì)本地視頻文件進(jìn)行分幀保存的實(shí)例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2019-01-01python安裝TA-Lib庫報(bào)錯(cuò)問題的解決方法
TaLib是一個(gè)Python金融指數(shù)處理庫,包含了很多技術(shù)分析里的常用參數(shù)指標(biāo),例如MA、SMA、WMA、MACD、ATR等,這篇文章主要給大家介紹了關(guān)于python安裝TA-Lib庫報(bào)錯(cuò)問題的解決方法,需要的朋友可以參考下2024-01-01flask后端request獲取參數(shù)的幾種方式整理
這篇文章主要為大家介紹了flask后端request獲取參數(shù)的幾種方式整理,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-06-06