Django記錄操作日志與LogEntry的使用詳解

Posted on by

前言

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.
        """
        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,
        )

從以上代碼可以看出：這兩個方法都調用瞭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的所有變更日志，大概代碼如下：

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後臺方便地查看操作日志呢?

新增如下配置:

#最上面增加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']

這樣就可以看到所有的變更記錄瞭。如下圖所示：

總結 

到此這篇關於Django記錄操作日志與LogEntry使用的文章就介紹到這瞭,更多相關Django記錄操作日志內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：