Python的Web开发框架有很多种,常见的有Django、Flask、Tornado等,每种开发框架都有其自身特点,可以根据使用场景选用。
Django是一个开放源代码的Web应用框架,由Python写成。它适用于快速开发,因为它采用了MTV(模型M,模板T和视图V)模式,类似于JAVA Spring框架的MVC(模型M,视图V和控制器C)模式。
- M全拼为Model,与MVC中的M功能相同,负责和数据库交互,进行数据处理。
- V全拼为View,与MVC中的C功能相同,接收请求,进行业务处理,返回应答。
- T全拼为Template,与MVC中的V功能相同,负责封装构造要返回的html。
Flask是另一个Python Web应用框架,它非常轻量级,只提供了基本的框架功能。
Tornado是一个用Python写的异步非阻塞IO网络库,响应快速,可处理数千并发连接,特别适用用于实时的 Web 服务。
本文以Django为例,搭建一个可访问的“学习笔记”Web应用程序,以便熟悉Python基础Web应用程序开发。需要注意的是,本文演示的是前后端不分离场景。页面渲染过程中会有类似{% for topic in topics %}这样的偏后端(非纯前端)的语法标识符。
项目实现
1.创建项目
我们使用PyCharm基于新的虚拟环境创建项目learning_log:
这里有必要说一下虚拟环境的作用,虚拟环境是系统的一个位置,用来存放管理项目依赖包,而不用担心与其他项目中的同名不同版本的包产生冲突,支持独立部署。
比如:/Users/test/PycharmProjects/learning_log/venv目录下:
创建完成后:
也可以手动创建虚拟环境,可以执行命令:
python -m venv /Users/test/PycharmProjects/learning_log/venv
没有激活虚拟环境,可以执行命令:
source /Users/test/PycharmProjects/learning_log/venv/bin/activate
2.安装Django
这里使用PyCharm安装的,使用pip install命令安装也可以。
pip install django
查看安装版本:
python -m django --version
3.创建Django项目
在PyCharm终端命令行,切换到刚才创建的项目文件夹下,执行如下命令:
django-admin startproject learning_log .
这里的项目名可以和刚才创建的项目名称相同。命令行代码执行后,会在项目目录下多出一个目录,名字和项目名称一模一样,如下图所示,表示创建项目成功。
4.测试是否成功
通过终端命令行工具创建项目成功后,接着执行如下代码,启动服务器:
python manage.py runserver
执行结果如下:
使用浏览器访问:
http://127.0.0.1:8000
显示页面:
5. 创建数据库
Django将大部分与项目相关的信息都存储在数据库当中,我们可以使用如下命令进行同步数据库操作,默认使用SQLite数据库(使用文件存储的小型数据库)。首次执行该命令,会新建一个数据库。
python manage.py migrate
执行结果:
如果使用其他数据库,比如:MySQL数据库,需要下载安装mysqlclient包:
pip install mysqlclient
需要修改Django项目下的setting.py文件配置:
6.创建应用程序
Django项目由多个应用程序组成,它们协同工作,让项目成为一个整体。我们暂时只创建一个应用程序“learning_logs”。执行如下命令:
python manage.py startapp learning_logs
会生成目录learning_logs:
learning_logs目录:
工程结构:
7.定义模型
我们需要在学习笔记中创建主题,主题下有多个条目,每个条目都有文本和时间戳。
修改models.py:
from django.db import models
class Topic(models.Model):
"""A topic the user is learning about."""
text = models.CharField(max_length=200)
date_added = models.DateTimeField(auto_now_add=True)
def __str__(self):
"""Return a string representation of the model."""
return self.text
class Entry(models.Model):
"""Something specific learned about a topic."""
topic = models.ForeignKey(Topic, on_delete=models.CASCADE)
text = models.TextField()
date_added = models.DateTimeField(auto_now_add=True)
class Meta:
verbose_name_plural = 'entries'
def __str__(self):
"""Return a simple string representing the entry."""
return f"{self.text[:50]}..."
8.激活模型
在项目配置文件中添加自定义应用:
为了让Django能够修改数据库,使其能够存储与Topic和Entry相关的信息:
python manage.py makemigrations learning_logs
执行结果:
生成的0001_initial.py描述了创建表的信息:
执行数据同步,让Django能够修改数据库:
python manage.py migrate
9.创建超级用户
创建超级用户,执行如下命令:
python manage.py createsuperuser
根据提示输入用户名/密码,创建完成后,需要将自定义的模型Topic和Entry注册到网站。修改admin.py:
from django.contrib import admin
from .models import Topic, Entry
admin.site.register(Topic)
admin.site.register(Entry)
10.访问管理网站
输入如下地址:
http://127.0.0.1:8000/admin
输入用户名/密码后登录:
可以管理主题Topic和条目Entry:
11.交互式终端会话
通过交互式终端会话以编程的方式查看数据,这种交互式环境叫做Django Shell,可以用来排查问题。输入如下命令:
python manage.py shell
查看主题Topic和条目Entry:
12.创建主页
使用Django创建网页通常分为三个阶段:定义URL,编写视图和编写模板。URL模式描述了URL是如何设计的,将浏览器请求与URL匹配,确定返回哪个网页,也就是URL路由规则。
每个URL都被映射到特定的视图——视图函数获取并处理网页所需的数据,视图函数通常调用一个模板,后者生成浏览器能够理解的网页。类似于JAVA的JSP。
1)映射主页URL到视图
修改urls.py,将应用的urls包含到项目中:
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('', include('learning_logs.urls', namespace='learning_logs')),
]
在“learning_logs”中创建urls.py,将主页URL映射到index视图:
"""Defines URL patterns for learning_logs."""
from django.urls import path
from . import views
app_name = 'learning_logs'
urlpatterns = [
# Home page
path('', views.index, name='index'),
]
2)编写视图
视图相当于MVC模式中控制器C的功能,负责接收请求,进行业务处理,返回应答。修改“learning_logs”中的views.py:
from django.shortcuts import render
def index(request):
"""The home page for Learning Log."""
return render(request, 'learning_logs/index.html')
3)编写模板
在“learning_logs”中新建文件夹templates和其子文件夹learning_logs,在子文件夹learning_logs创建index.html:
<p>学习笔记</p>
<p>通过主题和条目,学习笔记可以帮你记录感兴趣的东西。</p>
13.测试主页
完整目录结构:
启动服务器后,使用浏览器访问:
http://127.0.0.1:8000
显示主页:
14.创建父模板
我们通过类似的过程,创建两个显示数据的网页,一个列出所有主题,另一个列出特定主题的所有条目。
为了减少重复工作,我们先创建一个父模板base.html,其他网页如果需要的话,可以继承这个父模板。
<p>
<a href="{% url 'learning_logs:index' %}">学习笔记</a> -
<a href="{% url 'learning_logs:topics' %}">主题</a>
</p>
{% block content %}{% endblock content %}
模板标签是一小段代码,可以生成网页中要显示的内容:
{% url 'learning_logs:index' %}#
块标签中的内容是占位符,其中所包含的内容由子模板指定。需要注意的是,子模板并非必须定义父模板中的每个块,父模板可以有多个块,子模板根据需要指定块。
继承base.html,重新编写之前的index.html:
{% extends 'learning_logs/base.html' %}
{% block content %}
<p>通过主题和条目,学习笔记可以帮你记录感兴趣的东西。</p>
{% endblock content %}
15.创建显示所有主题的页面
1)URL模式
修改“learning_logs”中的urls.py,匹配"topics/"URL:
"""Defines URL patterns for learning_logs."""
from django.urls import path
from . import views
app_name = 'learning_logs'
urlpatterns = [
# 匹配到该路径后,跳转到主页函数index()
path('', views.index, name='index'),
# 匹配到该路径后,跳转到视图函数topics()
path('topics/', views.topics, name='topics'),
]
2)视图
修改“learning_logs”中的views.py,从数据库获取和处理数据后,传递给模板根据数据渲染出界面:
from django.shortcuts import render
from .models import Topic
def index(request):
"""The home page for Learning Log."""
return render(request, 'learning_logs/index.html')
def topics(request):
#从数据库中根据添加时间排序后返回所有主题列表
topics = Topic.objects.order_by('date_added')
#放入上下文
context = {'topics': topics}
return render(request, 'learning_logs/topics.html', context)
3)模板
在“templates/learning_logs”中创建topics.html:
{% extends 'learning_logs/base.html' %}
{% block content %}
<p>主题列表</p>
<ul>
{% for topic in topics %}
<li>
<a>
{{ topic.text }}
</a>
</li>
{% empty %}
<li>没有添加任何主题。</li>
{% endfor %}
</ul>
{% endblock content %}
16.测试显示所有主题的页面
完整目录结构:
显示主页:
点击主题:
17.创建显示主题下所有条目的页面
1)URL模式
修改“learning_logs”中的urls.py,匹配"topics/id"URL:
"""Defines URL patterns for learning_logs."""
from django.urls import path
from . import views
app_name = 'learning_logs'
urlpatterns = [
# Home page
path('', views.index, name='index'),
# Page that shows all topics.
path('topics/', views.topics, name='topics'),
# Detail page for a single topic.
path('topics/<int:topic_id>/', views.topic, name='topic'),
]
2)视图
修改“learning_logs”中的views.py,从数据库获取和处理数据后,传递给模板根据数据渲染出界面:
from django.shortcuts import render
from .models import Topic
def index(request):
"""The home page for Learning Log."""
return render(request, 'learning_logs/index.html')
def topics(request):
"""Show all topics."""
topics = Topic.objects.order_by('date_added')
context = {'topics': topics}
return render(request, 'learning_logs/topics.html', context)
def topic(request, topic_id):
"""Show a single topic and all its entries."""
topic = Topic.objects.get(id=topic_id)
entries = topic.entry_set.order_by('-date_added')
context = {'topic': topic, 'entries': entries}
return render(request, 'learning_logs/topic.html', context)
3)模板
修改在“templates/learning_logs”中的topics.html,添加到单个主题的链接:
{% extends 'learning_logs/base.html' %}
{% block content %}
<p>主题列表</p>
<ul>
{% for topic in topics %}
<li>
<a href="{% url 'learning_logs:topic' topic.id %}">
{{ topic.text }}</a></li>
{% empty %}
<li>没有添加任何主题。</li>
{% endfor %}
</ul>
{% endblock content %}
在“templates/learning_logs”中创建topic.html:
{% extends 'learning_logs/base.html' %}
{% block content %}
<p>主题: {{ topic.text }}</p>
<p>条目列表:</p>
<ul>
{% for entry in entries %}
<li>
<p>{{ entry.date_added|date:'M d, Y H:i' }}</p>
<p>{{ entry.text|linebreaks }}</p>
</li>
{% empty %}
<li>当前主题下没有任何条目。</li>
{% endfor %}
</ul>
{% endblock content %}
18.测试显示主题下所有条目的页面
完整目录结构:
显示主页:
点击主题:
点击主题列表中的某一项:
19.管理主题和条目页面
完成添加新主题,添加新条目,编辑条目操作。
1)主题和条目的表单
收集用户输入的数据是通过表单完成的,针对主题和条目的表单,我们需要先创建一个forms.py:
from django import forms
from .models import Topic, Entry
class TopicForm(forms.ModelForm):
class Meta:
model = Topic
#使用主题的'text'字段
fields = ['text']
#不为字段'text'生成标签
labels = {'text': ''}
class EntryForm(forms.ModelForm):
class Meta:
model = Entry
fields = ['text']
labels = {'text': ''}
widgets = {'text': forms.Textarea(attrs={'cols': 80})}
2)URL模式
修改“learning_logs”中的urls.py:
"""Defines URL patterns for learning_logs."""
from django.urls import path
from . import views
app_name = 'learning_logs'
urlpatterns = [
# Home page
path('', views.index, name='index'),
# Page that shows all topics.
path('topics/', views.topics, name='topics'),
# Detail page for a single topic.
path('topics/<int:topic_id>/', views.topic, name='topic'),
# Page for adding a new topic.
path('new_topic/', views.new_topic, name='new_topic'),
# Page for adding a new entry.
path('new_entry/<int:topic_id>/', views.new_entry, name='new_entry'),
# Page for editing an entry.
path('edit_entry/<int:entry_id>/', views.edit_entry, name='edit_entry'),
]
3)视图
修改“learning_logs”中的views.py,从数据库获取和处理数据后,传递给模板根据数据渲染出界面:
from django.shortcuts import render, redirect
from .models import Topic, Entry
from .forms import TopicForm, EntryForm
def index(request):
"""The home page for Learning Log."""
return render(request, 'learning_logs/index.html')
def topics(request):
"""Show all topics."""
topics = Topic.objects.order_by('date_added')
context = {'topics': topics}
return render(request, 'learning_logs/topics.html', context)
def topic(request, topic_id):
"""Show a single topic and all its entries."""
topic = Topic.objects.get(id=topic_id)
entries = topic.entry_set.order_by('-date_added')
context = {'topic': topic, 'entries': entries}
return render(request, 'learning_logs/topic.html', context)
def new_topic(request):
"""Add a new topic."""
if request.method != 'POST':
# No data submitted; create a blank form.
form = TopicForm()
else:
# POST data submitted; process data.
form = TopicForm(data=request.POST)
#根据表单定义,检查输入数据的有效性
if form.is_valid():
#保存数据
form.save()
#重定向
return redirect('learning_logs:topics')
# Display a blank or invalid form.
context = {'form': form}
return render(request, 'learning_logs/new_topic.html', context)
def new_entry(request, topic_id):
"""Add a new entry for a particular topic."""
topic = Topic.objects.get(id=topic_id)
if request.method != 'POST':
# No data submitted; create a blank form.
form = EntryForm()
else:
# POST data submitted; process data.
form = EntryForm(data=request.POST)
if form.is_valid():
new_entry = form.save(commit=False)
new_entry.topic = topic
new_entry.save()
return redirect('learning_logs:topic', topic_id=topic_id)
# Display a blank or invalid form.
context = {'topic': topic, 'form': form}
return render(request, 'learning_logs/new_entry.html', context)
def edit_entry(request, entry_id):
"""Edit an existing entry."""
entry = Entry.objects.get(id=entry_id)
topic = entry.topic
if request.method != 'POST':
# Initial request; pre-fill form with the current entry.
form = EntryForm(instance=entry)
else:
# POST data submitted; process data.
form = EntryForm(instance=entry, data=request.POST)
if form.is_valid():
form.save()
return redirect('learning_logs:topic', topic_id=topic.id)
context = {'entry': entry, 'topic': topic, 'form': form}
return render(request, 'learning_logs/edit_entry.html', context)
4)模板
创建新模板new_topic.html,显示主题表单:
{% extends "learning_logs/base.html" %}
{% block content %}
<p>添加新的主题:</p>
<form action="{% url 'learning_logs:new_topic' %}" method='post'>
{% csrf_token %}
{{ form.as_p }}
<button name="提交">添加新主题</button>
</form>
{% endblock content %}
备注:{% csrf_token %}是为了预防跨站请求伪造攻击;{{ form.as_p }}用于根据TopicForm.Meta中对于表单字段定义渲染出表单样式。
在topics.html添加到new_topic.html的链接:
{% extends 'learning_logs/base.html' %}
{% block content %}
<p>主题列表</p>
<ul>
{% for topic in topics %}
<li>
<a href="{% url 'learning_logs:topic' topic.id %}">
{{ topic.text }}</a></li>
{% empty %}
<li>没有添加任何主题。</li>
{% endfor %}
</ul>
<a href="{% url 'learning_logs:new_topic' %}">添加新主题</a>
{% endblock content %}
创建新模板new_entry.html,显示条目表单:
{% extends "learning_logs/base.html" %}
{% block content %}
<p><a href="{% url 'learning_logs:topic' topic.id %}">{{ topic }}</a></p>
<p>添加新的条目:</p>
<form action="{% url 'learning_logs:new_entry' topic.id %}" method='post'>
{% csrf_token %}
{{ form.as_p }}
<button name='提交'>添加新条目</button>
</form>
{% endblock content %}
创建新模板edit_entry.html,显示条目表单:
{% extends "learning_logs/base.html" %}
{% block content %}
<p><a href="{% url 'learning_logs:topic' topic.id %}">{{ topic }}</a></p>
<p>编辑条目:</p>
<form action="{% url 'learning_logs:edit_entry' entry.id %}" method='post'>
{% csrf_token %}
{{ form.as_p }}
<button name="提交">保存修改</button>
</form>
{% endblock content %}
在topic.html添加到new_entry.html和edit_entry.html的链接:
{% extends 'learning_logs/base.html' %}
{% block content %}
<p>主题: {{ topic.text }}</p>
<p>条目列表:</p>
<p>
<a href="{% url 'learning_logs:new_entry' topic.id %}">添加新条目</a>
</p>
<ul>
{% for entry in entries %}
<li>
<p>{{ entry.date_added|date:'M d, Y H:i' }}</p>
<p>{{ entry.text|linebreaks }}</p>
<p>
<a href="{% url 'learning_logs:edit_entry' entry.id %}">
编辑条目</a></p>
</li>
{% empty %}
<li>当前主题下没有任何条目。</li>
{% endfor %}
</ul>
{% endblock content %}
20.测试管理主题和条目
完整目录结构:
显示主页:
点击主题:
点击添加新主题:
点击新添加的主题:
点击添加新条目:
点击编辑条目:
保存修改: