静态资源和Ajax请求

基于前面两个章节讲解的知识，我们已经可以使用Django框架来完成Web应用的开发了。接下来我们就尝试实现一个投票应用，具体的需求是用户进入应用首先查看到“学科介绍”页面，该页面显示了一个学校所开设的所有学科；通过点击某个学科，可以进入“老师介绍”页面，该页面展示了该学科所有老师的详细情况，可以在该页面上给老师点击“好评”或“差评”；如果用户没有登录，在投票时会先跳转到“登录页”要求用户登录，登录成功才能投票；对于未注册的用户，可以在“登录页”点击“新用户注册”进入“注册页”完成用户注册操作，注册成功后会跳转到“登录页”，注册失败会获得相应的提示信息。

准备工作

由于之前已经详细的讲解了如何创建Django项目以及项目的相关配置，因此我们略过这部分内容，唯一需要说明的是，从上面对投票应用需求的描述中我们可以分析出三个业务实体：学科、老师和用户。学科和老师之间通常是一对多关联关系（一个学科有多个老师，一个老师通常只属于一个学科），用户因为要给老师投票，所以跟老师之间是多对多关联关系（一个用户可以给多个老师投票，一个老师也可以收到多个用户的投票）。首先修改应用下的models.py文件来定义数据模型，先给出学科和老师的模型。

  1. from django.db import models
  4. class Subject(models.Model):
  5.     """学科"""
  6.     no = models.IntegerField(primary_key=True, verbose_name='编号')
  7.     name = models.CharField(max_length=20, verbose_name='名称')
  8.     intro = models.CharField(max_length=511, default='', verbose_name='介绍')
  9.     create_date = models.DateField(null=True, verbose_name='成立日期')
  10.     is_hot = models.BooleanField(default=False, verbose_name='是否热门')
  12.     def __str__(self):
  13.         return self.name
  15.     class Meta:
  16.         db_table = 'tb_subject'
  17.         verbose_name = '学科'
  18.         verbose_name_plural = '学科'
  21. class Teacher(models.Model):
  22.     """老师"""
  23.     no = models.AutoField(primary_key=True, verbose_name='编号')
  24.     name = models.CharField(max_length=20, verbose_name='姓名')
  25.     detail = models.CharField(max_length=1023, default='', blank=True, verbose_name='详情')
  26.     photo = models.CharField(max_length=1023, default='', verbose_name='照片')
  27.     good_count = models.IntegerField(default=0, verbose_name='好评数')
  28.     bad_count = models.IntegerField(default=0, verbose_name='差评数')
  29.     subject = models.ForeignKey(to=Subject, on_delete=models.PROTECT, db_column='sno', verbose_name='所属学科')
  31.     class Meta:
  32.         db_table = 'tb_teacher'
  33.         verbose_name = '老师'
  34.         verbose_name_plural = '老师'

模型定义完成后，可以通过“生成迁移”和“执行迁移”来完成关系型数据库中二维表的创建，当然这需要提前启动数据库服务器并创建好对应的数据库，同时我们在项目中已经安装了PyMySQL而且完成了相应的配置，这些内容此处不再赘述。

  1. (venv)$ python manage.py makemigrations vote
  2. ...
  3. (venv)$ python manage.py migrate
  4. ...

注意：为了给vote应用生成迁移文件，需要修改Django项目settings.py文件，在INSTALLED_APPS中添加vote应用。

完成模型迁移之后，我们可以直接使用Django提供的后台管理来添加学科和老师信息，这需要先注册模型类和模型管理类。

  1. from django.contrib import admin
  3. from poll2.forms import UserForm
  4. from poll2.models import Subject, Teacher
  7. class SubjectAdmin(admin.ModelAdmin):
  8.     list_display = ('no', 'name', 'create_date', 'is_hot')
  9.     ordering = ('no', )
  12. class TeacherAdmin(admin.ModelAdmin):
  13.     list_display = ('no', 'name', 'detail', 'good_count', 'bad_count', 'subject')
  14.     ordering = ('subject', 'no')
  17. admin.site.register(Subject, SubjectAdmin)
  18. admin.site.register(Teacher, TeacherAdmin)

接下来，我们就可以修改views.py文件，通过编写视图函数先实现“学科介绍”页面。

  1. def show_subjects(request):
  2.     """查看所有学科"""
  3.     subjects = Subject.objects.all()
  4.     return render(request, 'subject.html', {'subjects': subjects})

至此，我们还需要一个模板页，模板的配置以及模板页中模板语言的用法在之前已经进行过简要的介绍，如果不熟悉可以看看下面的代码，相信这并不是一件困难的事情。

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>所有学科信息</title>
  6.     <style>/* 此处略去了层叠样式表的选择器 */</style>
  7. </head>
  8. <body>
  9.     <h1>所有学科</h1>
  10.     <hr>
  11.     {% for subject in subjects %}
  12.     <div>
  13.         <h3>
  14.             <a href="/teachers/?sno={{ subject.no }}">{{ subject.name }}</a>
  15.             {% if subject.is_hot %}
  16.             <img src="/static/images/hot.png" width="32" alt="">
  17.             {% endif %}
  18.         </h3>
  19.         <p>{{ subject.intro }}</p>
  20.     </div>
  21.     {% endfor %}
  22. </body>
  23. </html>

在上面的模板中，我们为每个学科添加了一个超链接，点击超链接可以查看该学科的讲师信息，为此需要再编写一个视图函数来处理查看指定学科老师信息。

  1. def show_teachers(request):
  2.     """显示指定学科的老师"""
  3.     try:
  4.         sno = int(request.GET['sno'])
  5.         subject = Subject.objects.get(no=sno)
  6.         teachers = subject.teacher_set.all()
  7.         return render(request, 'teachers.html', {'subject': subject, 'teachers': teachers})
  8.     except (KeyError, ValueError, Subject.DoesNotExist):
  9.         return redirect('/')

显示老师信息的模板页。

  1. <!DOCTYPE html>
  2. {% load static %}
  3. <html lang="en">
  4. <head>
  5.     <meta charset="UTF-8">
  6.     <title>老师</title>
  7.     <style>/* 此处略去了层叠样式表的选择器 */</style>
  8. </head>
  9. <body>
  10.     <h1>{{ subject.name }}学科老师信息</h1>
  11.     <hr>
  12.     {% if teachers %}
  13.     {% for teacher in teachers %}
  14.     <div>
  15.         <div>
  16.             <img src="{% static teacher.photo %}" alt="">
  17.         </div>
  18.         <div>
  19.             <h3>{{ teacher.name }}</h3>
  20.             <p>{{ teacher.detail }}</p>
  21.             <p class="comment">
  22.                 <a href="">好评</a>
  23.                 (<span>{{ teacher.good_count }}</span>)
  24.                 <a href="">差评</a>
  25.                 (<span>{{ teacher.bad_count }}</span>)
  26.             </p>
  27.         </div>
  28.     </div>
  29.     {% endfor %}
  30.     {% else %}
  31.     <h3>暂时没有该学科的老师信息</h3>
  32.     {% endif %}
  33.     <p>
  34.         <a href="/">返回首页</a>
  35.     </p>
  36. </body>
  37. </html>

加载静态资源

在上面的模板页面中，我们使用了<img>标签来加载老师的照片，其中使用了引用静态资源的模板指令{% static %}，要使用该指令，首先要使用{% load static %}指令来加载静态资源，我们将这段代码放在了页码开始的位置。在上面的项目中，我们将静态资源置于名为static的文件夹中，在该文件夹下又创建了三个文件夹：css、js和images，分别用来保存外部层叠样式表、外部JavaScript文件和图片资源。为了能够找到保存静态资源的文件夹，我们还需要修改Django项目的配置文件settings.py，如下所示：

  1. # 此处省略上面的代码
  3. STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static'), ]
  4. STATIC_URL = '/static/'
  6. # 此处省略下面的代码

接下来修改urls.py文件，配置用户请求的URL和视图函数的对应关系。

  1. from django.contrib import admin
  2. from django.urls import path
  4. from vote import views
  6. urlpatterns = [
  7.     path('', views.show_subjects),
  8.     path('teachers/', views.show_teachers),
  9.     path('admin/', admin.site.urls),
  10. ]

启动服务器运行项目，进入首页查看学科信息。

静态资源和Ajax请求 - 图1

点击学科查看老师信息。

静态资源和Ajax请求 - 图2

Ajax请求

接下来就可以实现“好评”和“差评”的功能了，很明显如果能够在不刷新页面的情况下实现这两个功能会带来更好的用户体验，因此我们考虑使用Ajax技术来实现“好评”和“差评”，Ajax技术我们在Web前端部分已经介绍过了，此处不再赘述。

首先修改项目的urls.py文件，为“好评”和“差评”功能映射对应的URL。

  1. from django.contrib import admin
  2. from django.urls import path
  4. from vote import views
  6. urlpatterns = [
  7.     path('', views.show_subjects),
  8.     path('teachers/', views.show_teachers),
  9.     path('praise/', views.prise_or_criticize),
  10.     path('criticize/', views.prise_or_criticize),
  11.     path('admin/', admin.site.urls),
  12. ]

设计视图函数praise_or_criticize来支持“好评”和“差评”功能，该视图函数通过Django封装的JsonResponse类将字典序列化成JSON字符串作为返回给浏览器的响应内容。

  1. def praise_or_criticize(request):
  2.     """好评"""
  3.     try:
  4.         tno = int(request.GET['tno'])
  5.         teacher = Teacher.objects.get(no=tno)
  6.         if request.path.startswith('/praise'):
  7.             teacher.good_count += 1
  8.         else:
  9.             teacher.bad_count += 1
  10.         teacher.save()
  11.         data = {'code': 200, 'hint': '操作成功'}
  12.     except (KeyError, ValueError, Teacher.DoseNotExist):
  13.         data = {'code': 404, 'hint': '操作失败'}
  14.     return JsonResponse(data)

修改显示老师信息的模板页，引入jQuery库来实现事件处理、Ajax请求和DOM操作。

  1. <!DOCTYPE html>
  2. {% load static %}
  3. <html lang="en">
  4. <head>
  5.     <meta charset="UTF-8">
  6.     <title>老师</title>
  7.     <style>/* 此处略去了层叠样式表的选择器 */</style>
  8. </head>
  9. <body>
  10.     <h1>{{ subject.name }}学科老师信息</h1>
  11.     <hr>
  12.     {% if teachers %}
  13.     {% for teacher in teachers %}
  14.     <div class="teacher">
  15.         <div class="photo">
  16.             <img src="{% static teacher.photo %}" height="140" alt="">
  17.         </div>
  18.         <div class="info">
  19.             <h3>{{ teacher.name }}</h3>
  20.             <p>{{ teacher.detail }}</p>
  21.             <p class="comment">
  22.                 <a href="/praise/?tno={{ teacher.no }}">好评</a>
  23.                 (<span>{{ teacher.good_count }}</span>)
  24.                 &nbsp;&nbsp;
  25.                 <a href="/criticize/?tno={{ teacher.no }}">差评</a>
  26.                 (<span>{{ teacher.bad_count }}</span>)
  27.             </p>
  28.         </div>
  29.     </div>
  30.     {% endfor %}
  31.     {% else %}
  32.     <h3>暂时没有该学科的老师信息</h3>
  33.     {% endif %}
  34.     <p>
  35.         <a href="/">返回首页</a>
  36.     </p>
  37.     <script src="https://cdn.bootcss.com/jquery/3.4.1/jquery.min.js"></script>
  38.     <script>
  39.         $(() => {
  40.             $('.comment>a').on('click', (evt) => {
  41.                 evt.preventDefault()
  42.                 let anchor = $(evt.target)
  43.                 let url = anchor.attr('href')
  44.                 $.getJSON(url, (json) => {
  45.                     if (json.code == 10001) {
  46.                         let span = anchor.next()
  47.                         span.text(parseInt(span.text()) + 1)
  48.                     } else {
  49.                         alert(json.hint)
  50.                     }
  51.                 })
  52.             })
  53.         })
  54.     </script>
  55. </body>
  56. </html>

小结

到此为止，这个投票项目的核心功能已然完成，在下面的章节中我们会要求用户必须登录才能投票，没有账号的用户可以通过注册功能注册一个账号。