用 Django 和 Python 构建个人日记

项目概况

本教程分为多个步骤。这样，您就可以休息并按照自己的节奏继续。在每一步中，您都将处理日记项目的特定领域：

1. 设置你的 Django 日记项目
2. 在后端创建条目
3. 在前端显示条目
4. 添加样式
5. 在前端管理条目
6. 改善您的用户体验
7. 实施认证

通过跟随，您将探索 Web 应用程序的基础知识以及如何添加 Django 项目的常见功能。完成本教程后，您将创建自己的个人日记应用程序，并将有一个Django 项目蓝图来构建。

先决条件

您不需要任何先前的 Django 知识即可完成此项目。如果您想了解有关本教程中遇到的主题的更多信息，您将在此过程中找到指向资源的链接。

但是，您应该习惯于使用命令行并且具备Python 和类的基本知识。尽管了解虚拟环境和会有所帮助，但您将在学习本教程时学习如何设置所有内容。pip

初始化 Django

满足所有要求后，是时候启动 Django 项目本身了。使用 Django 的命令行实用程序创建基本项目结构：

(.venv) $ django-admin startproject diary .

不要忘记.在上述命令的末尾添加点 ( )。点阻止 Django 为您的日记项目创建另一个目录。

Django 刚刚创建了一个manage.py文件和一个以diary五个文件命名的文件夹。您不必确切了解他们的工作。如果你好奇，你可以看一看这些文件。它们在开头都包含一个解释，描述它们为什么存在。在本教程中，您只需要编辑其中两个：

创建数据库

现在你的 Django 日记项目的基础已经准备好了，你需要一个地方来存储你日记的未来内容。为此，您必须创建一个数据库。

如果没有提供其他数据库配置，Django默认支持多个数据库并使用SQLite数据库。您只需要一个SQLite数据库，因为您是连接到它的唯一用户，并且您的 Django 日记项目只会在本地运行。

最好的部分是您可以使用单个命令创建 SQLite 数据库。通过运行migrations，您可以将数据库架构的更改应用到数据库中：

(.venv) $ python manage.py migrate

当您查看项目目录时，您应该会看到一个db.sqlite3文件。拍拍自己的肩膀：您刚刚创建了一个数据库！

要将项目的当前状态与本教程的可下载文件进行比较，请单击以下链接：

与本节相关的文件在source_code_step_1/目录中。

成为超级用户

作为您个人日记的所有者，您已经获得了superuser. 使用以下命令声明它：

(.venv) $ python manage.py createsuperuser
Username (leave blank to use 'root'): admin
Email address: admin@example.com
Password: RealPyth0n
Password (again): RealPyth0n
Superuser created successfully.

系统会提示您选择用户名、提供电子邮件地址并设置密码。这是你日记的关键，所以一定要记住它。

运行开发 Web 服务器

您将经常使用的另一个命令是runserver. 此命令运行轻量级开发 Web 服务器：

(.venv) $ python manage.py runserver

您可以指定IP 地址和端口runserver。默认情况下，服务器在端口8000上运行127.0.0.1并且只能在您的计算机上访问。在服务器运行的情况下，您可以在浏览器中使用http://127.0.0.1:8000或访问您的 Django 项目http://localhost:8000：

连接条目应用程序

在您的终端中，Django 开发 Web 服务器可能仍在运行。通过在终端中按Ctrl+C来停止它。

提示：打开第二个终端窗口以在一个窗口中控制服务器并在另一个窗口中运行命令：

导航到您的项目并激活虚拟环境后，您可以在第二个终端窗口中运行该项目即将执行的命令。

在本教程中，您只需要一个额外的应用程序。该应用程序的主要目的是处理您的日记条目，所以让我们调用该应用程序entries。运行命令以创建entries应用程序：

(.venv) $ python manage.py startapp entries

此命令entries在您的项目中创建一个包含一些预定义文件的文件夹。在本教程后面，您只需要编辑其中的三个：

如您所见，其中一些与diary/目录中的文件具有相同的名称。通过单击下面的链接，您可以将您的文件夹结构与目录中的结构进行比较source_code_step_2/：

到目前为止，Django 不知道您刚刚创建的应用程序。要将entries应用程序连接到 Django 日记项目，请在 中的列表开头添加配置类的路径：INSTALLED_APPSdiary/settings.py

# diary/settings.py

INSTALLED_APPS = [
  "entries.apps.EntriesConfig",
  "django.contrib.admin",
  "django.contrib.auth",
  "django.contrib.contenttypes",
  "django.contrib.sessions",
  "django.contrib.messages",
  "django.contrib.staticfiles",
]

该entries应用程序插入到diary项目，现在，Django的发现它的配置。这些配置之一是描述您的日记条目在数据库中的外观的模型。

创建条目模型

您已经创建了数据库。现在是时候定义存储日记条目的数据库表了。在 Django 中，您可以使用模型类来做到这一点。就像 Python 中的常规类一样，模型名称应该是单数和大写。当您的应用程序被调用时entries，您的模型将被调用Entry。

Entry模型的字段是日记条目将具有的元素。在前面，这些字段将显示为表单。在后面，它们将是您的Entry数据库表的列。本教程中的日记条目包含三个字段：

1. title 是标题。
2. content 是正文正文。
3. date_created 是创建日期和时间。

在 中entries/models.py，首先从导入 。然后在同一个文件中创建类，如下所示：timezonedjango.utilsEntry

 1# entries/models.py
 2
 3from django.db import models
 4from django.utils import timezone
 5
 6class Entry(models.Model):
 7    title = models.CharField(max_length=200)
 8    content = models.TextField()
 9    date_created = models.DateTimeField(default=timezone.now)
10
11    def __str__(self):
12        return self.title
13
14    class Meta:
15        verbose_name_plural = "Entries"

通过导入timezone模块，您可以将其timezone.now用作第9 行中的default参数date_created。这样，如果您在创建条目时未为其定义特定值，则默认情况下将使用当前日期和时间。稍后在为日记条目创建表单时，您将使用此行为。

除了title, content, 和 之外date_created，Django 会自动添加id一个唯一的主键。该字符串表示与主键条目的1将是Entry object (1)默认。添加 时.__str__()，您可以自定义显示的内容。对于日记条目，标题是更好的字符串表示形式。

您必须调整的另一个变量是verbose_name_plural. 否则，Django 会拼出你的EntryasEntrys和 not的复数形式Entries。

注册入门模型

要Entry在 Django 管理站点中查看模型，您需要在以下位置注册它entries/admin.py：

# entries/admin.py

from django.contrib import admin
from .models import Entry

admin.site.register(Entry)

当您忘记在管理站点中注册模型时，Django 不会抛出错误。毕竟，并非每个模型都需要在用户界面中进行管理。但是对于日记中最小的可行产品，您将利用内置的 Django 管理站点。

迁移入口模型

添加新类并在管理站点上注册后，您需要为 Django制作迁移文件并运行它们。使用makemigrations，您可以创建迁移文件，其中包含 Django 构建数据库的说明。使用migrate，您可以实现它们：

(.venv) $ python manage.py makemigrations
(.venv) $ python manage.py migrate

迁移完成后，运行开发 Web 服务器，移动到浏览器，然后访问 Django 管理站点http://localhost:8000/admin：

第 3 步：在前端显示您的日记条目

您现在可以在 Django 管理站点中添加新条目。但是当你在浏览器中访问你的日记首页时，它仍然显示了抖动的火箭。在这一步中，您将学习如何在前端显示您的日记条目。

如果您想查看此步骤结束时的代码外观，请单击以下链接：

与此步骤相关的文件在source_code_step_3/目录中。

 1# entries/views.py
 2
 3from django.views.generic import (
 4    ListView,
 5    DetailView,
 6)
 7
 8from .models import Entry
 9
10class EntryListView(ListView):
11    model = Entry
12    queryset = Entry.objects.all().order_by("-date_created")
13
14class EntryDetailView(DetailView):
15    model = Entry

添加样式表

通过{% load static %}在模板文件的开头插入，您可以使用模板标签和 CSS 文件的相对路径来引用静态{% static %}文件。建立diary.css在entries/static/css/扩大框下方查看CSS代码，你会添加到文件中。

如前所述，<h2>条目列表中的每个元素都将其工作日作为一个类。通过样式.Saturday和.Sunday不同，您可以轻松地在列表中发现周末。

扩展子模板

现在是时候将子模板与base.html父模板连接起来了。更新entries/templates/entries/entries_list.html它看起来像这样：

 1<!-- entries/templates/entries/entries_list.html -->
 2
 3{% extends "entries/base.html" %}
 4
 5{% block content %}
 6    {% for entry in object_list %}
 7        <article>
 8            <h2 class="{{ entry.date_created|date:'l' }}">
 9                {{ entry.date_created|date:'Y-m-d H:i' }}
10            </h2>
11            <h3>
12                <a href="{% url 'entry-detail' entry.id %}">
13                    {{ entry.title }}
14                </a>
15            </h3>
16        </article>
17    {% endfor %}
18{% endblock %}

该{% block %}模板标签定义了一个子模板可以覆盖文档的一部分。要启用此功能，您必须声明您的子模板扩展了父模板并定义了一个具有相同名称的块元素。使用第{% extends %}3 行的模板标记，您将其定义entries/base.html为父级。{% block %}并{% endblock %}在第 5 行和第 18 行包装将放置在content父级块中的标记。

做同样的事情entries/templates/entries/entries_detail.html：

<!-- entries/templates/entries/entries_detail.html -->

{% extends "entries/base.html" %}

{% block content %}
    <article>
        <h2>{{ entry.date_created|date:'Y-m-d H:i' }}</h2>
        <h3>{{ entry.title }}</h3>
        <p>{{ entry.content }}</p>
    </article>
{% endblock %}

这两个模板都从其父模板继承了 HTML 结构和样式。它们共享相同的标题和<h1>标题，以及由diary.css. 要查看此操作，请启动您的 Django 开发服务器并转到http://localhost:8000：

第 5 步：在前端管理您的日记条目

当您构建和使用 Web 应用程序时，您会一直执行四个基本操作。这些操作非常常见，以至于它们经常被CRUD首字母缩写词所指代：

• Create
• Read
• Update
• Delete
  

在 Django 管理站点中，您已经可以执行所有这些操作。在前端，您目前只能阅读您的条目。为了类似于 Django 管理站点的功能，您将重复您已经为EntryDetailand所做的工作EntryList，添加一个视图、一个模板和一个 URL。

添加视图

在entries/views.py已经导入ListView和DetailView至今。更新您的导入语句，使其看起来像这样：

# entries/views.py

from django.urls import reverse_lazy
from django.views.generic import (
    ListView,
    DetailView,
    CreateView,
    UpdateView,
    DeleteView,
)

在底部添加您的三个子类entries/views.py：

 1# entries/views.py
 2
 3class EntryCreateView(CreateView):
 4    model = Entry
 5    fields = ["title", "content"]
 6    success_url = reverse_lazy("entry-list")
 7
 8class EntryUpdateView(UpdateView):
 9    model = Entry
10    fields = ["title", "content"]
11
12    def get_success_url(self):
13        return reverse_lazy(
14            "entry-detail",
15            kwargs={"pk": self.entry.id}
16        )
17
18class EntryDeleteView(DeleteView):
19    model = Entry
20    success_url = reverse_lazy("entry-list")

这一次，将类连接到您的Entry模型是不够的。对于EntryCreateViewand EntryUpdateView，您还需要定义表单中应该显示哪些模型字段，如第 5 行和第 10EntryDeleteView行所示。您的第 18 行仅执行删除条目项的操作，因此您不需要定义其中的任何字段。

此外，您需要定义在提交视图表单后应该将用户重定向到何处。默认情况下，.get_success_url()只返回 的值success_url。在 中EntryUpdateView，您需要覆盖此方法。

通过在第 15 行中提供entry.id作为关键字参数，您在编辑后停留在条目详细信息页面上。您不使用 URL，而是使用reverse_lazy按名称引用它们，就像您在模板中所做的那样。

创建模板

像以前一样，Django 查找具有特定名称的模板：

• 对于EntryDeleteView，它是entry_confirm_delete.html。
• 对于EntryCreateView，它是entry_form.html。
• 因为EntryUpdateView它会 entry_update_form.html。

当 Django 找不到 时entry_update_form.html，它会尝试entry_form.html作为后备。您可以通过创建一个处理两个视图的模板entries/templates/entries/并添加一个基本提交表单来利用这一点：

 1<!-- entries/templates/entries/entry_form.html -->
 2
 3{% extends "entries/base.html" %}
 4{% block content %}
 5    <form method="post">
 6        {% csrf_token %}
 7        {{ form.as_p }}
 8        <input type="submit" value="Save">
 9    </form>
10    {% if entry %}
11        <a href="{% url 'entry-detail' entry.id %}">
12            <button>Cancel</button>
13        </a>
14    {% else %}
15        <a href="{% url 'entry-list' %}">
16            <button>Cancel</button>
17        </a>
18    {% endif %}
19{% endblock %}

当此模板由 加载时CreateView，表单将为空，取消它会再次将您带到条目列表。当由 加载时CreateUpdateView，它将预先填充条目的当前标题和内容。取消会将您带到条目详细信息页面。

有多种方法可以在模板中呈现表单。随着{{ form.as_p }}在第7行，Django会显示您在包裹在段落视图中定义的字段。每当您在 Django 表单中发布内容时，您还必须在其中包含第6 行中的{% csrf_token %}模板标记。这是一种防止跨站点请求伪造的安全措施。

与其他模板一样，您{% extends "entries/base.html" %}在第 3 行添加以扩展基本模板。然后定义要包含在第block content4 行和第 18 行之间的标记中的内容。对entry_confirm_delete.htmlin使用相同的模式entries/templates/entries/：

<!-- entries/templates/entries/entry_confirm_delete.html -->

{% extends "entries/base.html" %}
{% block content %}
    <form method="post">{% csrf_token %}
        <p>
            Are you sure you want to delete
            <em>"{{ entry.title }}"</em>
            created on {{ entry.date_created|date:'Y-m-d' }}?
        </p>
        <input type="submit" value="Confirm">
    </form>
    <a href="{% url 'entry-detail' entry.id %}">
        <button>Cancel</button>
    </a>
{% endblock %}

当您要删除条目时，将显示此模板。在表单中提及"{{ entry.title }}"和 会{{ entry.created_date|date:'Y-m-d' }}提醒您按下确认键将删除哪个条目。

处理您的成功

得到一些反馈总是很好的，尤其是当它是积极的时。使用消息框架，您可以快速定义在提交表单后显示的一次性闪现消息。要使用此功能，进口messages和SuccessMessageMixin到entries/views.py：

# entries/views.py

from django.contrib import messages
from django.contrib.messages.views import SuccessMessageMixin

EntryListView并且EntryDetailView是阅读视图并且不处理表单。他们可能会在模板中显示一条消息，但不会发送一条消息。这意味着您不需要SuccessMessageMixin为它们创建子类。EntryCreateView，EntryUpdateView并且EntryDeleteView，在另一方面，也通知添加到邮件存储，所以你需要调整它们的功能：

 1# entries/views.py
 2
 3class EntryCreateView(SuccessMessageMixin, CreateView):
 4    model = Entry
 5    fields = ["title", "content"]
 6    success_url = reverse_lazy("entry-list")
 7    success_message = "Your new entry was created!"
 8
 9class EntryUpdateView(SuccessMessageMixin, UpdateView):
10    model = Entry
11    fields = ["title", "content"]
12    success_message = "Your entry was updated!"
13
14    def get_success_url(self):
15        return reverse_lazy(
16            "entry-detail",
17            kwargs={"pk": self.object.pk}
18        )

在第 3 行和第 9行继承SuccessMessageMixinin之后，您在第 7 行和第 12 行为它们定义 a 。特别是当您执行删除条目等破坏性操作时，提供一切正常的反馈至关重要。要在 中显示消息，您必须添加自定义方法并手动将自定义添加到消息框架：EntryCreateViewEntryUpdateViewsuccess_messageDeleteView.delete()success_message

 1# entries/views.py
 2
 3class EntryDeleteView(DeleteView):
 4    model = Entry
 5    success_url = reverse_lazy("entry-list")
 6    success_message = "Your entry was deleted!"
 7
 8    def delete(self, request, *args, **kwargs):
 9        messages.success(self.request, self.success_message)
10        return super().delete(request, *args, **kwargs)

您在第 8 行需要这个额外的方法，因为DeleteView该类不是FormView. 这就是为什么你可以跳过添加SuccessMessageMixin在EntryDeleteView第3行。

点击下方链接，查看完整内容entries/views.py。您可以在source_code_step_6/目录中找到它：

现在视图发送消息，您需要增强模板以显示它们。

获取消息

消息存储在消息存储器中。通过循环遍历它，您可以显示当前在消息存储中的所有消息。在 Django 模板中，您可以通过使用消息模板标签来实现这一点。您构建日记和构建模板的方式，您只需要将其添加到entries/base.html：

 1<!-- entries/base.html -->
 2
 3<h1><a href="/">Dear diary …</a></h1>
 4
 5{% if messages %}
 6    <ul class="messages">
 7    {% for message in messages %}
 8        <li class="message">
 9            {{ message }}
10        </li>
11    {% endfor %}
12    </ul>
13{% endif %}
14
15{% block content %}{% endblock %}

通过将消息列表包装{% if messages %}在第 4 行和第 12 行，您可以确保只有在存储中有任何消息时才会有条件地显示它。

改善您的导航

要创建、编辑或删除条目，您需要记住相应的 URL，然后在地址栏中键入它们。多么乏味！幸运的是，您可以通过向视图添加链接来解决此问题。从模板中的entry-create视图链接开始entries/templates/entries/entry-list.html：

 1<!-- entries/templates/entries/entry-list.html -->
 2
 3{% block content %}
 4<article>
 5    <h2 class="mark">{% now "Y-m-d H:i" %}</em></h2>
 6    <a href="{% url 'entry-create' %}"><button>Add new entry</button></a>
 7</article>
 8
 9{% for entry in object_list %}

此标记将类似于其他日记条目列表项。立即向entries/templates/entries/entry_detail.html模板添加新段落以</article>快速编辑或删除条目：

<!-- entries/templates/entries/entry_detail.html -->

</article>
<p>
    <a href="{% url 'entry-update' entry.id %}">✍️ Edit</a>
    <a href="{% url 'entry-delete' entry.id %}">⛔ Delete</a>
</p>
{% endblock %}

此代码在分别链接到entry-update和的条目详细信息下方添加了两个链接entry-delete。

第 7 步：锁定你的 Django 日记

多么小的金锁是用于物理日记，登录表单是用于您的数字日志。此锁的关键是您已用于登录 Django 管理站点的名称和密码组合。

<!-- entries/templates/entries/base.html -->

{% load static %}
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>My Diary</title>
    <link rel="stylesheet" href="{% static 'css/diary.css' %}">
</head>

<body>
<h1><a href="/">Dear diary …</a></h1>

{% if messages %}
    <ul class="messages">
    {% for message in messages %}
        <li class="message">
            {{ message }}
        </li>
    {% endfor %}
    </ul>
{% endif %}

{% block content %}{% endblock %}

<hr>
<a href="{% url 'admin:logout' %}">Logout</a>
</body>

</html>