about

Django messages组件官网：https://docs.djangoproject.com/zh-hans/4.2/ref/contrib/messages/

在网页应用中，相当常见的是，你需要在处理完一个表单或一些其他类型的用户输入后，向用户显示一个一次性的通知消息（也称为“即时消息”），或者在一个页面做了操作，然后重定向到另一个页面中时，需要输出一个临时性的消息。

为此，Django 为匿名用户和认证用户提供了对基于 cookie 和会话的消息传递的全面支持。消息框架允许你在一个请求中临时存储消息，并在随后的请求（通常是下一个请求）中检索显示。每条消息都有一个特定的 level 标签，以确定其优先级（例如，info、warning 或 error）。

启用messages框架

主要是在settings.py中，需要开启配置如下四处：

python

# 前三处Django都是默认开启的，你注意检查下别注释了就行
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',  # 第一处
    'django.contrib.staticfiles',
    'apps.authapi'
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',  # 第二处
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
          os.path.join(BASE_DIR, 'apps', 'authapi', 'templates'),
        ],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',  # 第三处，方便在模板语言中直接使用这个消息框架
            ],
        },
    },
]

# 第四处，消息存在哪里？也就是需要配置存储后端，需要手动添加,有三种配置可选，三选一
# 如果没有配置，则默认使用FallbackStorage类
# MESSAGE_STORAGE = "django.contrib.messages.storage.cookie.CookieStorage"
# MESSAGE_STORAGE = "django.contrib.messages.storage.cookie.SessionStorage"
# MESSAGE_STORAGE = "django.contrib.messages.storage.cookie.FallbackStorage"

存储后端：

SessionStorage，这个类在请求的会话中存储所有的消息，需要结合Django的session的来实现，所以启用这个存储后端你要注意启用session组件。
CookieStorage，这个类将消息数据存储在 cookie 中（用密钥哈希签名，以防止被篡改），以便在不同的请求中持久保存通知。如果 cookie 数据大小超过 2048 字节，旧的消息就会被删除。
FallbackStorage，默认的存储类，它首先使用了 CookieStorage，然后又能使用 SessionStorage 来处理无法放入单个 cookie 的消息。它也需要 Django 的 contrib.session 应用配合。

快速上手

这里实现一个需求，就是在登录页面，登录成功之后，重定向到主页，然后在主页进行弹窗提示。这就用到了：

登录视图中，登录成功之后，添加消息，然后重定向到主页。
浏览器展示主页，进行读取消息，展示在弹出框内。

重点就下面这几行代码：

python

from django.contrib import messages  # 导入消息组件

# 写消息
messages.add_message(request, messages.SUCCESS, "登录成功！")

# 读取消息，读完之后，消息就没了
storage = messages.get_messages(request)
for message in storage:
    print(message)  # 登录成功！

这里列出来重点示例代码，首先是views.py：

python

from django.shortcuts import render, redirect
from django.contrib import messages  # 导入消息组件


def login(request):
    if request.method == "GET":
        return render(request, 'login.html', {"action": "登录"})
    else:
        username = request.POST.get("username")
        password = request.POST.get("password")
        # 根据用户输入的用户名和密码去数据库中进行校验，如果校验通过，说明登录成功，可以跳转到主页
        # 我这里为了简单，就写死了
        if username == "zhangkai" and password == "123":
            # 写入消息
            messages.add_message(request, messages.SUCCESS, "登录成功！")
            return redirect("/index/")
        else:  # 否则，给前端返回消息，说用户或者密码错误
            return render(request, 'login.html', {"msg": f"用户名或者密码错误，请重新输入!!", "action": "登录"})

def index(request):
    # 可以在这里读取消息，读完之后，消息就没了
    # storage = messages.get_messages(request)
    # for message in storage:
    #     print(message)  # 登录成功！
    return render(request, 'index.html')

然后是login.html:

html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h3>欢迎来到登录页面</h3>
<form action="" method="post">
    {% csrf_token %}
    <input type="text" placeholder="user" name="username" value="zhangkai">
    <input type="text" placeholder="password" name="password" value="123">
    <input type="submit" value="登录"><span style="color: red;" id="msg">{{ msg }}</span>
</form>
<script>
    setInterval(function () {
        document.getElementById('msg').innerText = "";
    }, 4000)
</script>
</body>
</html>

接下来是index.html：

html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>index page</h1>
<!-- 在模板语言中也可以循环message对象拿到消息进行展示 -->
{% if messages %}
    <div class="top-message-error">
        {% for obj in messages %}
            <div class="alert alert-{{ obj.level_tag }}">
                {{ obj.message }}
            </div>
        {% endfor %}
    </div>
{% endif %}
</body>
</html>

about ​

启用messages框架 ​

快速上手 ​

about

启用messages框架

快速上手