您好,登錄后才能下訂單哦!
這篇文章主要介紹“Django記錄操作日志與LogEntry的使用方法是什么”的相關(guān)知識,小編通過實際案例向大家展示操作過程,操作方法簡單快捷,實用性強,希望這篇“Django記錄操作日志與LogEntry的使用方法是什么”文章能幫助大家解決問題。
ModelAdmin本身就有日志記錄功能。當新建一個實體(Post、Category、Tag)時,ModelAdmin會創(chuàng)建一條變更日志記錄。當修改一條內(nèi)容時,ModelAdmin又會調(diào)用LogEntry來創(chuàng)建一條日志,記錄這個變更。
ModelAdmin內(nèi)部提供了兩個方法,分別是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. """ 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, )
從以上代碼可以看出:這兩個方法都調(diào)用了LogEntry.objects.log_action方法,只是參數(shù)略有不同,可以看到,如果需要自定義變更記錄的話,只需要傳遞對應的參數(shù)即可。以下簡要介紹一下這些參數(shù)。
user_ id
當前用戶id。
content_type_id
要保存內(nèi)容的類型,上面的代碼中使用的是get_.content_type_for_model方法拿到對應Model的類型id。這可以簡單理解為ContentType為每個Model定義了一個類型id。
object_id
記錄變更實例的id,比如PostAdmin中它就是post. id。
object_repr
實例的展示名稱,可以簡單理解為我們定義的__str__所返回的內(nèi)容。
action flag
操作標記。admin的Model里面定義了幾種基礎的標記: ADDITION、CHANGE和DELETION。它用來標記當前參數(shù)是數(shù)據(jù)變更、新增,還是刪除。
change_ message
這是記錄的消息,可以自行定義。我們可以把新添加的內(nèi)容放進去(必要時可以通過這里來恢復),也可以把新舊內(nèi)容的區(qū)別放進去。
理解了這幾個參數(shù),如果遇到類似的需求,就能直接使用Django現(xiàn)成的工具來完成了。
上面我們知道如何記錄某個對象的變更日志了,那么問題來了,如何在詢已經(jīng)記錄的變更呢?
其實這是簡單的Model查詢問題。假設我們記錄的對象是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的所有變更記錄了。
我們既知道如何記錄變更日志,也知道如何獲取變更日志,那么如何才能夠在admin后臺方便地查看操作日志呢?
新增如下配置:
#最上面增加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進行配置:
#最上面增加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']
這樣就可以看到所有的變更記錄了。如下圖所示:
關(guān)于“Django記錄操作日志與LogEntry的使用方法是什么”的內(nèi)容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識,可以關(guān)注億速云行業(yè)資訊頻道,小編每天都會為大家更新不同的知識點。
免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。