史上最详细Django入门教程

简介

Django，发音为[`dʒæŋɡəʊ]，是用python语言写的开源web开发框架，并遵循MVC设计。劳伦斯出版集团为了开发以新闻内容为主的网站，而开发出来了这个框架，于2005年7月在BSD许可证下发布。这个名称来源于比利时的爵士音乐家DjangoReinhardt，他是一个吉普赛人，主要以演奏吉它为主，还演奏过小提琴等。由于Django在近年来的迅速发展，应用越来越广泛，被著名IT开发杂志SDTimes评选为2013SDTimes100，位列"API、库和框架"分类第6位，被认为是该领域的佼佼者。

django信念

Django的主要目的是简便、快速的开发数据库驱动的网站。它强调代码复用，多个组件可以很方便的以"插件"形式服务于整个框架，Django有许多功能强大的第三方插件，你甚至可以很方便的开发出自己的工具包。这使得Django具有很强的可扩展性。它还强调快速开发和DRY(DoNotRepeatYourself)原则。

特点

重量级框架

对比Flask框架，Django原生提供了众多的功能组件，让开发更简便快速。
提供项目工程管理的自动化脚本工具
数据库ORM支持（对象关系映射，英语：Object Relational Mapping）
模板
表单
Admin管理站点
文件管理
认证权限
session机制
缓存

MVT模式

有一种程序设计模式叫MVC，其核心思想是分工、解耦，让不同的代码块之间降低耦合，增强代码的可扩展性和可移植性，实现向后兼容。

MVC的全拼为Model-View-Controller，最早由TrygveReenskaug在1978年提出，是施乐帕罗奥多研究中心(Xerox PARC)在20世纪80年代为程序语言Smalltalk发明的一种软件设计模式，是为了将传统的输入（input）、处理（processing）、输出（output）任务运用到图形化用户交互模型中而设计的。随着标准输入输出设备的出现，开发人员只需要将精力集中在业务逻辑的分析与实现上。后来被推荐为Oracle旗下Sun公司Java EE平台的设计模式，并且受到越来越多的使用ColdFusion和PHP的开发者的欢迎。现在虽然不再使用原来的分工方式，但是这种分工的思想被沿用下来，广泛应用于软件工程中，是一种典型并且应用广泛的软件架构模式。后来，MVC的思想被应用在了Ｗeb开发方面，被称为Ｗeb MVC框架。

工程搭建

1. 创建虚拟环境

mkvirtualenv django_py3_1.11 -p python3
注意需要联网

2. 安装Django

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

pip install django==1.11.11

3. 虚拟环境和pip的命令

虚拟环境
mkvirtualenv  # 创建虚拟环境
rmvirtualenv  # 删除虚拟环境
workon        # 进入虚拟环境、查看所有虚拟环境
deactivate    # 退出虚拟环境
 pip
pip install   # 安装依赖包
pip uninstall # 卸载依赖包
pip list      # 查看已安装的依赖包
pip freeze    # 冻结当前环境的依赖包

创建工程

在使用Flask框架时，项目工程目录的组织与创建是需要我们自己手动创建完成的。

在django中，项目工程目录可以借助django提供的命令帮助我们创建。

1. 创建

创建工程的命令为：

django-admin startproject 工程名称
例如：想要在桌面的code目录中创建一个名为demo的项目工程，可执行如下命令：

cd ~/Desktop/code
django-admin startproject demo
执行后，会多出一个新目录名为demo，此即为新创建的工程目录。

2. 工程目录说明

查看创建的工程目录，结构如下

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

3. 运行开发服务器

在开发阶段，为了能够快速预览到开发的效果，django提供了一个纯python编写的轻量级web服务器，仅在开发阶段使用。

运行服务器命令如下：

python manage.py runserver ip:端口
或：
python manage.py runserver
可以不写IP和端口，默认IP是127.0.0.1，默认端口为8000。

启动后可见如下信息：
django默认工作在调式Debug模式下，如果增加、修改、删除文件，服务器会自动重启。
按ctrl+c停止服务器。

创建子应用

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

在Flask框架中也有类似子功能应用模块的概念，即蓝图Blueprint。

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

1. 创建

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

python manage.py startapp 子应用名称
manage.py 为上述创建工程时自动生成的管理文件。

例如，在刚才创建的demo工程中，想要创建一个用户users子应用模块，可执行：

cd ~/Desktop/code/demo
python manage.py startapp users
执行后，可以看到工程目录中多出了一个名为users的子目录。

2. 子应用目录说明

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

子应用目录

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

3. 注册安装子应用

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

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

初始installed_apps
注册安装一个子应用的方法，即是将子应用的配置信息文件apps.py中的Config类添加到INSTALLED_APPS列表中。
例如，将刚创建的users子应用添加到工程中，可在INSTALLED_APPS列表中添加’users.apps.UsersConfig’。

创建视图

同Flask框架一样，Django也用视图来编写Web应用的业务逻辑。
Django的视图是定义在子应用的views.py中的。

1. 创建

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

from django.http import HttpResponse

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文件中定义路由信息。

from django.conf.urls import url

from . import views

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

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

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模块，如

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)),  # 添加应用的路由
]

4) 启动运行

重新启动django程序

python manage.py runserver

在浏览器中输入网址127.0.0.1:8000/users/index/ 可看到返回的信息

配置、静态文件与路由

配置文件

1. BASE_DIR

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

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

2. DEBUG

调试模式，创建工程后初始值为True，即默认工作在调试模式下。
作用：
修改代码文件，程序自动重启
Django程序出现异常时，向前端显示详细的错误追踪信息
而非调试模式下，仅返回Server Error (500)
***注意：***部署线上运行的Django不要运行在调式模式下，记得修改DEBUG=False。

3. 本地语言与时区

Django支持本地化处理，即显示语言与时区支持本地化。
本地化是将显示的语言、时间等使用本地的习惯，这里的本地化就是进行中国化，中国大陆地区使用简体中文，时区使用亚洲/上海时区，注意这里不使用北京时区表示。
初始化的工程默认语言和时区为英语和UTC标准时区

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

将语言和时区修改为中国大陆信息

LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'

静态文件

项目中的CSS、图片、js都是静态文件。一般会将静态文件放到一个单独的目录中，以方便管理。在html页面中调用时，也需要指定静态文件的路径，Django中提供了一种解析的方式配置静态文件路径。静态文件可以放在项目根目录下，也可以放在应用的目录下，由于有些静态文件在项目中是通用的，所以推荐放在项目的根目录下，方便管理。
为了提供静态文件，需要配置两个参数：
STATICFILES_DIRS 存放查找静态文件的目录
STATIC_URL 访问静态文件的URL前缀

# 在项目根目录下创建static_files目录来保存静态文件。
# 在demo/settings.py中修改静态文件的两个参数为
STATIC_URL = '/static/'
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'static_files'),
]
""" 此时在static_files添加的任何静态文件都可以使用网址
     /static/文件在static_files中的路径 来访问了。
    例如，我们向static_files目录中添加一个index.html文件，
    在浏览器中就可以使用127.0.0.1:8000/static/index.html来访问。
    或者我们在static_files目录中添加了一个子目录和文件goods/detail.html，
    在浏览器中就可以使用     127.0.0.1:8000/static/goods/detail.html来访问。
"""

注意
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列表由上至下进行查询。
值得关注的由上至下的顺序，有可能会使上面的路由屏蔽掉下面的路由，带来非预期结果。例如：

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

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

需要注意定义路由的顺序，避免出现屏蔽效应。

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

3.1 路由命名

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

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

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

命名空间表示，凡是users.urls中定义的路由，均属于namespace指明的users名下。
命名空间的作用：避免不同应用中的路由使用了相同的名字发生冲突，使用命名空间区别开。
2) 在定义普通路由时，可以使用name参数指明路由的名字，如

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

3.2 reverse反解析

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

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)

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

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

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

用户访问 index 或者 index/ 网址，均能访问到index视图。
说明：
虽然路由结尾带/能带来上述好处，但是却违背了HTTP中URL表示资源位置路径的设计理念。
是否结尾带/以所属公司定义风格为准。

请求与响应

请求request

1 URL路径参数

在定义路由URL时，可以使用正则表达式提取参数的方法从URL中获取请求参数，Django会将提取的参数直接传递到视图的传入参数中。

未命名参数按定义顺序传递， 如

url(r'^weather/([a-z]+)/(\d{4})/$', views.weather),

def weather(request, city, year):
    print('city=%s' % city)
    print('year=%s' % year)
    return HttpResponse('OK')

命名参数按名字传递，如

url(r'^weather/(?P<city>[a-z]+)/(?P<year>\d{4})/$', views.weather),

def weather(request, year, city):
    print('city=%s' % city)
    print('year=%s' % year)
    return HttpResponse('OK')

2 Django中的QueryDict对象

定义在django.http.QueryDict
HttpRequest对象的属性GET、POST都是QueryDict类型的对象
与python字典不同，QueryDict类型的对象用来处理同一个键带有多个值的情况
方法get()：根据键获取值
如果一个键同时拥有多个值将获取最后一个值
如果键不存在则返回None值，可以设置默认值进行后续处理

dict.get('键',默认值)
可简写为
dict['键']

方法getlist()：根据键获取值，值以列表返回，可以获取指定键的所有值
如果键不存在则返回空列表[]，可以设置默认值进行后续处理

dict.getlist('键',默认值)

3. 查询字符串Query String

获取请求路径中的查询字符串参数（形如?k1=v1&k2=v2），可以通过request.GET属性获取，返回QueryDict对象。

# /qs/?a=1&b=2&a=3

def qs(request):
    a = request.GET.get('a')
    b = request.GET.get('b')
    alist = request.GET.getlist('a')
    print(a)  # 3
    print(b)  # 2
    print(alist)  # ['1', '3']
    return HttpResponse('OK')

重要：查询字符串不区分请求方式，即假使客户端进行POST方式的请求，依然可以通过request.GET获取请求中的查询字符串数据。

4 请求体

请求体数据格式不固定，可以是表单类型字符串，可以是JSON字符串，可以是XML字符串，应区别对待。
可以发送请求体数据的请求方式有POST、PUT、PATCH、DELETE。
Django默认开启了CSRF防护，会对上述请求方式进行CSRF防护验证，在测试时可以关闭CSRF防护机制，方法为在settings.py文件中注释掉CSRF中间件，如：

4.1 表单类型 Form Data

前端发送的表单类型的请求体数据，可以通过request.POST属性获取，返回QueryDict对象。

def get_body(request):
    a = request.POST.get('a')
    b = request.POST.get('b')
    alist = request.POST.getlist('a')
    print(a)
    print(b)
    print(alist)
    return HttpResponse('OK')

重要：request.POST只能用来获取POST方式的请求体表单数据。

4.2 非表单类型 Non-Form Data

非表单类型的请求体数据，Django无法自动解析，可以通过request.body属性获取最原始的请求体数据，自己按照请求体格式（JSON、XML等）进行解析。request.body返回bytes类型。
例如要获取请求体中的如下JSON数据

{
   "a": 1, "b": 2}

可以进行如下方法操作：

import json

def get_body_json(request):
    json_str = request.body
    json_str = json_str.decode()  # python3.6 无需执行此步
    req_data = json.loads(json_str)
    print(req_data['a'])
    print(req_data['b'])
    return HttpResponse('OK')

5 请求头

可以通过request.META属性获取请求头headers中的数据，request.META为字典类型。
常见的请求头如：

CONTENT_LENGTH – The length of the request body (as a string).
		CONTENT_TYPE – The MIME type of the request body.
		HTTP_ACCEPT – Acceptable content types for the response.
		HTTP_ACCEPT_ENCODING – Acceptable encodings for the response.
		HTTP_ACCEPT_LANGUAGE – Acceptable languages for the response.
		HTTP_HOST – The HTTP Host header sent by the client.
		HTTP_REFERER – The referring page, if any.
		HTTP_USER_AGENT – The client’s user-agent string.
		QUERY_STRING – The query string, as a single (unparsed) string.
		REMOTE_ADDR – The IP address of the client.
		REMOTE_HOST – The hostname of the client.
		REMOTE_USER – The user authenticated by the Web server, if any.
		REQUEST_METHOD – A string such as "GET" or "POST".
		SERVER_NAME – The hostname of the server.
		SERVER_PORT – The port of the server (as a string).

具体使用如:

def get_headers(request):
    print(request.META['CONTENT_TYPE'])
    return HttpResponse('OK')

6 其他常用HttpRequest对象属性

method：一个字符串，表示请求使用的HTTP方法，常用值包括：‘GET’、‘POST’。
user：请求的用户对象。
path：一个字符串，表示请求的页面的完整路径，不包含域名和参数部分。
encoding：一个字符串，表示提交的数据的编码方式。
如果为None则表示使用浏览器的默认设置，一般为utf-8。
这个属性是可写的，可以通过修改它来修改访问表单数据使用的编码，接下来对属性的任何访问将使用新的encoding值。
FILES：一个类似于字典的对象，包含所有的上传文件。

响应response

视图在接收请求并处理后，必须返回HttpResponse对象或子对象。HttpRequest对象由Django创建，HttpResponse对象由开发人员创建。

1 HttpResponse

可以使用django.http.HttpResponse来构造响应对象。

HttpResponse(content=响应体, content_type=响应体数据类型, status=状态码)

也可通过HttpResponse对象属性来设置响应体、状态码：
content：表示返回的内容。
status_code：返回的HTTP响应状态码。
响应头可以直接将HttpResponse对象当做字典进行响应头键值对的设置：

response = HttpResponse()
# 自定义响应头Itcast, 值为Python
response['Itcast'] = 'Python'  

# 例子：
from django.http import HttpResponse

def demo_view(request):
    return HttpResponse('itcast python', status=400)
    或者
    response = HttpResponse('itcast python')
    response.status_code = 400
    response['Itcast'] = 'Python'
    return response

2 HttpResponse子类

Django提供了一系列HttpResponse的子类，可以快速设置状态码

HttpResponseRedirect 301
HttpResponsePermanentRedirect 302
HttpResponseNotModified 304
HttpResponseBadRequest 400
HttpResponseNotFound 404
HttpResponseForbidden 403
HttpResponseNotAllowed 405
HttpResponseGone 410
HttpResponseServerError 500

3 JsonResponse

若要返回json数据，可以使用JsonResponse来构造响应对象，作用：
帮助我们将数据转换为json字符串
设置响应头Content-Type为 application/json

from django.http import JsonResponse

def demo_view(request):
    return JsonResponse({
   'city': 'beijing', 'subject': 'python'})

4 redirect重定向

from django.shortcuts import redirect

def demo_view(request):
    return redirect('/index.html')

Cookie

Coo