跳转至

Django开发

Django的官方文档

常用命令

# 启动服务器
python manage.py runserver
# 查看迁移状态
python manage.py showmigrations
# 生成迁移文件
python manage.py makemigrations one_app
# 数据迁移(谨慎执行)
python manage.py migrate
# 创建后台管理员
python manage.py createsuperuser
# 进入交互式命令行
python manage.py shell
# 导出数据,不指定app_name默认导出所有表
python manage.py dumpdata [app_name] > path/data.json
# 导入数据,不需要指定app_name
python manage.py loaddata path/data.json
from django.contrib.auth.models import User
# 重置用户密码
user = User.objects.get(username='admin')
user.set_password('xxxx')
user.save()

项目

  • 创建项目:django-admin startproject mysite
  • 创建应用:python manage.py startapp one_app
  • 项目结构:
# 项目容器,可重命名
mysite/
    # 命令行工具
    manage.py
    # 项目
    mysite/
        __init__.py
        # 配置文件
        settings.py
        # 路由声明,网站目录
        urls.py
        # 兼容asgi的服务器入口
        asgi.py
        # 兼容wsgi的服务器入口
        wsgi.py

应用

一个项目可以包含多个应用,一个应用可以被多个项目使用

应用可以存放在任意路径,不过通常与manage.py同级,这样就可以作为顶级模块导入

  • 创建应用:python manage.py startapp one_app
  • 应用结构:
one_app/
    __init__.py
    admin.py
    apps.py
    migrations/
        __init__.py
    models.py
    tests.py
    views.py
    # 以下文件自己创建
    urls.py  # URLconf路由配置文件(也可以是其他任何路径)
    templates/  # 模版容器
        one_app/  # 命名空间,由于DjangoTemplates会在每个INSTALL_APPS路径下依次寻找templates子目录,如果多个APP之间模板名称一样,只会匹配到第一个,容易出错。
            index.html  # 模版

修改应用名涉及要改动的地方

项目层

  • settings,注册应用名
  • urls.py

应用层

  • apps.py
  • urls.py
  • 模版命名空间,form表单action
  • 所有的迁移文件,alert表名

应用模型 models.py

应用声明

# mysite/settings.py
INSTALLED_APPS = [
    # Django自带应用
    'django.contrib.admin',  # 管理后台
    'django.contrib.auth',  # 认证授权系统
    'django.contrib.contenttypes',  # 内容类型框架
    'django.contrib.sessions',  # 会话框架
    'django.contrib.messages',  # 消息框架
    'django.contrib.staticfiles',  # 管理静态文件的框架
    # 以下是自定义应用
    'one_app.apps.One_appConfig',  # 完整形式
    'one_app',  # 简写形式
]

为声明的应用创建表(table)

python manage.py migrate

查看创建了哪些表:.schema(SQLite),SHOW TABLES;(MySQL)

创建管理员账号

python manage.py createsuperuser

然后启动服务器访问:127.0.0.1:8000/admin 即可访问后台

定义模型

from django.db import models

# 每个类就是一个模型(sheet),继承自models.Model
class Question(models.Model):
    # 每个属性代表一个字段(field)
    # 格式:字段名 = models.类型(参数, "备注名")
    # 主键id字段不需要定义,会被自动添加
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

    # 在执行Question.objects.all()时默认执行这个方法
    def __str__(self):
        return self.question_text  # 可以返回一个能标识这个模型的字段

class Choice(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)  # 外键
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

字段类型及参数

字段名:不能用Python保留字,不能连续用多个下划线且不能以下划线结尾

字段备注名:默认使用字段的属性名作为备注名

常见字段类型:

  • models.AutoField(primary_key=True) 模型会自动设置id字段为自增主键
  • models.ForeignKey(想要关联的模型类名, on_delete=models.CASCADE) 外键(多对一关联,还可以自关联(递归))
  • models.IntegerField() 整数
  • models.CharField(max_length=num) 字符串
  • models.BooleanField() 布尔值
  • models.DateField(auto_now_add/auto_now=True) 日期(第一次创建时设置为现在时间/每次保存时(更新时不会)设置为现在时间)
  • models.DateTimeField(auto_now_add/auto_now=True) 日期和时间
  • models.JSONField(encoder=None, decoder=None) v3.1版本新加Json类型,如果mysql为5.7以下版本不要使用这个类型
  • models.URLField(max_length=num) URL
  • models.UUIDField() 唯一标识符

字段通用参数:

  • blank=True 字段为空时就是空
  • null=True 字段为空时设置为NUL
  • choices=[("S", "Small"), (“B”, “Big”)] 枚举值(二元组的第一个值是真实存在数据库中的值,第二个值仅用于显示)
  • default=xxx 默认值,一般为None
  • help_text=xxx 注释文本
  • primary_key=True 设置为主键,一般不需要手动设置主键,默认会添加一列id字段为主键
  • unique=True 字段的值唯一,即不能重复
# 数据库迁移
# 生成数据迁移文件(SQL脚本)(生成到migrations/路径下)
python manage.py makemigrations
# 为每个应用自动生成需要的数据库表,具体创建什么取决于数据库迁移文件
python manage.py migrate
# 创建后台管理员账号
python manage.py createsuperuser
# 根据提示输入用户名邮箱和密码(admin,admin@zuoright.com,123456)
# 访问后台:127.0.0.1:8000/admin

数据迁移(创建/修改sheet)

  • step1:生成迁移数据(SQL语句)
python manage.py makemigrations one_app

迁移数据存储在:one_app/migrations/0001_initial.py

查看生成了哪些SQL语句:python manage.py sqlmigrate one_app 0001

  • step2:执行迁移(执行SQL语句)
python manage.py migrate

重置迁移文件

# 查看当前迁移文件记录及状态
python manage.py showmigrations
# 将某应用的迁移文件重置为未提交状态
python manage.py migrate --fake 应用名 zero
# 然后手动删除应用下的migrations文件(内置应用存放在env/lib/python/site-packages/django/contrib下)
# 重新生成migrations文件
python manage.py makemigrations
# 重新在django_migrations表中加入记录
python manage.py migrate 应用名 --fake-initial

压缩迁移文件

# 假设要压缩的应用为myapp,现在有5个迁移文件,最新的为0005_xxx
# 生成压缩后的迁移文件
python manage.py squashmigrations 0005
# 把新的迁移文件提交下
python manage.py makemigrations
# 然后删除旧的迁移文件,把依赖旧迁移文件的地方(主要是其他应用中)都替换为新的文件名
# 删除压缩迁移的 Migration 类的 replaces 属性
# 最后执行下迁移命令不报错则说明压缩成功
python manage.py migrate

我曾经闲的蛋疼为了解决另一个坑压缩过contenttypes应用的迁移文件,使得django_migrations表中第一行记录不是contenttypes.0001_initial,导致在更换Python运行环境后执行python manage.py xxx相关的命令时,出现下面这样一个报错:

django.db.migrations.exceptions.InconsistentMigrationHistory: Migration admin.0001_initial is applied before its dependency contenttypes.0001_initial on database 'default'

当时我查遍全网(中、英、日)也没有得到一个满意的答案,大多数解决方式是建议必须重置数据库,但我觉得并不至于要这样做,睡了一觉之后第二天下班之后,决定静下心来自己解决掉它,最终只需要在django_migrations表中第一行补上contenttypes.0001_initial这条记录就可以了,就是这么简单。

总结

不要随便压缩并且重命名Django自带应用的数据迁移文件(内心OS:但我记得之前确实是为了改一个Django本身的问题,而那个问题是因为迁移文件的命名是数字开头,导致依赖引用的时候报了语法错误,这是不符合Python文件命名规范的,Shit)

数据库API

from one_app.models import Blog

# SELECT语句
Q = Blog.objects  #  Managerd对象,表级操作
Q.all()  # 等同于Q,返回一个包含所有记录的QuerySet对象集合
Q.order_by("xxx")  # 按某字段排序

# WHERE子句
Q.get(pk=1)  # 如果查询结果只有一条记录可以用get,但如果查不到或查到多条会报错
Q.filter(**kwargs)  # 过滤满足条件的记录,WHERE xxx AND xxx
Q.exclude(**kwargs)  # 排除满足条件的记录,WHERE NOT(xxx AND xxx)
Q.exclude().exclude()  # WHERE NOT xxx AND NOT xxx

# LIMIT和OFFSET子句,切片,不支持负数索引,可以用步长2
Q.all()[:5]  # LIMIT 5 返回前5个对象
Q.all()[5:10]  # OFFSET 5 LIMIT 5 返回第6~10个对象

r = Blog(Field1="x1", Field2="x2")  # 实例初始化,行级操作
r.Field1 = "x01"  # 修改字段值

r.save()  # 保存

字段查询

# 完全匹配 =
Q.get(name__exact="abc")  # WHERE name = "abc";
Q.get(name="abc")  # 同上

# 比较
__gt  # 大于
__gte  # 大于等于
__lt   # 小于
__lte  # 小于等于

# LIKE 区分大小写
Q.get(name__contains="abc")  # WHERE name LIKE '%abc%';
Q.filter(name__startswith="abc")  # WHERE name LIKE 'abc%';
Q.filter(name__endswith="abc")  # WHERE name LIKE '%abc';

# ILIKE 不区分大小写
Q.get(name__iexact="abc")  # WHERE name ILIKE 'abc';
Q.get(name__icontains="xxx")  # WHERE name ILIKE '%abc%';
Q.get(name__istartswith="abc")  # WHERE name ILIKE 'abc%';
Q.get(name__iendswith="abc")  # WHERE name ILIKE '%abc';

# IN
Q.filter(id__in=[1, 3, 4])  # WHERE id IN (1, 3, 4);

# BETWEEN...AND...
Q.filter(date__range=(start_date, end_date))  # WHERE date BETWEEN 'start_date' and 'end_date';

管理后台 admin.py

# one_app/admin.py
from django.contrib import admin
from .models import Question

# 把应用注册到管理后台
admin.site.register(Question)

然后就可以对记录进行操作,增删改查

视图函数 views.py

HttpRequest

from .models import Question  # 引入模型
from django.shortcuts import render  # 引入快捷函数


def index(request):  # request=<HttpRequest object>
    # 通过request.POST字典对象获取表单提交的数据
    # 取不到值会报KeyError,取到的值永远是字符串
    try:
        xxx = request.POST["key_name"]
    except (KeyError, Choice.DoesNotExist):
        pass
    else:
        pass

    return render(request, 'one_app/index.html', context)

HttpResponse

  • 方式1,HttpResponse返回文本
from django.http import HttpResponse

def index(request):
    ...
    output = xxx
    return HttpResponse(output)
  • 方式2,HttpResponse返回模板
from django.http import HttpResponse
from django.template import loader

def index(request):
    a = xxx
    context = {"key": a}  # 上下文

    template = loader.get_template('one_app/index.html')  # 载入模板文件
    return HttpResponse(template.render(context, request))  # 传递上下文
  • 方式3,HttpResponse用快捷函数形式返回模板(推荐)
from django.shortcuts import render, get_object_or_404

def index(request):
    a = xxx
    context = {"key": a}

    # 格式:render(request对象,模板名称,上下文字典)
    return render(request, 'one_app/index.html', context)

重定向

from django.http import HttpResponseRedirect

# 构造函数:HttpResponseRedirect(重定向后的URL)
# 视图函数中避免URL硬编码:reverse(视图名字,args=(视图所需参数的元组,))
return HttpResponseRedirect(reverse('one_app:results', args=(question.id,)))  # /one_app/3/results/

404

  • 方式1
from django.http import Http404
from django.shortcuts import render

from .models import Question

def detail(request, question_id):
    try:
        question = Question.objects.get(pk=question_id)
    except Question.DoesNotExist:
        raise Http404("Question does not exist")
    return render(request, 'one_app/detail.html', {'question': question})
  • 方式2,快捷函数方式返回(推荐)
from django.shortcuts import get_object_or_404, render

from .models import Question

def detail(request, question_id):
    # 格式:get_object_or_404(模型对象,任意数量的关键字参数)
    # 如果关键字参数查不到结果则返回404
    question = get_object_or_404(Question, pk=question_id)
    return render(request, 'one_app/detail.html', {'question': question})

路由配置 urls.py

  • 配置项目的路由,根路由匹配应用
# mysite/urls.py
from django.urls import path, include
from django.contrib import admin

urlpatterns = [
    # 必选参数view:如果要引用其它的URLconfs,应该总是使用inlcude()这种形式
    path('one_app/', include('one_app.urls')),
    # admin.site.urls是唯一的例外
    path('admin/', admin.site.urls),
]
  • 配置应用的路由,应用匹配页面
# one_app/urls.py
from django.urls import path
from . import views

# 添加命名空间,避免多个应用路由名称相同混淆
app_name = "one_app"

urlpatterns = [
    # 格式:path(route, view, kwargs, name)
    # 必选route:路由正则
    # 必选view:调用视图函数,传入HttpRequest对象
    # 可选kwargs:字典的形式给视图函数传递任意个关键字
    # 可选name:给路由起名字,在项目任意位置引用
    path('', views.index, name='index'),
]

通用视图

# one_app/views.py
from django.views import generic
from .models import Question

# 通用视图ListView会显示一个特定类型对象的列表页面
class IndexView(generic.ListView):
    # 通过model属性告知通用视图作用于哪个模型
    model = Question
    # 通过template_name属性告知通用视图使用哪个模版
    # 如果不指定,ListView默认使用<app name>/<model name>_list.html做模版
    template_name = 'one_app/index.html'
    # 通过context_object_name属性告知通用视图上下文变量
    # 如果不指定,默认为question_list
    context_object_name = 'latest_question_list'

# 通用视图DetailView会显示一个特定类型对象的详细信息页面
class ResultsView(generic.DetailView):  # 不再需要传递request和question_id
    model = Question
    # 如果不指定template_name,DetailView默认使用<app name>/<model name>_detail.html做模版
    template_name = 'one_app/results.html'
    # 如果不指定context_object_name,默认为question
# one_app/urls.py
from django.urls import path
from . import views

app_name = 'one_app'
urlpatterns = [
    path('', views.IndexView.as_view(), name='index'),
    # DetailView会捕获名为"pk"的主键值,所以路由参数的变量名要改为"pk"
    # 视图参数也要改一下
    path('<int:pk>/results/', views.ResultsView.as_view(), name='results'),
]

模板

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>index</title>
    <link rel="stylesheet" type="text/css" href="{百分号 static 'xxx.css' 百分号}"> 
</head>
<body>

</body>
</html>

防止跨站点请求伪造

所有针对内部 URL 的 POST 表单都应该使用 {百分号 csrf_token 百分号} 模板标签,防止跨站点请求伪造。

<form action="{百分号 url 'one_app:vote' question.id 百分号}" method="post">
{百分号 csrf_token 百分号}
</form>

去除硬编码URL

<a href="/one_app/{{ question.id }}/">xxx</a>
<!-- 去除后 -->
<a href="{百分号 url 'one_app:detail' question.id 百分号}">xxx</a>

过滤器

过滤器的|符号左右最好不要加空格,否则被for循环时会报错

自定义过滤器

20210621191818

静态文件

<!-- 文件存放在one_app/static中 -->
{百分号 load static 百分号}
<link rel="stylesheet" type="text/css" href="{百分号 static 'css/style.css' 百分号}">

<img width="180" height="180" src="{百分号 static 'img/xxx.jpg' 百分号}"

数据库配置

  • SQLite(默认,Python内置)

自带,数据库会在需要的时候自动创建

# mysite/settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',  # 数据库引擎
        'NAME': BASE_DIR / 'db.sqlite3',  # sqlite的绝对路径
    }
}
  • MySQL

安装驱动:pip install pymysql

声明:onestep/__init__.py

import pymysql

pymysql.install_as_MySQLdb()  # 告诉django用pymysql代替mysqldb连接数据库

配置

# mysite/settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',  # 数据库引擎
        'NAME': 'dbname',  # 数据库名称
        'HOST': '127.0.0.1',  # host
        'PORT': 3306,  # 端口 
        'USER': 'root',  # 用户名
        'PASSWORD': '123456',  # 密码
        'OPTIONS': {
            'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",  # 解决迁移时的一个警告
            'charset': 'utf8mb4',
            "isolation_level": "repeatable read",  # 隔离级别设置为可重复读取,为了迁移数据适配数据库默认Binlog=STATEMENT时报错
        }
    }
}

创建数据库:create database if not exists dbname default character set utf8 collate utf8_general_ci;

配置拆分

拆分后,如果要在非默认环境下启动和数据迁移时(总之所有会牵扯到数据库相关的命令)记得加--settings=config_path

20210826183930

set_base

import os
from pathlib import Path


# 基础配置
TIME_ZONE = 'UTC'  # 时区
LANGUAGE_CODE = 'en-us'  # 语言


# 静态文件路径配置
STATIC_URL = '/static/'  # 单独应用
STATICFILES_DIRS = [  # 公共
    os.path.join(BASE_DIR, "statics"),
]

set_dev

from .set_base import *


DEBUG=True

set_prod

from .set_base import *


DEBUG=False
ALLOWED_HOSTS = ["*"]  # DEBUG等于False时必需配置

此时Django不会再提供静态文件服务

  • 方式1(适用于命令行启动):python manage.py runserver --insecure
  • 方式2 CDN

  • 配置文件中先把所有注册APP分散的静态资源都收集到统一位置:STATIC_ROOT = os.path.join(BASE_DIR, 'static_cdn')

  • 命令行执行收集命令:python manage.py collectstatic,将项目用到的所有静态文件集中存放在static_cdn路径下
  • 然后用Nginx提供静态资源服务

    location /static/ {
        alias /usr/share/nginx/mysite/static_cdn/;
    }
    
  • 重新加载:service nginx reload

启动

自带服务器命令行启动

主要是读取manage.py文件(项目自带,在项目根目录)

可设置为命令行默认启动开发环境:os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'onestep.settings.set_dev')

# 先切换到项目容器内
cd mysite
# 运行命令行工具manage.py启动项目,默认8000端口
# 首页地址:127.0.0.1:8000
# 根据默认配置启动
python manage.py runserver
# 可以更改端口
python manage.py runserver 8888
# 可以指定IP,比如监听所有服务器公开IP,0是0.0.0.0的缩写
python manage.py runserver 0:8000

# 指定配置文件启动
python manage.py runserver --settings=onestep.settings.set_prod

uWSGI 启动

主要读取wsgi.py文件(项目自带,与setting.py同目录)

可设置为uWSGI默认启动生产环境:os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'onestep.settings.set_prod')

pip install uwsgi  # 安装

uwsgi --http 127.0.0.1:3031 --file onestep/wsgi.py  # 命令行指定参数启动
uwsgi --ini path/uwsgi.ini  # 从配置文件启动,返回[uWSGI] getting INI configuration from uwsgi.ini
uwsgi --reload path/uwsgi.pid  # 重启
uwsgi --stop path/uwsgi.pid  # 停止
[uwsgi]
; 项目根目录
chdir=/app
; wsgi对象
module=onestep.wsgi:application
; 使用http协议提供服务,测试时使用
; http=127.0.0.1:3030
; 使用socket协议,配合nginx使用,与http端口不能重复
socket=127.0.0.1:3031
; 主进程
master=true
; 保存日志
daemonize=/tmp/uwsgi.log
; 保存进程号
pidfile=/tmp/uwsgi.pid

Nginx + uWSGI 启动

# nginx.conf
server {
    listen       8080;
    server_name  localhost;

    location / {
        include   uwsgi_params;
        # 使用uwsgi协议要用uwsgi_pass指令,proxy_pass指令使用的是http协议
        uwsgi_pass  127.0.0.1:3031;  # 与uwsgi.ini中socket字段配置一致
    }

    location /static {
        alias  /Users/7c/zuoright/onestep_django/static_cdn;  # 配置静态文件路径
    }

# 启动nginx
# 访问:<http://127.0.0.1:8000>

最后更新: 2021-11-19