# Django

[TOC]

## 1. Django介绍

### 简介

Django,是用python语言写的开源web开发框架,并遵循MVC设计。

### 特点

1. 重量级框架

   对比于Flask框架,Django原生提供了众多的功能组件,加快开发速度

   - 提供项目工程管理的自动化脚本工具

   - 数据库ORM支持（对象关系映射，英语：Object Relational Mapping）

   - 模板

   - 表单

   - Admin管理站点

   - 文件管理

   - 认证权限

   - session机制

   - #### 缓存

2. MVT模式

   1. MVC 模式介绍    <font color=red>**高内聚,低耦合**</font>

      - ##### M全拼为Model，主要封装对数据库层的访问，对数据库中的数据进行增、删、改、查操作。

      - V全拼为View，用于封装结果，生成页面展示的html内容,展示数据。

      - C全拼为Controller，用于接收请求,处理请求,处理业务逻辑,处理数据,与Model和View交互，返回结果。

   2. Django的MVT模式    <font color=red>符合MVC设计模式,只是换了一个名字而已</font>

      - M全拼为Model，与MVC中的M功能相同，负责和数据库交互，进行数据处理。
      - V全拼为View，与MVC中的C功能相同，接收请求，进行业务处理，返回应答。
      - T全拼为Template，与MVC中的V功能相同，负责封装构造要返回的html。

   

## 2. 工程搭建

### 环境安装

1. 创建虚拟环境

> 创建虚拟环境的作用:在同一台电脑上开发多个项目的时候,每个虚拟环境对应不同版本的开发项目,
>
> 可以使用不同版本的包/框架
>
> 虚拟环境都在`~/.virtualenv`下

```shell
# 指令        虚拟环境名字        指定解释器
mkvirtualenv django_py3_1.11 -p python3
```

注意需要联网

2. 安装Django

使用django 1.11.11版本，注意需要联网

```shell
#                   指定Django版本
pip install django==1.11.11
```

3. 虚拟环境和pip的一些命令

```shell
# 虚拟环境
mkvirtualenv  # 创建虚拟环境
rmvirtualenv  # 删除虚拟环境
workon  # 进入虚拟环境、查看所有虚拟环境
deactivate  # 退出虚拟环境

# pip
pip install  # 安装依赖包
pip uninstall  # 卸载依赖包
pip list  # 查看已安装的依赖库
```

### 创建工程

1.创建

> 在虚拟环境里执行命令,会生成一个工程目录,包含`__init__.py` ,settings.py,urls.py等文件

```bash
django-admin startproject 工程名称
```

2.工程目录说明

- 项目目录
  - 与项目同名的目录。
    - **settings.py** 是项目的整体配置文件。
    - **urls.py** 是项目的URL配置文件,路由文件。
    - **wsgi.py** 是项目与WSGI兼容的Web服务器入口。
  - **manage.py** 是项目管理文件，通过它管理项目。

3.运行服务器

```shell
# 设置ip和端口
python manage.py runserver ip:端口
# 可以不写IP和端口，默认IP是127.0.0.1，默认端口为8000
python manage.py runserver
```

> django默认工作在调式Debug模式下，如果增加、修改、删除文件，服务器会自动重启。



### 创建子应用

在Web应用中，通常有一些业务功能模块是在不同的项目中都可以复用的，故在开发中通常将工程项目拆分为不同的子功能模块，各功能模块间可以保持相对的独立，在其他工程项目中需要用到某个特定功能模块时，可以将该模块代码整体复制过去，达到复用。

> **Django的视图编写是放在子应用中的。**



1. 创建

在django中，创建子应用模块目录仍然可以通过命令来操作，即：

```shell
python manage.py startapp 子应用名称
```

2. 子应用目录说明

查看工程目录，结构如下：

- 项目目录
  - 同名目录
  - 子应用目录
    - **admin.py** 文件跟网站的后台管理站点配置相关。
    - **apps.py** 文件用于配置当前子应用的相关信息。
    - **migrations** 目录用于存放数据库迁移历史文件。
    - **models.py** 文件用户保存数据库模型类。
    - **tests.py** 文件用于开发测试用例，编写单元测试。
    - **views.py** 文件用于编写Web应用视图。

3. 注册安装子应用

在工程配置文件settings.py中，**INSTALLED_APPS**项保存了工程中已经注册安装的子应用,想要使用子应用,先注册：

**注册安装一个子应用的方法，即是将子应用的配置信息文件apps.py中的Config类添加到`INSTALLED_APPS`列表中。**

```python
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    #注册子应用
    'auser.apps.AuserConfig'
]
```





### 定义视图

1. #### 创建

打开刚创建的users模块，在views.py中编写视图代码。

```python
from django.http import HttpResponse
#  接受请求对象,解析请求对象,model template 返回响应对象
def index(request):
    """
    index视图
    :param request: 包含了请求信息的请求对象
    :return: 响应对象
    """
    return HttpResponse("hello the world!")
```

说明：

- 视图函数的第一个传入参数必须定义，用于接收Django构造的包含了请求数据的**HttpReqeust**对象，通常名为**request**。
- 视图函数的返回值必须为一个响应对象，不能像Flask一样直接返回一个字符串，可以将要返回的字符串数据放到一个**HTTPResponse**对象中。

2. #### 定义路由URL

1) 在子应用中新建一个urls.py文件用于保存该应用的路由。

2) 在users/urls.py文件中定义路由信息。

```python
from django.conf.urls import url

from . import views

# urlpatterns是被django自动识别的路由列表变量
urlpatterns = [
    # 每个路由信息都需要使用url函数来构造
    # url(路径, 视图)
    url(r'^index/$', views.index),
]
```

3) 在工程总路由demo/urls.py中添加子应用的路由数据。

```python
from django.conf.urls import url, include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),  # django默认包含的

    # 添加
    url(r'^users/', include('users.urls')),
]
```

- 使用include来将子应用users里的全部路由包含进工程路由中；
- **r'^users/'** 决定了users子应用的所有路由都已**/users/**开头，如我们刚定义的视图index，其最终的完整访问路径为**/users/index/**。

**include**函数除了可以传递字符串之外，也可以直接传递应用的urls模块，如

```python
from django.conf.urls import url, include
from django.contrib import admin
import users.urls  # 先导入应用的urls模块

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    # url(r'^users/', include('users.urls')),
    url(r'^users/', include(users.urls)),  # 添加应用的路由
]
```

> 除了在子路由添加,还可以添加在总路由不过不常用

> 在总路由有两种方式 字符串和导包

## 3. 配置,静态文件与路由

### 配置文件

1. `BASE_DIR`

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

2. `DEBUG`

调试模式，创建工程后初始值为**True**，即默认工作在调试模式下。

- Django程序出现异常时，==向前端显示详细的错误追踪信息==，

**注意：部署线上运行的Django不要运行在调式模式下，记得修改DEBUG=False。**

3. 本地语言与时区

初始化的工程默认语言和时区为英语和UTC标准时区

```python
LANGUAGE_CODE = 'en-us'  # 语言
TIME_ZONE = 'UTC'  # 时区
```



### 静态文件

项目中的CSS、图片、js都是静态文件。一般会将静态文件放到一个单独的目录中，以方便管理。由于有些静态文件在项目中是通用的，所以推荐放在项目的根目录下，方便管理。

为了提供静态文件，需要配置两个参数：

- **`STATICFILES_DIRS=[]`** 存放查找静态文件的目录 接收的是**list**

- **`STATIC_URL`** 访问静态文件的URL前缀

  ```python
  STATIC_URL='/static'        #静态路由前缀
  STATICFILES_DIRS=[os.path.join(BAST_DIR, '静态文件夹')]  #静态文件夹
  ```

  

#### 注意

Django 仅在调试模式下（DEBUG=True）能对外提供静态文件。

当DEBUG=False工作在生产模式时，Django不再对外提供静态文件，需要是用collectstatic命令来收集静态文件并交由其他静态文件服务器来提供。（详细在部署时会讲）





### 路由说明

#### 1. 路由定义位置

Django的主要路由信息定义在工程同名目录下的urls.py文件中，该文件是Django解析路由的入口。

每个子应用为了保持相对独立，可以在各个子应用中定义属于自己的urls.py来保存该应用的路由。然后用主路由文件包含各应用的子路由数据。

除了上述方式外，也可将工程的全部路由信息都定义在主路由文件中，子应用不再设置urls.py。如：

```
from django.conf.urls import url
from django.contrib import admin
import users.views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^users/index/$', users.views.index)
]
```

#### 2. 路由解析顺序

Django在接收到一个请求时，==从主路由文件中的urlpatterns列表中以由上至下的顺序查找对应路由规则==，如果发现规则为include包含，则==再进入被包含的urls中的urlpatterns列表由上至下进行查询==。

值得关注的**由上至下**的顺序，有可能会使上面的路由屏蔽掉下面的路由，带来非预期结果。例如：

```python
urlpatterns = [
    url(r'^say', views.say),
    url(r'^sayhello', views.sayhello),
]
```

即使访问sayhello/路径，预期应该进入sayhello视图执行，但实际优先查找到了say路由规则也与sayhello/路径匹配，实际进入了say视图执行。

#### 3. 路由命名与reverse反解析（逆向）

> 根据视图函数,利用reverse()倒推路由路径

##### 3.1 路由命名

在定义路由的时候，可以为路由命名，方便查找特定视图的具体路径信息。

1) 在使用include函数定义路由时，可以使用namespace参数定义路由的命名空间，如

```python
url(r'^users/', include('users.urls', namespace='users')),
```

命名空间表示，凡是users.urls中定义的路由，均属于namespace指明的users名下。

**命名空间的作用：避免不同应用中的路由使用了相同的名字发生冲突，使用命名空间区别开。**

2) 在定义普通路由时，可以使用name参数指明路由的名字，如

```python
urlpatterns = [
    url(r'^index/$', views.index, name='index'),
    url(r'^say', views.say, name='say'),
]
```

##### 3.2 reverse反解析

使用reverse函数，可以根据路由名称，返回具体的路径，如：

```python
from django.urls import reverse  # 注意导包路径

def index(request):
    return HttpResponse("hello the world!")

def say(request):
    url = reverse('users:index')  # 返回 /users/index/
    print(url)
    return HttpResponse('say')
```

- 对于未指明namespace的，reverse(路由name)

- 对于指明namespace的，reverse(命名空间namespace:路由name)

  > 总路由的namespace不一定非要指定,子路由那么必须要指定,才能用reverse()来反解析路由
  >
  > 一般都会加namespace防止不同子路由命名冲突

#### 4. 路径结尾斜线/的说明

Django中定义路由时，通常以斜线/结尾，其好处是用户访问不以斜线/结尾的相同路径时，Django会把用户重定向到以斜线/结尾的路径上，而不会返回404不存在。如

```python
urlpatterns = [
    url(r'^index/$', views.index, name='index'),
]
```

用户访问 index 或者 index/ 网址，均能访问到index视图。

**说明：**

虽然路由结尾带/能带来上述好处，但是却违背了HTTP中URL表示资源位置路径的设计理念。

是否结尾带/以所属公司定义风格为准。

## 4. 请求与响应





## 5. 类视图与中间件





## 6. 模板





## 7. 数据库





## 8. Admin站点

# Django

[TOC]

## 1. Django介绍

### 简介

Django,是用python语言写的开源web开发框架,并遵循MVC设计。

### 特点

1. 重量级框架

   对比于Flask框架,Django原生提供了众多的功能组件,加快开发速度

   - 提供项目工程管理的自动化脚本工具

   - 数据库ORM支持（对象关系映射，英语：Object Relational Mapping）

   - 模板

   - 表单

   - Admin管理站点

   - 文件管理

   - 认证权限

   - session机制

   - #### 缓存

2. MVT模式

   1. MVC 模式介绍    <font color=red>**高内聚,低耦合**</font>

      - ##### M全拼为Model，主要封装对数据库层的访问，对数据库中的数据进行增、删、改、查操作。

      - V全拼为View，用于封装结果，生成页面展示的html内容,展示数据。

      - C全拼为Controller，用于接收请求,处理请求,处理业务逻辑,处理数据,与Model和View交互，返回结果。

   2. Django的MVT模式    <font color=red>符合MVC设计模式,只是换了一个名字而已</font>

      - M全拼为Model，与MVC中的M功能相同，负责和数据库交互，进行数据处理。
      - V全拼为View，与MVC中的C功能相同，接收请求，进行业务处理，返回应答。
      - T全拼为Template，与MVC中的V功能相同，负责封装构造要返回的html。

   

## 2. 工程搭建

### 环境安装

1. 创建虚拟环境

> 创建虚拟环境的作用:在同一台电脑上开发多个项目的时候,每个虚拟环境对应不同版本的开发项目,
>
> 可以使用不同版本的包/框架
>
> 虚拟环境都在`~/.virtualenv`下

```shell
# 指令        虚拟环境名字        指定解释器
mkvirtualenv django_py3_1.11 -p python3
```

注意需要联网

2. 安装Django

使用django 1.11.11版本，注意需要联网

```shell
#                   指定Django版本
pip install django==1.11.11
```

3. 虚拟环境和pip的一些命令

```shell
# 虚拟环境
mkvirtualenv  # 创建虚拟环境
rmvirtualenv  # 删除虚拟环境
workon  # 进入虚拟环境、查看所有虚拟环境
deactivate  # 退出虚拟环境

# pip
pip install  # 安装依赖包
pip uninstall  # 卸载依赖包
pip list  # 查看已安装的依赖库
```

### 创建工程

1.创建

> 在虚拟环境里执行命令,会生成一个工程目录,包含`__init__.py` ,settings.py,urls.py等文件

```bash
django-admin startproject 工程名称
```

2.工程目录说明

- 项目目录
  - 与项目同名的目录。
    - **settings.py** 是项目的整体配置文件。
    - **urls.py** 是项目的URL配置文件,路由文件。
    - **wsgi.py** 是项目与WSGI兼容的Web服务器入口。
  - **manage.py** 是项目管理文件，通过它管理项目。

3.运行服务器

```shell
# 设置ip和端口
python manage.py runserver ip:端口
# 可以不写IP和端口，默认IP是127.0.0.1，默认端口为8000
python manage.py runserver
```

> django默认工作在调式Debug模式下，如果增加、修改、删除文件，服务器会自动重启。



### 创建子应用

在Web应用中，通常有一些业务功能模块是在不同的项目中都可以复用的，故在开发中通常将工程项目拆分为不同的子功能模块，各功能模块间可以保持相对的独立，在其他工程项目中需要用到某个特定功能模块时，可以将该模块代码整体复制过去，达到复用。

> **Django的视图编写是放在子应用中的。**



1. 创建

在django中，创建子应用模块目录仍然可以通过命令来操作，即：

```shell
python manage.py startapp 子应用名称
```

2. 子应用目录说明

查看工程目录，结构如下：

- 项目目录
  - 同名目录
  - 子应用目录
    - **admin.py** 文件跟网站的后台管理站点配置相关。
    - **apps.py** 文件用于配置当前子应用的相关信息。
    - **migrations** 目录用于存放数据库迁移历史文件。
    - **models.py** 文件用户保存数据库模型类。
    - **tests.py** 文件用于开发测试用例，编写单元测试。
    - **views.py** 文件用于编写Web应用视图。

3. 注册安装子应用

在工程配置文件settings.py中，**INSTALLED_APPS**项保存了工程中已经注册安装的子应用,想要使用子应用,先注册：

**注册安装一个子应用的方法，即是将子应用的配置信息文件apps.py中的Config类添加到`INSTALLED_APPS`列表中。**

```python
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    #注册子应用
    'auser.apps.AuserConfig'
]
```





### 定义视图

1. #### 创建

打开刚创建的users模块，在views.py中编写视图代码。

```python
from django.http import HttpResponse
#  接受请求对象,解析请求对象,model template 返回响应对象
def index(request):
    """
    index视图
    :param request: 包含了请求信息的请求对象
    :return: 响应对象
    """
    return HttpResponse("hello the world!")
```

说明：

- 视图函数的第一个传入参数必须定义，用于接收Django构造的包含了请求数据的**HttpReqeust**对象，通常名为**request**。
- 视图函数的返回值必须为一个响应对象，不能像Flask一样直接返回一个字符串，可以将要返回的字符串数据放到一个**HTTPResponse**对象中。

2. #### 定义路由URL

1) 在子应用中新建一个urls.py文件用于保存该应用的路由。

2) 在users/urls.py文件中定义路由信息。

```python
from django.conf.urls import url

from . import views

# urlpatterns是被django自动识别的路由列表变量
urlpatterns = [
    # 每个路由信息都需要使用url函数来构造
    # url(路径, 视图)
    url(r'^index/$', views.index),
]
```

3) 在工程总路由demo/urls.py中添加子应用的路由数据。

```python
from django.conf.urls import url, include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),  # django默认包含的

    # 添加
    url(r'^users/', include('users.urls')),
]
```

- 使用include来将子应用users里的全部路由包含进工程路由中；
- **r'^users/'** 决定了users子应用的所有路由都已**/users/**开头，如我们刚定义的视图index，其最终的完整访问路径为**/users/index/**。

**include**函数除了可以传递字符串之外，也可以直接传递应用的urls模块，如

```python
from django.conf.urls import url, include
from django.contrib import admin
import users.urls  # 先导入应用的urls模块

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    # url(r'^users/', include('users.urls')),
    url(r'^users/', include(users.urls)),  # 添加应用的路由
]
```

> 除了在子路由添加,还可以添加在总路由不过不常用

> 在总路由有两种方式 字符串和导包

## 3. 配置,静态文件与路由

### 配置文件

1. `BASE_DIR`

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

2. `DEBUG`

调试模式，创建工程后初始值为**True**，即默认工作在调试模式下。

- Django程序出现异常时，==向前端显示详细的错误追踪信息==，

**注意：部署线上运行的Django不要运行在调式模式下，记得修改DEBUG=False。**

3. 本地语言与时区

初始化的工程默认语言和时区为英语和UTC标准时区

```python
LANGUAGE_CODE = 'en-us'  # 语言
TIME_ZONE = 'UTC'  # 时区
```



### 静态文件

项目中的CSS、图片、js都是静态文件。一般会将静态文件放到一个单独的目录中，以方便管理。由于有些静态文件在项目中是通用的，所以推荐放在项目的根目录下，方便管理。

为了提供静态文件，需要配置两个参数：

- **`STATICFILES_DIRS=[]`** 存放查找静态文件的目录 接收的是**list**

- **`STATIC_URL`** 访问静态文件的URL前缀

  ```python
  STATIC_URL='/static'        #静态路由前缀
  STATICFILES_DIRS=[os.path.join(BAST_DIR, '静态文件夹')]  #静态文件夹
  ```

  

#### 注意

Django 仅在调试模式下（DEBUG=True）能对外提供静态文件。

当DEBUG=False工作在生产模式时，Django不再对外提供静态文件，需要是用collectstatic命令来收集静态文件并交由其他静态文件服务器来提供。（详细在部署时会讲）





### 路由说明

#### 1. 路由定义位置

Django的主要路由信息定义在工程同名目录下的urls.py文件中，该文件是Django解析路由的入口。

每个子应用为了保持相对独立，可以在各个子应用中定义属于自己的urls.py来保存该应用的路由。然后用主路由文件包含各应用的子路由数据。

除了上述方式外，也可将工程的全部路由信息都定义在主路由文件中，子应用不再设置urls.py。如：

```
from django.conf.urls import url
from django.contrib import admin
import users.views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^users/index/$', users.views.index)
]
```

#### 2. 路由解析顺序

Django在接收到一个请求时，==从主路由文件中的urlpatterns列表中以由上至下的顺序查找对应路由规则==，如果发现规则为include包含，则==再进入被包含的urls中的urlpatterns列表由上至下进行查询==。

值得关注的**由上至下**的顺序，有可能会使上面的路由屏蔽掉下面的路由，带来非预期结果。例如：

```python
urlpatterns = [
    url(r'^say', views.say),
    url(r'^sayhello', views.sayhello),
]
```

即使访问sayhello/路径，预期应该进入sayhello视图执行，但实际优先查找到了say路由规则也与sayhello/路径匹配，实际进入了say视图执行。

#### 3. 路由命名与reverse反解析（逆向）

> 根据视图函数,利用reverse()倒推路由路径

##### 3.1 路由命名

在定义路由的时候，可以为路由命名，方便查找特定视图的具体路径信息。

1) 在使用include函数定义路由时，可以使用namespace参数定义路由的命名空间，如

```python
url(r'^users/', include('users.urls', namespace='users')),
```

命名空间表示，凡是users.urls中定义的路由，均属于namespace指明的users名下。

**命名空间的作用：避免不同应用中的路由使用了相同的名字发生冲突，使用命名空间区别开。**

2) 在定义普通路由时，可以使用name参数指明路由的名字，如

```python
urlpatterns = [
    url(r'^index/$', views.index, name='index'),
    url(r'^say', views.say, name='say'),
]
```

##### 3.2 reverse反解析

使用reverse函数，可以根据路由名称，返回具体的路径，如：

```python
from django.urls import reverse  # 注意导包路径

def index(request):
    return HttpResponse("hello the world!")

def say(request):
    url = reverse('users:index')  # 返回 /users/index/
    print(url)
    return HttpResponse('say')
```

- 对于未指明namespace的，reverse(路由name)

- 对于指明namespace的，reverse(命名空间namespace:路由name)

  > 总路由的namespace不一定非要指定,子路由那么必须要指定,才能用reverse()来反解析路由
  >
  > 一般都会加namespace防止不同子路由命名冲突

#### 4. 路径结尾斜线/的说明

Django中定义路由时，通常以斜线/结尾，其好处是用户访问不以斜线/结尾的相同路径时，Django会把用户重定向到以斜线/结尾的路径上，而不会返回404不存在。如

```python
urlpatterns = [
    url(r'^index/$', views.index, name='index'),
]
```

用户访问 index 或者 index/ 网址，均能访问到index视图。

**说明：**

虽然路由结尾带/能带来上述好处，但是却违背了HTTP中URL表示资源位置路径的设计理念。

是否结尾带/以所属公司定义风格为准。

## 4. 请求与响应





## 5. 类视图与中间件





## 6. 模板





## 7. 数据库





## 8. Admin站点