Django-honeypot 项目技术文档

1. 安装指南

要安装 django-honeypot，请确保您的环境中已经安装了 Python 3.8 或更高版本以及 Django 3.2 或更高版本。然后，您可以使用 pip 安装此应用：

pip install django-honeypot

确保将其添加到您的 settings.py 文件中的 INSTALLED_APPS 列表中：

INSTALLED_APPS = [
    # 其他应用...
    'honeypot',
]

2. 项目的使用说明

django-honeypot 是一个 Django 应用程序，提供了防止自动化表单垃圾邮件的实用工具。它包括模板标签、视图装饰器和中间件，用于向表单添加和验证蜜罐字段。

添加蜜罐字段到特定表单和视图

首先，在模板文件的顶部包含以下代码来加载模板标签：

{% load honeypot %}

接着，在表单中包含蜜罐字段：

{% render_honeypot_field "field_name" %}

这会渲染一个名为 "field_name" 的蜜罐字段，默认为隐藏。如果不提供字段名，将使用 HONEYPOT_FIELD_NAME 设置的名称。

为了确保蜜罐字段存在且正确，您需要使用 honeypot.decorators 中的 check_honeypot 装饰器：

from honeypot.decorators import check_honeypot

@check_honeypot(field_name='hp_field_name')
def post_comment(request):
    ...

对于基于类的视图，装饰器可以添加到 post 方法上：

from django.utils.decorators import method_decorator
from honeypot.decorators import check_honeypot

@method_decorator(check_honeypot, name='post')
class MyView(FormView):
    ...

添加蜜罐字段到全局表单

django-honeypot 提供了三种中间件，可以在全局范围内添加蜜罐字段：

• HoneypotResponseMiddleware：分析所有响应并重写使用 method="POST" 的表单。
• HoneypotViewMiddleware：确保所有传入的 POST 请求包含有效的蜜罐字段。
• HoneypotMiddleware：结合了以上两种中间件。

将这些中间件添加到 settings.py 中的 MIDDLEWARE 列表，并确保它们位于 CommonMiddleware 之后：

MIDDLEWARE = [
    # 其他中间件...
    'django.middleware.common.CommonMiddleware',
    'honeypot.middleware.HoneypotMiddleware',
]

3. 项目API使用文档

• render_honeypot_field(fieldname=None, value=None)：渲染蜜罐字段，可选参数 fieldname 和 value 可以自定义字段名称和值。
• check_honeypot(field_name=None)：视图装饰器，确保 POST 请求包含有效的蜜罐字段。

4. 项目安装方式

请参考上述“安装指南”中的步骤进行安装。

通过以上指南，您可以开始使用 django-honeypot 来保护您的 Django 应用程序免受自动化表单垃圾邮件的侵害。