Django - Урок 061. Додавання лічильника унікальних переглядів

Django, Counter, Django 3, python, Django 4

На початку створення статей та питань на форумі я додав найпростіший лічильник переглядів на цього контенту.
Цей лічильник був звичайним полем цілого типу і щоразу при запиті сторінки інкрементувався на одиницю.
Але нещодавно я замінив цей лічильник на модель лічильника для реєстрації унікальних переглядів. а зробив так просто тому, що, на мій погляд, це красивіше.

Лічильник вважає унікальних відвідувачів або за IP адресою, якщо користувач не авторизований на сайті, або за обліковим записом користувача, якщо цей користувач авторизований на сайті.

Тож давайте вивчимо, як це зробити.

Модель Viewer

Відповідає за підрахунок унікальних користувачів веб-сайту.

class Viewer(models.Model):
    ipaddress = models.GenericIPAddressField("IP address", blank=True, null=True)
    user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, blank=True, null=True)

Як бачите в цій моделі всього два поля, перше – це IP адреса, а друге зовнішній ключ на модель користувача

Додавання лічильника до моделі контенту

А тепер додамо лічильник у якусь модель контенту сайту, наприклад, у модель статей Article

class Article(models.Model):
    viewers = models.ManyToManyField(Viewer)
 
    # Some another code

Додавання коду здійснюється як відносини Many-To-Many. Оскільки унікальний відвідувач у цьому випадку буде один, але він може переглядати багато інших статей. При цьому і статтю можуть переглядати багато інших користувачів.

Яким чином збільшувати лічильник переглядів контенту

Швидше за відображення статей на вашому сайті буде відповідати який-небудь view клас, або view функція. Особисто я волію використовувати сучасні Class Based View у Django.

Тому я напишу mixin, який можна використовувати з DetailView для реєстрації унікальних переглядів контенту на сайті.

class CountViewerMixin:
 
    def get(self, request, *args, **kwargs):
        response = super().get(request, *args, **kwargs)
        if hasattr(self.object, 'viewers'):
            viewer, created = Viewer.objects.get_or_create(
                ipaddress=None if request.user.is_authenticated else get_client_ip(request),
                user=request.user if request.user.is_authenticated else None
            )
 
            if self.object.viewers.filter(id=viewer.id).count() == 0:
                self.object.viewers.add(viewer)
 
        return response

З коду видно, що mixin перевизначає get метод, перевіряє, що об'єкт контенту існує у View і тільки після цього отримує унікального відвідувача і після перевірки, що відвідувач ще не існує серед відвідувачів, що переглянули контент, додає його до переглядів контенту.

Таким чином сам об'єкт контенту не модифікується на відміну від лічильника у вигляді цілого поля в моделі контенту. Що насправді може ускладнювати код, якщо у вас є перевизначення save методу моделі контенту або ви написали receiver функції для обробки сигналів збереження у моделі. У разі лічильника Viewer , який представлений у цій статті, такі сигнали як post_save у моделі контенту просто не спрацьовують.

У View контенту підключення міксину буде виглядати так

class ArticleView(CountViewerMixin, DetailView):
    # some another code

Використання у шаблоні

Усередині шаблону можна отримати кількість переглядів наступним чином

{{ object.viewers.count }}

get_client_ip

Також у mixin є функція отримання IP адреси з HTTP запиту. Я вже описував цю спеціальну функцію для отримання ip адреси користувача з запиту в одній зі статей (https://evileg.com/ru/post/181/).

А у моїй останній редакції для Django 3 вона виглядає таким чином.

def get_client_ip(request):
    """
    Get client ip address from HTTP request
 
    :param request: HTTP request
    :return: IP Address
    """
    x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR')
    return x_forwarded_for.split(',')[-1].strip() if x_forwarded_for else request.META.get('REMOTE_ADDR')

Висновок

Такий лічильник дозволить спростити підтримку коду у випадку, якщо у вас є реакції на збереження контенту, а також дозволить зменшити вплив накруток на лічильники контенту.