下载IDE,如:pycharm,
数据库、其他中间件等
2-创建虚拟环境
需要制定虚拟环境,环境中安装好Django的版本,可pip install 安装好
如果在pycharm中可以直接拖进去当前目录即可安装依赖包,可直接settings创建虚拟环境
命令:mkvirtualenv django_py3 -p python3
3-创建工程
进入某文件或者创建某文件目录下,django-admin.py startproject 工程名
4-创建子应用
子应用最好装在一个apps目录下,这样比较方便写接口代码
注意将apps设定为导包路径
python manage.py startapp 子应用名字
(这个地方要注意寻找到manage.py的文件路径,通常我的是../../manage.py)
5-运行工程
python manage.py runserver ip:端口
或: python manage.py runserver
下面为配置文件的配置项
6-注册安装子应用
'rest_framework', # DRF 第三方包写在中间,自己的包写最下面
'users.apps.UsersConfig'。
用到第三方包的话也要注册第三方应用 注册与配置文件中
7-工程配置
1、修改配置文件,创建settings目录,存放dev开发模式,prod线上模式,两个配置分别存放。
将settings.py文件的配置cv过来,修改manag.py的默认配置
os.environ.setdefault("DJANGO_SETTINGS_工程名", "同名工程名.settings.dev")
8-修改导包路径
我们将配置文件改为放在settings子目录下,所以 配置文件中的BASE_DIR
指向的变为了存放工程的文件夹/工程名字/工程同名目录
。
使用sys.path
添加<BASE_DIR>/apps
目录,即可添加apps应用的导包路径。
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# 添加导包路径
import sys
sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))
9-数据库
于配置文件修改
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'HOST': '*.*.*.*', # 数据库主机
'PORT': 3306, # 数据库端口
'USER': 'gaap', # 数据库用户名
'PASSWORD': 'gaap', # 数据库用户密码
'NAME': 'gaap' # 数据库名字
}
}
注意:
记得在存放工程的文件夹/工程名/__init__.py
文件中添加
import pymysql
pymysql.install_as_MySQLdb()
10-安装djang-redis并配置
CACHES = {
"default": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://*.*.*.*:6379/0",
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
},
"session": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://*.*.*.*:6379/1",#ip地址:端口/redis的库名之一
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
}
}
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
SESSION_CACHE_ALIAS = "session"
除了名为default的redis配置外,还补充了名为session的redis配置,分别使用两个不同的redis库。
同时修改了Django的Session机制使用redis保存,且使用名为'session'的redis配置。
此处修改Django的Session机制存储主要是为了给Admin站点使用。
11-语言
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
12-日志
LOGGING = {
'version': 1,
'disable_existing_loggers': False, # 是否禁用已经存在的日志器
'formatters': { # 日志信息显示的格式
'verbose': {
'format': '%(levelname)s %(asctime)s %(gaap)s %(lineno)d %(message)s'
},
'simple': {
'format': '%(levelname)s %(gaap)s %(lineno)d %(message)s'
},
},
'filters': { # 对日志进行过滤
'require_debug_true': { # django在debug模式下才输出日志
'()': 'django.utils.log.RequireDebugTrue',
},
},
'handlers': { # 日志处理方法
'console': { # 向终端中输出日志
'level': 'INFO',
'filters': ['require_debug_true'],
'class': 'logging.StreamHandler',
'formatter': 'simple'
},
'file': { # 向文件中输出日志
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(os.path.dirname(BASE_DIR), "logs/gaap.log"), # 日志文件的位置
'maxBytes': 300 * 1024 * 1024,
'backupCount': 10,
'formatter': 'verbose'
},
},
'loggers': { # 日志器
'django': { # 定义了一个名为django的日志器
'handlers': ['console', 'file'], # 可以同时向终端与文件中输出日志
'propagate': True, # 是否继续传递日志信息
'level': 'INFO', # 日志器接收的最低日志级别
},
}
}
13-异常处理
修改Django REST framework的默认异常处理方法,补充处理数据库异常和Redis异常。
新建utils/exceptions.py
from rest_framework.views import exception_handler as drf_exception_handler
import logging
from django.db import DatabaseError
from redis.exceptions import RedisError
from rest_framework.response import Response
from rest_framework import status
# 获取在配置文件中定义的logger,用来记录日志
logger = logging.getLogger('django')
def exception_handler(exc, context):
"""
自定义异常处理
:param exc: 异常
:param context: 抛出异常的上下文
:return: Response响应对象
"""
# 调用drf框架原生的异常处理方法
response = drf_exception_handler(exc, context)
if response is None:
view = context['view']
if isinstance(exc, DatabaseError) or isinstance(exc, RedisError):
# 数据库异常
logger.error('[%s] %s' % (view, exc))
response = Response({'message': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)
return response
需要配置
如果我们新建utils文件中自定义异常处理了,那么我需要在配置文件中添加配置:
REST_FRAMEWORK = {
# 异常处理 'EXCEPTION_HANDLER': '工程名.utils.exceptions.exception_handler', }#主要是指定好路径
14-追加apps为导包路径
创建一个apps包,来写程序应用。但是需要source root添加到导包路径中,才可以导包。而导包路径默认的是Django的路径。
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(file))) ( 上一级/上一级/当前文件)
当前工程的根目录,Django会依此来定位工程内的相关文件,我们也可以使用该参数来构造文件路径。
1.提示 上⾯AUTH_USER_GAAP = 'users.User'的⽅式的导包路径,默认是不会被识别的,需要追加导包路径
2.查看默认的导包路径
import sys
print(sys.path)
3.追加导包路径 sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))
15-自定义用户模型
Django提供了django.contrib.auth.models.AbstractUser用户抽象模型类允许我们继承,扩展字段来使用Django认证系统的用户模型类。
在 工程名/工程同名目录/apps中创建Django应用users,并在配置文件中注册users应用。
在创建好的应用models.py中定义用户的用户模型类。
-
class User(AbstractUser): """用户模型类""" mobile = models.CharField(max_length=11, unique=True, verbose_name='手机号')
-
class Meta: db_table = 'tb_users' verbose_name = '用户' verbose_name_plural = verbose_name
我们自定义的用户模型类还不能直接被Django的认证系统所识别,需要在配置文件中告知Django认证系统使用我们自定义的模型类。
在配置文件中进行设置
settings的dev.py更改配置l(底层要求必须按这个格式写应用名.模型名的格式)
AUTH_USER_GAAP = 'users.User'