Сигнализация и логирование в Django с помощью сигналов

30 мая 2024 г. | Python

Допустм, есть представление django, которое работает с моделью Person. У модели есть поля firstname, age и lastname. Также есть сериализатор модели реализованный на DRF работающий также с моделью Person. В данной статье рассказывается, как реализовать журналирования изменений объекта Person, т.е. полей lastname, firtname, age если изменения производятся в Django-представлении и сериализаторе DRF.

Для реализации журналирования изменений объекта Person в Django и Django REST Framework можно воспользоваться сигналами (signals). Сигналы позволяют реагировать на определенные события в вашем приложении Django, такие как создание, обновление или удаление объектов, и выполнять определенные действия в ответ.

Вот варианты реализации:

Создадим модель для отслеживания изменений объекта Person. Например, вы можете создать модель с полями для фиксации изменений (например, дата и время, тип изменения, старое значение, новое значение и т.д.). Эта модель будет использоваться для регистрации журналов изменений.
Создадим сигналы для модели Person, чтобы реагировать на изменения. В вашем файле models.py, вы можете определить сигналы после сохранения (postsave) и перед удалением (predelete) для модели Person. В обработчиках сигналов вы будете делать записи в журнал изменений в соответствии с вашими требованиями.

Примерно так это может выглядеть:

from django.db.models.signals import post_save, pre_delete
from django.dispatch import receiver

@receiver(post_save, sender=Person)
def person_post_save(sender, instance, created, **kwargs):
# В этом обработчике создаётся запись в журнале изменений после сохранения объекта Person
# Здесь можно получить старые и новые значения и записать их в журнал

@receiver(pre_delete, sender=Person)
def person_pre_delete(sender, instance, **kwargs):
# В этом обработчике создаётся запись в журнале перед удалением объекта Person
# Здесь можно записать факт удаления объекта в журнал

Ваши сигналы будут вызываться при каждом сохранении и перед удалением объекта Person, и вы сможете проводить необходимые действия для журналирования в этих обработчиках.

Это один из способов реализации журналирования изменений объекта Person в Django и DRF. Пожалуйста, помните о возможных потребностях в обработке ошибок, тестировании и обеспечении безопасности при реализации этого подхода в вашем проекте.

Реализация обработки ошибок

Обработка ошибок и обеспечение безопасности являются важной частью разработки программного обеспечения. Вот несколько примеров по обработке ошибок и обеспечению безопасности с использованием Django и Django REST Framework.

Обработка ошибок в Django можно осуществить с помощью блока try-except. Вот пример обработки ошибок при сохранении объекта Person и записи журнала изменений:

from django.db import transaction

@receiver(post_save, sender=Person)
def person_post_save(sender, instance, created, **kwargs):
    try:
        with transaction.atomic():
            # Здесь ваши операции с базой данных или журналирование
    except Exception as e:
        # Обработка ошибок при сохранении, например, запись в лог или отправка уведомлений разработчикам

Для обеспечения безопасности кода в Django и DRF вы можете применять следующие методы:

Валидация данных: Используйте встроенные механизмы валидации Django и DRF для проверки входных данных перед их обработкой. Например, валидация моделей, валидация форм, валидация сериализаторов и т.д.
Защита от уязвимостей: Обновляйте зависимости, следите за обновлениями фреймворков и библиотек, чтобы избежать известных уязвимостей.
Аутентификация и авторизация: Используйте встроенные механизмы Django для аутентификации пользователей (например, использование сессий, токенов, или других методов аутентификации).
Защита от межсайтовой подделки запросов (CSRF): При использовании HTML-форм в Django, убедитесь, что настройки защиты CSRF включены.

Вот примеры кода для обеспечения безопасности:

from django.views.decorators.csrf import ensure_csrf_cookie
from rest_framework.permissions import IsAuthenticated

@ensure_csrf_cookie
def my_view(request):
    # Ваша безопасная обработка запроса

class MySecureAPIView(APIView):
    permission_classes = (IsAuthenticated,)

    def get(self, request):
        # Код, который требует аутентификации пользователя

Это простые примеры того, как обработать ошибки и обеспечить безопасность в коде приложения Django и DRF. Однако не забывайте, что безопасность - это широкая и сложная тема, требующая внимания к деталям и постоянного обновления знаний в этой области.

Пример кода, который не просто журналирует изменения в модели Person

Конечно, для фиксации информации о пользователе, от имени которого производятся изменения, вы можете использовать информацию об аутентифицированном пользователе в Django. Предположим, что используется стандартную модель пользователя Django для управления учетными записями. Вот пример кода, демонстрирующий, как можно журналировать изменения объекта Person с учетом пользователя, от имени которого производятся изменения:

from django.contrib.auth.models import User
from django.db.models.signals import post_save, pre_delete
from django.dispatch import receiver

class PersonChangeLog(models.Model):
    user = models.ForeignKey(User, on_delete=models.SET_NULL, null=True)
    person = models.ForeignKey(Person, on_delete=models.CASCADE)
    change_type = models.CharField(max_length=20)  # Например, "update" или "delete"
    timestamp = models.DateTimeField(auto_now_add=True)
    # Дополнительные поля по вашему усмотрению, например, измененные поля и их значения

@receiver(post_save, sender=Person)
def person_post_save(sender, instance, created, **kwargs):
    user = None  # По умолчанию никто
    if hasattr(instance, 'request') and instance.request.user.is_authenticated:
        user = instance.request.user

    change_type = "create" if created else "update"
    change_log = PersonChangeLog(user=user, person=instance, change_type=change_type)
    change_log.save()

@receiver(pre_delete, sender=Person)
def person_pre_delete(sender, instance, **kwargs):
    user = None  # По умолчанию никто
    if hasattr(instance, 'request') and instance.request.user.is_authenticated:
        user = instance.request.user

    change_log = PersonChangeLog(user=user, person=instance, change_type="delete")
    change_log.save()

В этом примере мы создаётся модель PersonChangeLog, которая хранит информацию о пользователе, изменениях объекта Person и временной метке. При сохранении или удалении объекта Person с помощью сигналов post_save и pre_delete мы записываем соответствующие изменения в журнал PersonChangeLog, учитывая информацию об аутентифицированном пользователе, если таковой имеется.

Примечание: В приведенном выше коде предполагается, что информация об аутентифицированном пользователе доступна через атрибут request объекта instance. Это может быть актуально, например, если instance является представлением DRF. Если у вас нет прямого доступа к объекту запроса, вам может понадобиться другой способ получения информации об аутентифицированном пользователе.