Django利用LogEntry生成歷史操作實戰(zhàn)記錄

更新時間：2021年12月22日 11:02:17 作者：Tsissan's?Blog

LogEntry是在后臺開發(fā)中經(jīng)常用到的模塊，它在admin是默認(rèn)開啟的。文中給大家介紹了在admin頁面上查看操作日志的方法及實戰(zhàn)代碼，感興趣的朋友跟隨小編一起看看吧

在開發(fā)測試平臺的時候，雖然對某些關(guān)鍵功能做了權(quán)限設(shè)置，但畢竟是公司多人使用，有些數(shù)據(jù)的配置可能不小心被他人修改但未告知其他使用者，造成了諸多不便。所以決定開發(fā)一個操作歷史表，可以方便查看數(shù)據(jù)地改動。
LogEntry是在后臺開發(fā)中經(jīng)常用到的模塊，它在admin是默認(rèn)開啟的。
可以使用LogEntry模塊記錄所有用戶的操作記錄。一方面可以用來監(jiān)督，另一方面可以用來做回滾。

使用LogEntry

ModelAdmin本身就有日志記錄功能。當(dāng)新建一個實體(Post、Category、Tag)時,ModelAdmin會創(chuàng)建一條變更日志記錄。當(dāng)修改一條內(nèi)容時，ModelAdmin又會調(diào)用LogEntry來創(chuàng)建一條日志，記錄這個變更。
ModelAdmin內(nèi)部提供了兩個方法，分別是log_addition和log_change。
log_addition記錄新增日志。
log_change記錄變更日志。
log_deletion記錄刪除日志。
我們可以看它們的定義來學(xué)習(xí)LogEntry模塊
代碼位置：Lib\site-packages\django\contrib\admin\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,
    )


def log_deletion(self, request, object, object_repr):
    """
    Log that an object will be deleted. Note that this method must be
    called before the deletion.

    The default implementation creates an admin LogEntry object.
    """
    from django.contrib.admin.models import LogEntry, DELETION
    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=object_repr,
        action_flag=DELETION,
    )

從以上代碼可以看出：這兩個方法都調(diào)用了LogEntry.objects.log_action方法，只是參數(shù)略有不同，可以看到，如果需要自定義變更記錄的話，只需要傳遞對應(yīng)的參數(shù)即可。以下簡要介紹一下這些參數(shù)。

user_id：當(dāng)前用戶id
content_type_id：要保存內(nèi)容的類型，上面的代碼中使用的是get_.content_type_for_model方法拿到對應(yīng)Model的類型id。這可以簡單理解為ContentType為每個Model定義了一個類型id
object_id：記錄變更實例的id
object_repr：實例的展示名稱，可以簡單理解為我們定義的__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)去(必要時可以通過這里來恢復(fù)),也可以把新舊內(nèi)容的區(qū)別放進(jìn)去。

理解了這幾個參數(shù)，如果遇到類似的需求，就能直接使用Django現(xiàn)成的工具來完成了。

查詢某個對象的變更

上面我們知道如何記錄某個對象的變更日志了，那么問題來了，如何在詢已經(jīng)記錄的變更呢？
其實這是簡單的Model查詢問題。假設(shè)我們記錄的對象是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).id,
    object_id=post.id)

這樣我們就拿到了id為1的所有變更記錄了。

在admin頁面上查看操作日志

我們既知道如何記錄變更日志，也知道如何獲取變更日志，那么如何才能夠在admin后臺方便地查看操作日志呢?
新增如下配置(admin.py):

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

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

實戰(zhàn)

雖然操作歷史顯示出來了，但是在django自帶的admin后臺才能看到，不是所有人都有進(jìn)入admin后臺權(quán)限，能不能有一種方法能在前端展示出來讓每個人都可以查看呢？
前端代碼：

<table class="table table-bordered" style="width: 60%;margin-left: 20%;text-align: center"> 
   <caption style="text-align: center">
    <span style="font-size: large;color: black">項目:【<span style="color: pink">{{ client.name }}</span>】的操作記錄: </span>
   </caption> 
   <thead> 
    <tr style="background-color: #cdd8e5"> 
     <th style="width: 100px;text-align: center">操作時間</th> 
     <th style="width: 200px;text-align: center">操作對象</th> 
     <th style="width: 50px;text-align: center">對象id</th> 
     <th style="width: 100px;text-align: center">動作標(biāo)志</th> 
     <th style="width: 100px;text-align: center">操作用戶</th> 
     <th style="width: 300px;text-align: center">修改內(nèi)容</th> 
    </tr> 
   </thead> 
   <tbody>
     {% for i in objects %} 
    <tr> 
     <td>{{ i.action_time }}</td> 
     <td>{{ i.object_repr }}</td> 
     <td>{{ i.object_id }}</td> 
     <td>{{ i.get_action_flag_display }}</td> 
     <td>{{ i.user }}</td> 
     <td>{{ i.change_message }}</td> 
    </tr> {% endfor %} 
   </tbody> 
  </table>

這里有個坑，如果就利用{{i.action_flag}}獲取操作標(biāo)記的話，得到的是索引值，經(jīng)過stackoverflow.com查閱，需要利用Django-doc（用您要在其文本表示形式中“翻譯”的字段名稱替換）來獲取相應(yīng)值,因此：get_fieldname_display,所以這里要寫成{{ i.get_action_flag_display }}

后端代碼(views.py)：

# 導(dǎo)入所需的包
from django.contrib.admin.models import LogEntry, CHANGE, ADDITION, DELETION
from django.contrib.admin.options import get_content_type_for_model

res = dict()
res['objects'] = LogEntry.objects.all()  # 獲取到所有操作歷史
# 只需要調(diào)用LogEntry.objects.log_action方法帶入所需參數(shù)即可
LogEntry.objects.log_action(
        user_id=request.user.pk,  # 操作用戶的id
        content_type_id=get_content_type_for_model(object).pk,  # 對應(yīng)數(shù)據(jù)庫Model的id
        object_id=object.pk,  # 操作對象的id
        object_repr=object_repr,  # 操作對象的名字
        action_flag=DELETION,  # ADDITION、CHANGE和DELETION三種方式選擇合適的
        change_message=''  # 自定義消息，可以放入修改之后的數(shù)據(jù)
    )

實現(xiàn)效果