Django

Django是一个基于Python的Web框架，它可以帮助开发人员快速构建高质量的Web应用程序。

官网：https://www.djangoproject.com/

GitHub：https://github.com/django/django

安装Django

pip install django

pip install django==具体版本号

创建Django项目

创建工程

安装Django之后，就有了可用的管理工具Django-admin。Django-admin是一个命令行工具，用于管理 Django 项目。

常用命令:

startproject: 创建新的 Django 项目

startapp: 在现有的 Django 项目中创建新的应用程序

runserver: 启动 Django 开发服务器

makemigrations: 根据模型更改创建数据库迁移

migrate: 应用数据库迁移以更新数据库结构

createsuperuser: 创建超级用户

test: 运行测试套件

shell: 启动 Django shell

collectstatic: 收集静态文件并将其复制到指定目录中

dbshell: 启动数据库 shell

项目工程目录可以借助django提供的命令帮助创建

django-admin startproject 工程名称

工程目录说明

创建的工程目录结构如下


与项目同名的目录，此处为demo。

manage.py：一个实用的命令行工具，可以各种方式与该 Django项目进行交互

__init__.py：一个空文件，告诉 Python 该目录是一个 Python 包

asgi.py： 一个 ASGI 兼容的 Web 服务器的入口，以便运行你的项目

manage.py：项目管理文件，通过它管理项目

settings.py：项目的整体配置文件

urls.py：项目的URL配置文件

wsgi.py：项目与WSGI兼容的Web服务器入口

运行开发服务器

django提供了一个纯python编写的轻量级web服务器，仅在开发阶段使用，能够快速预览到开发的效果。默认工作在调式Debug模式下，如果增加、修改、删除文件，服务器会自动重启。

python manage.py runserver ip:端口

# 默认IP是127.0.0.1，默认端口为8000
python manage.py runserver

(py3) D:\WorkSpace\Python\demo>python manage.py runserver
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).

You have 18 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions.
Run 'python manage.py migrate' to apply them.
December 02, 2022 - 23:41:36
Django version 4.1.3, using settings 'demo.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.

访问：http://127.0.0.1:8000/

若指定IP:端口的形式启动服务，则需要在settings.py配置文件中进行配置，添加允许允许的IP、域名

# 允许那个主机访问后端,是一种安全机制
ALLOWED_HOSTS = ['127.0.0.1','www.test.com']

python manage.py runserver www.test.com:端口

python manage.py runserver IP:端口

settings.py配置文件

BASE_DIR

当前工程的根目录，Django根据此配置来定位工程内的相关文件，也可以使用该参数构造文件路径。

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

DEBUG

调试模式，创建工程后初始值为True，即默认工作在调试模式下。其主要作用就是修改代码文件，程序自动重启，当Django程序出现异常时，向前端显示详细的错误追踪信息。反之非调试模式下，仅返回Server Error (500)

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

应用的创建

在开发中通常将工程项目拆分为不同的子功能模块，各功能模块间可以保持相对的独立

创建应用模块

在工程项目目录执行如下命令创建一个子应用模块

python manage.py startapp 子应用名称

子应用模块目录结构如下：

应用模块文件说明

migrations：目录用于存放数据库迁移历史文件

admin.py：文件跟网站的后台管理站点配置相关

apps.py：文件用于配置当前子应用的相关信息

models.py：文件用户保存数据库模型类

tests.py：文件用于开发测试用例，编写单元测试

views.py：文件用于编写Web应用视图

App应用配置

在每个应用目录中都包含apps.py文件，它用于保存该应用的相关信息。在创建应用时，Django会向apps.py文件中写入一个该应用的配置类

from django.apps import AppConfig

class UserConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'user'
    verbose_name = '用户模块'

AppConfig.name：表示这个配置类是加载到哪个应用，每个配置类必须包含此属性，默认自动生成。

AppConfig.verbose_name：用于设置该应用的名字，名字在Django提供的Admin管理站点中会显示,默认没有该参数配置。

注册安装子应用

创建出来的子应用目录文件虽然被放到了工程项目目录中，但是django工程并不能立即直接使用该子应用，需要注册安装后才能使用。

打开工程配置文件settings.py，INSTALLED_APPS项保存工程中已经注册安装的子应用，初始工程中的INSTALLED_APPS如下：

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

注册安装一个子应用：将子应用的配置信息文件apps.py中的Config类添加到INSTALLED_APPS列表。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # 添加注册子应用
    # 方式一
    # '子应用名称.apps.子应用名Config'
    'user.apps.UserConfig',
    # 方式二
    # '子应用名称'
    'user',
]

数据模型

Django 对各种数据库提供了统一的调用API，包括：PostgreSQL、MySQL、SQLite、Oracle。

ORM概述

Django 模型使用自带的 ORM。

模型是MVT设计模式中的Model, 专门负责和数据库交互，对应models.py文件

Model中内嵌了ORM框架, 只需要定义模型类, 通过模型类和对象完成数据库表的增删改查

ORM框架就是把数据库表的行与相应的对象建立关联, 互相转换，使得数据库的操作面向对象化

对象关系映射（Object Relational Mapping，简称 ORM ）用于实现面向对象编程语言里不同类型系统的数据之间的转换。

ORM 在业务逻辑层和数据库层之间充当了桥梁的作用。

ORM 是通过使用描述对象和数据库之间的映射的元数据，将程序中的对象自动持久化到数据库中。

定义模型类

# 创建用户信息模型类
class UserInfo(models.Model):
    # 创建字段 = 字段类型 字段宽度
    name = models.CharField(max_length=5)
    age = models.IntegerField(max_length=2)

类名代表了数据库表名，且继承了models.Model，类里面的字段代表数据表中的字段(name)，数据类型则由CharField（相当于varchar）、max_length 参数限定长度。

生成数据库表

1.生成迁移文件

生成迁移文件就是根据模型类生成创建表的语句。也是让Django 知道模型有一些变更，对表结构调整。

生成迁移文件之前：

执行命令，生成迁移文件

python manage.py makemigrations

(py3) D:\WorkSpace\Python\demo>python manage.py makemigrations
Migrations for 'user':
  user\migrations\0001_initial.py
    - Create model UserInfo

2.执行迁移

迁移文件生成后执行迁移，就是根据第一步生成的语句在数据库中创建表

python manage.py migrate

(py3) D:\WorkSpace\Python\demo>python manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, sessions, user
Running migrations:
  Applying contenttypes.0001_initial... OK
  Applying auth.0001_initial... OK
  Applying admin.0001_initial... OK
  Applying admin.0002_logentry_remove_auto_add... OK
  Applying admin.0003_logentry_add_action_flag_choices... OK
  Applying contenttypes.0002_remove_content_type_name... OK
  Applying auth.0002_alter_permission_name_max_length... OK
  Applying auth.0003_alter_user_email_max_length... OK
  Applying auth.0004_alter_user_username_opts... OK
  Applying auth.0005_alter_user_last_login_null... OK
  Applying auth.0006_require_contenttypes_0002... OK
  Applying auth.0007_alter_validators_add_error_messages... OK
  Applying auth.0008_alter_user_username_max_length... OK
  Applying auth.0009_alter_user_last_name_max_length... OK
  Applying auth.0010_alter_group_name_max_length... OK
  Applying auth.0011_update_proxy_permissions... OK
  Applying auth.0012_alter_user_first_name_max_length... OK
  Applying sessions.0001_initial... OK
  Applying user.0001_initial... OK

生成db.sqlite3，其默认采用sqlite3数据库来存储数据，由settings.py文件中的DATABASES节点配置

查看数据库文件

将生成的db.sqlite3文件拖放到Database面板

添加sqlite的数据源驱动
点击Download下载驱动

下载驱动后点击应用，然后刷新得到如下数据库表

Admin管理工具

Django提供了基 web的管理工具。

Django自动管理工具是django.contrib 的一部分。在项目的 settings.py 中的 INSTALLED_APPS

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
)

管理界面本地化

本地化是将显示的语言、时间等设置成使用本地的习惯

通常是根据使用者所属国家对应语言进行设置，例如：中国大陆地区使用简体中文，时区使用亚洲/上海时区

默认本地化

设置为中国本地化

# 设置语言：设置中文
LANGUAGE_CODE = 'zh-Hans'
# 设置时区：亚洲上海时区
TIME_ZONE = 'Asia/Shanghai'

创建管理员

执行如下命令创建管理员，接着按提示输入用户名、邮箱、密码等信息

python manage.py createsuperuser

(py3) D:\WorkSpace\Python\demo>python manage.py createsuperuser
用户名 (leave blank to use 'jackchen'): admin
电子邮件地址: admin@oa.com
Password:
Password (again):
密码跟 用户名 太相似了。
密码长度太短。密码必须包含至少 8 个字符。
这个密码太常见了。
Bypass password validation and create user anyway? [y/N]: y
Superuser created successfully.

如果忘记密码，需要重置密码，执行如下命令

python manager.py changepassword 用户名

执行如下命令启动服务

python manage.py runserver

访问 http://127.0.0.1:8000/admin登陆站点

站点登陆成功后，默认界面如下

注册模型类

为了让 admin界面管理某个数据模型，需要先注册该数据模型到 admin。Django能够根据定义的模型类自动地生成管理模块。

在admin.py文件中注册模型类，只需要导入对应模型模块：from user.models import UserInfo

from django.contrib import admin

from user.models import UserInfo

# Register your models here.
admin.site.register(UserInfo)

注册模型后，再次访问站点管理后台，在站点管理界面进行方便快速的数据管理

操作模型数据

可以对模型数据查看、添加、修改、删除

点击增加按钮进入如下界面

新增一条用户信息，得到如下界面，显示的是一个UserInfo object (1)

打开models.py文件，修改模型类，使用字符串的方式输出

from django.db import models

# Create your models here.
class UserInfo(models.Model):
    # 创建字段 = 字段类型 字段宽度
    name = models.CharField(max_length=5)
    age = models.IntegerField()
    gender = models.BooleanField()

    def __str__(self):
        return self.name

进行App应用配置，设置Admin管理站点显示设置应用的名字

from django.apps import AppConfig

class UserConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'user'
    verbose_name = '用户模块'

视图和URL

一个视图函数，简称视图，是一个简单的 Python 函数，它接受 Web 请求并且返回 Web 响应。

对于Django的设计框架MVT，用户在URL中请求的是视图，视图接收请求后进行处理，并将处理的结果返回给请求者。

响应可以是一个 HTML 页面、一个 404 错误页面、重定向页面、XML 文档、或者一张图片

视图一般放在项目的 views.py 文件中。每个视图函数都负责返回一个 HttpResponse 对象，对象中包含生成的响应。

视图层中有两个重要的对象：请求对象(request)与响应对象(HttpResponse)。

定义视图

1.视图就是一个Python函数，被定义在应用的views.py中

2.需要导入HttpResponse模块 : from django.http import HttpResponse

3.视图第一个参数是HttpRequest类型的对象reqeust，包含所有请求信息

4.视图必须返回HttpResponse对象，包含返回给请求者的响应信息

在views.py中定义视图函数

from django.http import HttpResponse

# Create your views here.

def userIndex(request):
    return HttpResponse("test")

配置URLconf

视图的查找过程

1.在浏览器地址栏中输入URL请求网站

2.网站获取URL信息

3.然后与编写好的URLconf逐条匹配

4.如果匹配成功则调用对应的视图

5.如果所有的URLconf都没有匹配成功.则返回404错误

打开项目的settings.py文件，可以看到URLconf入口，其指向了项目的urls.py文件

在应用中定义URLconf

首先在应用中创建urls.py文件，用于定义URLconf。注意：一条URLconf包括URL规则、视图两部分

URL规则使用正则表达式定义

视图就是在views.py中定义的视图函数

Django版本差异

Django1.1.x 版本

url() 方法：普通路径和正则路径均可使用，需要自己手动添加正则首位限制符号。

from django.conf.urls import url # 用 url 需要引入

urlpatterns = [
    url(r'^admin/$', admin.site.urls),
    url(r'^index/$', views.index), # 普通路径
    url(r'^user/([0-9]{4})/$', views.articles), # 正则路径
]

Django 2.2.x 之后

path：用于普通路径，不需要自己手动添加正则首位限制符号，底层已经添加。

re_path：用于正则路径，需要自己手动添加正则首位限制符号

Django path() 可以接收四个参数，分别是两个必选参数：route、view 和两个可选参数：kwargs、name。

语法格式：

path(route, view, kwargs=None, name=None)

route: 字符串，表示 URL 规则，与之匹配的 URL 会执行对应的第二个参数 view。

view: 用于执行与正则表达式匹配的 URL 请求。

kwargs: 视图使用的字典类型的参数。

name: 用来反向获取 URL。

from django.urls import path, re_path

from user import views

urlpatterns = [
    # 普通路径
    path('userIndex/', views.userIndex),
    # 正则路径
    re_path(r'^', views.userIndex),
    re_path(r'^index/$', views.index, name='index'),
    re_path(r'^bio/(?P<username>\w+)/$', views.bio, name='bio'),
    re_path(r'^weblog/', include('blog.urls')),
]

在项目中定义URLconf

在项目的urls.py文件中配置URLconf，具体如何配置参考Examples说明。

这里统一将访问user/路径分发给user应用

"""demo URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/4.1/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  path('', views.home, name='home')
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
Including another URLconf
    1. Import the include() function: from django.urls import include, path
    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
"""
from django.contrib import admin

from django.urls import include, path

urlpatterns = [
    path('admin/', admin.site.urls),
    # 只要是user/路径则匹配成功
    path('user/', include('user.urls')),
]

执行测试

访问：http://127.0.0.1:8000/user/userIndex/

模板

Django中MVT设计模式的T，即为模板Template。

在Django中, 将前端的内容定义在模板中, 然后再把模板交给视图调用

创建模板

在应用同级目录下创建模板文件夹templates，文件夹名称是固定写法

在templates文件夹下, 创建应用同名文件夹，例如：user

在应用同名文件夹下创建网页模板文件，例如：index.html

设置模板查找路径

编辑项目目录下的settings.py文件，先导入os模块：import os，然后设置模板查找的路径

模板接收视图传入的数据

导入render模块，定义视图，准备上下文数据，将上下文数据交给模板处理

模板处理数据

注释语法：{# 注释内容 #}

通过{{ context的key }}方式获取值定义的上下文数据

验证模板处理

执行命令：python manage.py runserver启动服务器

访问相应URL，如：http://127.0.0.1:8000/user/userIndex/

静态文件

项目中的CSS、图片、js都是静态文件。一般会将静态文件放到一个单独的目录中，以方便管理。

Django中提供了一种解析的方式配置静态文件路径。

静态文件可以放在项目根目录下，也可以放在应用的目录下，由于有些静态文件在项目中是通用的，所以推荐放在项目的根目录下，方便管理。

编辑settings.py文件，配置修改静态文件的两个参数：

STATICFILES_DIRS：存放查找静态文件的目录

STATIC_URL：访问静态文件的URL前缀

STATIC_URL = '/static/'
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'static'),
]

在项目根目录下创建static目录来保存静态文件。可以添加任何静态文件，例如添加一个index.html文件

通过访问：http://127.0.0.1:8000/static/文件名方式来访问在static中的静态文件。