[One Package Per Day] Django Simple History

Một Gói Mỗi Ngày: Django Simple History

Giới thiệu

Khi làm việc với các ứng dụng web, việc theo dõi các thay đổi trong mô hình của bạn là rất quan trọng, đặc biệt là để kiểm toán, gỡ lỗi hoặc hiểu sự phát triển của dữ liệu. Django Simple History là một gói tuyệt vời giúp dễ dàng theo dõi các thay đổi trong các trường của mô hình theo thời gian. Chỉ với thiết lập tối thiểu, bạn có thể ghi lại và truy xuất dữ liệu lịch sử, đảm bảo tính minh bạch và trách nhiệm giải trình trong ứng dụng của mình.

Cài đặt

Để bắt đầu với Django Simple History, hãy cài đặt nó bằng pip:

pip install django-simple-history

Thêm simple_history vào INSTALLED_APPS của bạn trong settings.py:

INSTALLED_APPS = [

    ...,

    'simple_history',

]

Chạy migrations để tạo các bảng cơ sở dữ liệu cần thiết:

python manage.py makemigrations

python manage.py migrate

Bắt đầu

Sử dụng Django Simple History rất đơn giản. Bạn chỉ cần thêm trường HistoricalRecords vào các mô hình bạn muốn theo dõi.

Ví dụ:

from django.db import models

from simple_history.models import HistoricalRecords



class Book(models.Model):

    title = models.CharField(max_length=255)

    author = models.CharField(max_length=255)

    published_date = models.DateField()



    history = HistoricalRecords()

Sau khi thêm history, bất kỳ thay đổi nào được thực hiện đối với mô hình Book sẽ tự động được ghi lại trong bảng lịch sử liên kết.

Xem bản ghi lịch sử

Bạn có thể truy cập các bản ghi lịch sử trực tiếp từ thuộc tính history:

book = Book.objects.get(id=1)

for historical_record in book.history.all():

    print(historical_record.history_date, historical_record.title)

Các tính năng chính

Theo dõi thay đổi tự động: Theo dõi các thay đổi đối với các trường mà không cần logic bổ sung.
Thuộc tính người dùng: Xác định người dùng chịu trách nhiệm cho mỗi thay đổi.
Các trường tùy chỉnh: Chọn các trường cụ thể để bao gồm hoặc loại trừ khỏi việc theo dõi lịch sử.
Hỗ trợ xóa mềm: Theo dõi các thay đổi ngay cả khi một đối tượng bị xóa.
Tích hợp quản trị: Xem các bản ghi lịch sử trực tiếp trong bảng điều khiển quản trị Django.

Trường hợp sử dụng

Bản ghi kiểm toán: Giám sát ai đã thực hiện thay đổi và khi nào. Điều này rất hữu ích cho các cửa hàng thương mại điện tử.
Gỡ lỗi: Xác định khi nào và tại sao các thay đổi không mong muốn xảy ra. Ví dụ: Kiểm tra dữ liệu tài chính hàng ngày.
Khôi phục dữ liệu: Truy xuất các phiên bản dữ liệu trước đó.
Tuân thủ quy định: Duy trì các bản ghi lịch sử cho các yêu cầu pháp lý hoặc chính sách.

Thực tiễn tốt nhất

Hạn chế theo dõi lịch sử: Chỉ theo dõi các mô hình và trường cần thiết để tránh làm tăng kích thước cơ sở dữ liệu không cần thiết.
Xóa dữ liệu cũ: Thường xuyên xóa các bản ghi lịch sử lỗi thời để quản lý dung lượng lưu trữ.
Bảo mật truy cập: Hạn chế quyền truy cập vào dữ liệu lịch sử cho các mô hình nhạy cảm.

Tùy chỉnh

Django Simple History cung cấp nhiều tùy chọn để tùy chỉnh:

Theo dõi người dùng:

Để theo dõi người dùng chịu trách nhiệm về các thay đổi, hãy thêm middleware và cập nhật cài đặt:

MIDDLEWARE = [

    'simple_history.middleware.HistoryRequestMiddleware',

    ...,

]

SIMPLE_HISTORY_RESTORE_ID = True

Loại trừ trường:

Loại trừ các trường khỏi việc theo dõi bằng cách ghi đè phương thức update_change_reason trong mô hình của bạn:

class Book(models.Model):

    ...



def update_change_reason(self, reason):

        if 'exclude_this_field' in reason:

            self.exclude_this_field = True

Lỗi thường gặp

Xung đột di chuyển: Đảm bảo các di chuyển được cập nhật sau khi thêm HistoricalRecords.
Vấn đề middleware: Nếu việc theo dõi người dùng không thành công, hãy xác nhận rằng HistoryRequestMiddleware được cấu hình chính xác.

Xem xét hiệu suất

Việc theo dõi các bản ghi lịch sử có thể làm tăng chi phí, đặc biệt là trong các ứng dụng có tần suất ghi thường xuyên. Theo dõi hiệu suất cơ sở dữ liệu của bạn và tối ưu hóa các truy vấn nếu có thể.

Ưu điểm và nhược điểm

Ưu điểm:

Dễ dàng triển khai và tích hợp.
Các tính năng theo dõi mạnh mẽ.
Nhiều tùy chọn tùy chỉnh.

Nhược điểm:

Kích thước cơ sở dữ liệu tăng lên do các bản ghi lịch sử.
Ảnh hưởng hiệu suất tiềm tàng đối với các ứng dụng ghi tần suất cao.

So sánh với các gói khác

Django Simple History nổi bật với tính đơn giản và dễ sử dụng so với các gói kiểm toán khác như django-reversion. Trong khi django-reversion rất tốt cho việc kiểm soát phiên bản, Django Simple History phù hợp hơn cho các tác vụ kiểm toán đơn giản.

Kết luận

Django Simple History là một lựa chọn tuyệt vời cho các nhà phát triển muốn thêm tính năng theo dõi lịch sử mạnh mẽ vào các ứng dụng Django của họ. Tính dễ sử dụng, khả năng tùy chỉnh và các tính năng thực tế làm cho nó trở thành một bổ sung có giá trị cho bất kỳ dự án nào.

Hãy thử và kiểm soát lịch sử dữ liệu của bạn!