Fork me on GitHub

Django 入门基础（ORM）

字数统计: 3.1k字   |   阅读时长≈ 14分

书籍名称：[Python3 自动化软件发布系统-Django2 实战]

函数视图操作 ORM（显示 board 列表）

编写 boards_list 视图

在bbs/views.py 里新增一个 boards_list 函数

1
2
3
4
5
from .models import Board

def boards_list(request):
    boards = Board.objects.all()
    return render(request, 'bbs/boards_list.html', {'boards': boards})

代码解释:
使用 objects 管理器的 all() 方法，获取 Board 表中的所有记录，这条 ORM 略相当于 [SELECT id, name, description FROM Board;], 然后使用 render 这个快捷方法，渲染 boards_list.html 模板，传递一个 boards 上下文；

编写 boards_list 模板

在 bbs/templates/bbs/ 目录下新增一个模板文件 boards_list.html，内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title> Boards_list </title>
</head>
<body>
<ul>
    {% for board in boards %}
        <li><a href="{% url 'board_topics' board.pk %}">
            {{ board.id }}. {{ board.name }}</a><br />
            {{ board.description }}
        </li>
    {% endfor %}
</ul>
</body>
</html>

代码解释：

  • 这里以最简单的方式实现了一个显示所有 board 名称及描述的列表。
  • 第9~13行：实现了循环读取每一条 board 的功能。
  • 第10行：显示指定的 board 的 URL，在下一小节实现；注意，我们为这个 URL 指定了一个参数: board.pk，这个参数是需要名为 board_topics 的 URL 来捕获的；
  • 第11~12行：{{ board.id }} 这样的模板变量，用于显示 board 的 id, 名称及描述；

添加 boards_list 路由

在 django_demo_project/urls.py 里面，新增一条 URL 路由

1
2
3
4
urlpatterns = [
    ...
    path('boards_list/', bbs_view.boards_list, name='boards_list'),
]

测试 boards_list 访问

启动服务，在浏览器访问 http://127.0.0.1:8000/boards_list/，此时访问报如下错误，因为 board_topics 视图并没有写完；

1
reverse for 'board_topics' with arguments '(1,)' not found. 1 pattern(s) tried: ['board_topics/$']

函数视图操作 ORM（显示指定 board 的 topic 列表）

编写 board_topics 视图

在 bbs/views.py 文件里新增 board_topics 函数

1
2
3
4
def board_topics(request, pk):
    board = Board.objects.get(id=pk)
    topics = board.topics.all()
    return render(request, 'bbs/board_topics.html', {'board': board, 'topics': topics})

代码解释:

  • 第1行，由于我们在此函数的 URL 中捕获了一个 pk 参数，所以将其传送到了函数；
  • 第2行，使用 objects 管理器的 all() 方法，获取指定的 board 实例；
  • 第3行，使用 Topic 数据表中 board 外键的 related_name(topics)，获取了指定 board 的所有 topic；
  • 第4行，使用 render 方法渲染 board_topics.html 模板，传递一个 board 和 topics 上下文；

编写 board_topics 模板

在 bbs/templates/bbs/ 目录下，新增一个上文提到的模板文件 board_topics.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<div class="table table-striped mb-4">
    <a href="{% url 'new_topic' board.pk %}">发新帖</a>
</div>
<table class="table">
    <thead class="thead-dark">
        <tr>
            <th>Topic</th>
            <th>Starter</th>
            <th>Replies</th>
            <th>Last Update</th>
        </tr>
    </thead>
    <tbody>
    {% for topic in topics %}
        <tr>
            <td>
                <p class="mb-0">
                    <a href="{% url 'topic_posts' board.pk topic.pk %}">{{ topic.subject }}</a>
                </p>
            </td>
            <td class="align-middle">{{ topic.starter.username }}</td>
            <td class="align-middle">{{ topic.replies }}</td>
            <td class="align-middle">{{ topic.last_updated }}</td>
        </tr>
    {% endfor %}
    </tbody>
</table>

<div class="table table-striped mb-4">
    <a href="{% url 'boards_list' %}">BBS 列表</a>
</div>

代码解释:

  • 第2行，发帖功能，在接下来实现；
  • 第15~26行，实现了循环读取每一条 topic 的功能；
  • 第19行，显示指定了 topic 内容的 URL，并为这个 URL 传递了两个参数：board.pk，topic.pk；
  • 第22行，{{ topic.starter.username }} 这样的模板变量，用于显示 topic 中的 starter 这个外键数据表中的 username 字段名称；

添加 board_topics 路由

在 django_demo_project/urls.py 文件中新增一条路由实例

1
2
3
4
urlpatterns = [
    ...
    path('boards/<pk>/', bbs_view.board_topics, name='board_topics')
]

测试 board_topics 访问

启动服务，在浏览器访问 http://127.0.0.1:8000/boards_list/，然后点击 Python 链接。此时访问报如下错误，因为缺少 new_topic 视图；

1
Reverse for 'new_topic' not found. 'new_topic' is not a valid view function or pattern name.

函数视图操作 ORM（新增 topic）

新增 Form 文件

在 bbs/ 目录下，新增一个 forms.py 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
from django import forms
from bbs.models import Topic

class NewTopicForm(forms.ModelForm):
    message = forms.CharField(
        widget=forms.Textarea(
            attrs={'rows': 5, 'placeholder': 'What is on your mind?'}
        ),
        max_length=4000,
        help_text='The max length of the text is 4000.')

    class Meta:
        model = Topic
        fields = ['subject', 'message']

代码解释:

  • 我们这里实现了一个 Django 的 ModelForm。关于表单的知识会在后面讲述，这里可以理解为网页里的一个 <form></form> 之间的内容；

编写 new_topic 视图

在 bbs/views.py 文件里新增一个 new_topic 函数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
def new_topic(request, pk):
    board = get_object_or_404(Board, pk=pk)
    user = User.objects.get(pk=1)
    if request.method == 'POST':
        form = NewTopicForm(request.POST)
        if form.is_valid():
            topic = form.save(commit=False)
            topic.board = board
            topic.starter = user
            topic.save()
            Post.objects.create(
                message=form.cleaned_data.get('message'),
                topic=topic,
                created_by=user
            )
            return redirect('topic_posts',
                            pk=pk,
                            topic_pk=topic.pk)
    else:
        form = NewTopicForm()
    return render(request, 'bbs/new_topic.html',
                  {'board': board, 'form': form})

代码解释:

  • 由于在此函数的 URL 中捕获了一个 pk 参数，所以将其传递到了函数；
  • get_object_or_404 这个方法，相当于使用 objects 管理器的 get 方法，但是同时判断了出错的情况，如果有数据，则与 get 方法一样返回；如果没有数据，则直接给网页返回 404 错误；
  • 第4~18行，如果在网页中以 POST 方法提交数据，，则这里的逻辑上会保存这个 topic 数据，之后，URL 会跳转到这个新的 topic，因为用户有新增 topic 时，subject 是属于 Topic 表，而message 是属于 Post 表，所以这里做了分开保存；form.is_valid() 这样的方法后面讲到 Django 表单的时候再分析；
  • 第20行，如果在网页中以 GET 方法请求此 URL，则调用 render 方法，并指定一个新的 form；

编写 new_topic 模板

在 bbs/templates/bbs/ 目录下，新增上文提到的模板文件 new_topic.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<li><a href="{% url 'boards_list' %}"> Borads</a></li>
<li><a href="{% url 'board_topics' board.pk %}">{{ board.name }}</a></li>
<li>New topic</li>

<form method="post">
    {% csrf_token %}
    {% if form.non_field_errors %}
        <div>
        {% for error in form.non_field_errors %}
            <p>{{ error }}</p>
        {% endfor %}
        </div>
    {% endif %}

    <div>
        {{ form.subject.label_tag }}
        {{ form.subject }}
        {% for error in form.subject.errors %}
            <div>
            {{ error }}
            </div>
        {% endfor %}
        {% if form.subject.help_text %}
            <small>
            {{ form.subject.help_text|safe }}
            </small>
        {% endif %}
    </div>

    <div>
        {{ form.message.label_tag }}
        {{ form.message }}
        {% for error in form.message.errors %}
            <div>
            {{ error }}
            </div>
        {% endfor %}
        {% if form.message.help_text %}
            <small>
            {{ form.message.help_text|safe }}
            </small>
        {% endif %}
    </div>
<button type="submit">发帖</button>
</form>

代码解释:

  • 第1~2行，如果用户不准备发新帖了，则提供一个返回前两级网页的 URL 链接；
  • 第5~45行，实现了一个 form 表单，我们逐条渲染 form 表单里的每个字段，并且将是否有错误提示也一并渲染；
  • 第6行，{% csrf_token %} 这里是为了增加表单的安全性而设计的 token；

添加 new_topic 路由

在 django_demo_project/urls.py 文件添加一条路由实例

1
2
3
4
urlpatterns = [
    ...
    path('boards/<pk>/<new>/', bbs_view.new_topic, name='new_topic')
]

测试 new_topic 访问

浏览器输入 http://127.0.0.1:8000/boards/2/new/，测试访问是否正常；

函数视图操作 ORM（指定 board 的 topic 内容）

编写 topic_posts 视图

在 bbs/views.py 中新增一个 topic_posts 函数

1
2
3
4
5
def topic_posts(request, pk, topic_pk):
    topic = Topic.objects.get(pk=topic_pk, board__pk=pk)
    posts = topic.posts.all()
    return render(request, 'bbs/posts.html',
                  {'board_pk': pk, 'topic': topic, 'posts': posts})

代码解释：

  • 第1行，由于此函数的 URL 中捕获了两个参数，一个是 board 的 pk，一个是 topic 的 pk，所以将其传递到了函数；
  • 第2行，使用 objects 管理器的 get() 方法，获取指定的 topic 实例；
  • 第3行，使用 Post 数据表中 topic 外键的 related_name（posts），获取了指定 topic 的所有 post；
  • 第4~6行，使用 render 方法，渲染 posts.html 模板，并传递了上下文。

编写 topic_posts 模板

在 bbs/templates/bbs/ 目录下，新增一个上文提到的模板文件 posts.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<div>
    <a href="{% url 'board_topics' board_pk %}">
    {{ topic.board }}</a>
    --- {{ topic.subject }}
</div>
{% for post in posts %}
    <div class="card-body p-3">
    <div class="row">
        <div class="col-10">
            <div class="row mb-3">
                <div class="col-6">
                    <strong class="text-muted">
                        {{ post.created_by.username }}
                    </strong>
                </div>
                <div class="col-6 text-right">
                    <small class="text-muted">
                        {{ post.created_at }}
                    </small>
                </div>
            </div>
            {{ post.message }}
        </div>
    </div>
    </div>
{% endfor %}

代码解释：

  • 第2行，建立一个 URL 连接，可以回到此 board；
  • 第6~27行，实现了循环读取 topic 的第一个 post 的内容；
  • 第13行， 这样的模板变量，用于显示 topic 中的 created_by 这个外键数据表中的 username 字段名称；

添加 topic_posts 路由

在 django_demo_project/urls.py 文件中新增一条 URL 实例

1
2
3
4
urlpatterns = [
    ...
    path('boards/<pk>/topics/<topic_pk>/', bbs_view.topic_posts, name='topic_posts')
]

测试 topic_posts 访问

在浏览器中点击帖子列表，查看效果；

类视图操作 ORM（显示 board 列表）

前面演示的都是用函数视图来操作的 ORM，Python 是一个面向对象的编程语言，如果只用函数来开发，那么有很多面向对象的优点就错失了。所以 Django 在后来加入了 Class-Based-View，可以让我们用类写 View。这样做的优点是不但提高了代码的复用性，可以使用面向对象的技术，比如 Mixin（多继承），而且可以用不同的函数针对不同的 HTTP 方法处理，而不是通过很多的 if 判断，提高了代码的可读性。

下面就来实现一个简单的类视图：

编写 BoardList 类视图

在 bbs/views.py 里面新增一个 BoardList 类

1
2
3
4
class BoardList(ListView):
    model = Board
    context_object_name = 'boards'
    template_name = 'bbs/boards_list.html'

代码解释：

  • 第1行，BoardList 类继承了一个通用的 ListView 类。更多的通用类稍后说明；
  • 第2行，此类视图使用的 Model 为 Board;
  • 第3行，重定义类视图的上下文变量名为 boards，不然默认的为 object_list；
  • 第4行，定义此类视图使用的模板同样为 bords_list.html。为了和函数视图保持兼容，这里定义的上下文和模板名称与函数视图中的一模一样。

新建 boards_list 模板

这里不用新建模板文件，就使用 bbs/templates/bbs/boards_list.html 作为模板

添加路由实例

在 django_demo_project/urls.py 文件中添加路由实例

1
2
3
4
urlpatterns = [
    ...
    path('boards_list_view/', bbs_view.BoardList.as_view(), name='boards_list_view'),
]

测试访问

在浏览器里面访问 http://127.0.0.1:8000/boards_list_view/, 查看效果

Django 中的类视图

类别 名称
基本类别 TemplateView
RedirectView
通用显示视图 DetailView
ListView
通用编辑视图 FormView
CreateView
UpdateView
DeleteView
通用日期视图 ArchiveIndexView
YearArchiveView
MonthArchiveView
WeekArchiveView
DayArchiveView
TodayArchiveView
DateDetailArchiveView

设置 Django 使用 MySQL

如果要将 Django 后端连接的数据库配置为 MySQL，则只需要将 settings.py 中的 DATABASES 配置修改为如下内容即可：

1
2
3
4
5
6
7
8
9
10
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'bbs',
        'HOST': '127.0.0.1',
        'PORT': '3306',
        'USER': 'root',
        'PASSWORD': 'root_password',
    }
}

注意几点：

  • 需要提前在 MySQL 中建好数据库；
  • 需要使用 pip 安装类似 pymysql 的模块；
  • 以上是最低配置，在生产环境需要更详细的配置，请参考更多文档。

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia-plus根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

主要涉及技术：
Linux 运维、自动化运维、
Kubernetes、Python、Jenkins、Docker

联系QQ:2350686113

很惭愧

只做了一点微小的工作
谢谢大家