Django项目创建
1.码云上创建项目
1.1在终端桌面上创建一个demo文件夹
1.2在码云上创建一个项目meiduo
1.3.终端cd demo
1.4.git clone meiduo的码云地址
1.5.得到项目meiduo ,cd meiduo git config user.name 'zs' git config user.email '123.@qq.com'
1.6.创建并切换分支到dev:git checkout -b dev a.查看分支 git branch
1.7.添加前端文件夹 a.cd meiduo b.mkdir front_end_pc c.将前端静态附件(css/js/html等等)复制到front_end_pc目录下
1.8.git提交: git add . git status git commit -m 'add front end files'
1.9.推送到远端 git push origin dev:dev # 本地的dev:远程的dev
1.10.拉取远程的分支到本地的分支
首先先切换到本地分支dev
git checkout -b dev # 如果分支存在会自动创建,并切换过去
git checkout dev # 切换到已经存在的分支
拉取远程的分支
git pull origin dev
git push <远程主机名> <本地分支名>:<远程分支名>
2.前端文件开发预览
注意:前端的js里用的vue的话,需要改JavaScript的版本为ECMAScript6 2.1.安装node.js的版本控制工具nvm,在终端中执行 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
2.2.重新进入终端,使用nvm安装最新版本的node.js nvm install node # 这是安装最新的版本 查看nvm有那些版本号:nvm ls-remote 查看安装nvm的版本:nvm ls
2.3.安装live-server npm install -g live-server
2.4.在静态文件目录front_end_pc下执行 live-server
2.5.live-server运行在8080端口下,可以通过127.0.0.1:8080来访问静态页面。
3.创建Django REST framework工程
3.1.终端切到码云meiduo项目里cd meiduo
3.2.终端进到django的虚拟环境里workon django_py3
3.3.创建项目meiduo_mall django-admin startproject meiduo_mall
3.4.用pycharm进入项目meiduo文件夹里
3.5.在外层文件夹meiduo_mall里创建文件夹 docs文件夹里面放接口文档 logs文件夹记录log日志 scripts文件夹里放脚本,例如,可以放一些测试数据文件
3.6.所有的核心代码放在内层的meiduo_mall文件夹里, a.在内层meiduo_all里创建apps包(init.py),所有的子应用都放在其里面 b.在内层meiduo_all里创建libs包,放第三方包 c.在内层meiduo_all里创建utils包,工具包 d.在内层meiduo_all里创建settings包,里面放settings的配置文件 分别为开发dev.py配置文件,生产prod.py配置文件
说明:
apps 存放Django的应用
libs 存放第三方的库文件
settings 存放配置文件的目录,分为开发dev和线上prod
utils 存放项目自己定义的公共函数或类等
docs 用于存放一些说明文档资料
scripts 用于存放管理脚本文件
4.修改manage.py
修改manage.py,使用settings中的dev配置,例如
os.environ['DJANGO_SETTINGS_MODULE'] = 'DJ3.settings.pro'
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "meiduo_mall.settings.dev")
运行时需要编辑manage.py里添加runserver ip:端口号
4.1 配置文件
# 创建settings文件,在里面创建三种配置文件
setting_dev.py # 开发配置
setting_pro.py # 生产配置
setting_test.py # 测试配置
5.创建子应用users
5.1.终端里进入到apps文件夹,创建users,注意manager.py的路径 python ../../manager.py startapp users
5.2.在配置文件dev.py里注册users(路径),注意此时的users里apps.py的UsersConfig类的路径;
第一种方法:
因为运行的是manager.py,所以此时UsersConfig类的路径为:
'meiduo_mall.apps.users.apps.UsersConfig',
配置文件dev.py的在INSTALLED_APPS注册的地址为:
'meiduo_mall.apps.users.apps.UsersConfig'
例如,此时的name值为:
class UsersConfig(AppConfig):
# name的值为'meiduo_mall.apps.users.apps.UsersConfig'中的apps前段部分
name = 'meiduo_mall.apps.users'
# name = 'users' # 配置里的为 'users.apps.UsersConfig'
第二种方法:
还是按照以前的注册路径
即配置文件dev.py的在INSTALLED_APPS注册的地址为:
'users.apps.UsersConfig
在配置文件dev.py里添加路径:
5.3添加导包路径
import sys
sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))
表示可以找到该路径'users.apps.UsersConfig'
apps包可以设置为Source Root包
6.注册DRF框架
在配置文件dev.py里注册:
INSTALLED_APPS = [
'rest_framework',
]
7.数据库
7.1创建数据库 create database meiduo_mall default charset=utf8;
7.2为本项目创建数据库用户(不再使用root账户)
create user meiduo_mall identified by 'meiduo';
grant all on meiduo_mall.* to 'meiduo'@'%';
flush privileges;
说明:
第一句:创建用户账号 meiduo_mall, 密码 meiduo (由identified by 指明)
第二句:授权meiduo_mall数据库下的所有表(meiduo_mall.*),
所有权限(all),给用户meiduo在以任何ip访问数据库的时候('meiduo'@'%'),
%表示任何ip都能访问,可以写成固定的ip
第三句:刷新生效用户权限
7.3数据库mysql的配置
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql', # 指明用的是mysql数据库
'HOST': '127.0.0.1', # 数据库主机
'PORT': 3306, # 数据库端口
'USER': 'meiduo', # 数据库用户名
'PASSWORD': 'meiduo', # 数据库用户密码
'NAME': 'meiduo_mall' # 数据库名字
}
}
注意:
记得在meiduo/meiduo_mall/meiduo_mall/init.py文件中添加
import pymysql
pymysql.install_as_MySQLdb()
# 迁移
python manage.py makemigrations
python manage.py migrate
8.Redis的配置
安装django-redis 查看redis有那些进程:ps aux | grep redis, 杀死进程:kill 进程号
设置Django缓存(如果不做设置,Django默认缓存是服务器的内存)
缓存中可以有多个存储空间
CACHES = {
"default": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://127.0.0.1:6379/0", # 数据所存的地址,ip port redis第0个库(0-15)
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
},
"session": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://127.0.0.1:6379/1",
"OPTIONS": {
'PASSWORD': "", # 表示没有设置密码
"CLIENT_CLASS": "django_redis.client.DefaultClient",
"CONNECTION_POOL_KWARGS": {"max_connections": 100}
}
}
}
指定将session存储到缓存中
SESSION_ENGINE = "django.contrib.sessions.backends.cache" # 三种储存的地方cache,db,cache_db
# 指定将session存储到缓存哪个空间中
SESSION_CACHE_ALIAS = "session" # 缓存空间有default,session
操作redis的补充
import redis
redis_conn = redis.StrictRedis(host='172.16.179.139', port=6379, db=1)
# 通过django-redis获取redis链接对象
from django_redis import get_redis_connection
redis_conn = get_redis_connection('session') # StricRedis
9.本地化语言与时区
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
10.Django项目日志存储设置
# 配置文件
LOGGING = {
'version': 1,
'disable_existing_loggers': False, # 是否禁用已经存在的日志器
'formatters': { # 日志信息显示的格式
'verbose': {
'format': '%(levelname)s %(asctime)s %(module)s %(lineno)d %(message)s'
},
'simple': {
'format': '%(levelname)s %(module)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/xxx.log"), # 日志文件的位置
'maxBytes': 300 * 1024 * 1024, # 300M 1M=1024k,1k=1024b
'backupCount': 10, # 最多有10个文件
'formatter': 'verbose' # 存储的格式
},
},
'loggers': { # 日志器
'django': { # 定义了一个名为django的日志器
'handlers': ['console', 'file'], # 可以同时向终端与文件中输出日志
'propagate': True, # 是否继续传递日志信息
'level': 'INFO', # 日志器接收的最低日志级别
},
}
}
输出日志,使用方法
import logging
logger = logging.getLogger('django')
logger.error('error message')
11.异常处理
修改Django REST framework的默认异常处理方法,补充处理数据库异常和Redis异常。
新建utils/exceptions_type.py
# -*- coding: utf-8 -*-
class AcnException(Exception):
pass
新建utils/exceptions.py,在其里面写如下代码
# -*- coding: utf-8 -*-
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
from utils.exception_type import AcnException
logger = logging.getLogger(__name__)
def exception_handler(exc, context):
"""
自定义异常处理
:param exc: 异常
:param context: 抛出异常的上下文
:return: Response响应对象
"""
# 调用drf框架原生的异常处理方法
response = drf_exception_handler(exc, context)
# response为None表示drf框架里面没有这样的异常,此时来寻找我们定义的异常逻辑
if response is None:
view = context['view']
print(context)
# 如果是数据库异常或者是redis异常,都会去处理,这里就是自定义异常逻辑处理
if isinstance(exc, DatabaseError) or isinstance(exc, RedisError):
# 数据库异常
logger.error('[%s] %s' % (view, exc))
response = Response({'message': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)
elif isinstance(exc, AcnException):
response = Response({"message": exc.args[0]}, status=status.HTTP_200_OK)
return response
配置文件dev.py中添加
REST_FRAMEWORK = {
# 指定DRF框架异常处理函数
'EXCEPTION_HANDLER': 'meiduo_mall.utils.exceptions.exception_handler', # 注意路径 异常函数
}
12.跨域请求(配置文件dev.py)
12.1.安装 pip install django-cors-headers
12.2.添加应用
INSTALLED_APPS = ['corsheaders',]
12.3.中间层设置
MIDDLEWARE = [
'corsheaders.middleware.CorsMiddleware',
]
12.4添加白名单
CORS
CORS_ORIGIN_WHITELIST = (
'127.0.0.1:8080',
'localhost:8080',
'www.meiduo.site:8080',
)
# 设置跨域请求时,是否允许携带cookie
CORS_ALLOW_CREDENTIALS = True # 允许携带cookie
凡是出现在白名单中的域名,都可以访问后端接口
CORS_ALLOW_CREDENTIALS 指明在跨域访问中,后端是否支持对cookie的操作。
13.celery的使用(异步执行)
https://blog.csdn.net/jiandanokok/article/details/102335091
# 创建一个celery_tasks包,在其里面创建main.py和config.py文件,创建sms包(异步执行的代码放在里面)
# sms包里的文件异步执行的代码文件名必须交tasks.py
1. # 在main.py文件里的代码
from celery import Celery
# 创建Celery对象
celery_app = Celery('celery_tasks') # 这里面的名字随便取
# 加载配置信息
celery_app.config_from_object('celery_tasks.config') # 中间人的路径
# 自动发现任务
celery_app.autodiscover_tasks(['celery_tasks.sms']) # 执行任务模块文件包的路径,里面必须交tasks.py
2. # 在config.py文件里的代码
# 设置中间人broker地址
broker_url = 'redis://172.16.179.139:6379/3' # 就好比队列,储存在redis里面
3. # sms包里的tasks.py里的代码
# 封装任务函数
from celery_tasks.main import celery_app # 导入Celery对象
import logging
from celery_tasks.yuntongxun.sms import CCP
logger = logging.getLogger('diango')
# 发送的短信模板
SMS_CODE_TEMP_ID = 1
# 为celery使用django配置文件进行设置
import os
if not os.getenv('DJANGO_SETTINGS_MODULE'): # 可以单独的运行某个文件,可以看manage.py
os.environ['DJANGO_SETTINGS_MODULE'] = 'meiduo_mall.settings.dev'
@celery_app.task(name='send_sms_code')
def send_sms_code(mobile, sms_code, expires):
try:
res = CCP().send_template_sms(mobile, [sms_code, expires], SMS_CODE_TEMP_ID)
except Exception as e:
# 有异常执行逻辑
logger.error('发送短信异常: mobile:[%s], sms_code:[%s]' % (mobile, sms_code))
else:
# 没有异常执行逻辑
if res != 0:
# 发送短信失败
logger.error('发送短信失败: mobile:[%s], sms_code:[%s]' % (mobile, sms_code))
else:
# 发送短信成功
logger.info('发送短信成功: mobile:[%s], sms_code:[%s]' % (mobile, sms_code))
4. # 终端执行的命令,切到celery_tasks包当前的路径 ,开启worker
celery -A celery_tasks.main worker -l info # 后面是日志的等级
5. # 调用异步执行的函数,在需要的文件里调用,例如,在views.py里调用
from celery_tasks.sms.tasks import send_sms_code
send_sms_code.delay(mobile,sms_code,expires)
14.JWT token
安装
pip install djangorestframework-jwt
配置dev.py
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.BasicAuthentication',
),
}
JWT_AUTH = {
'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),
}
-
JWT_EXPIRATION_DELTA 指明token的有效期
使用
# 创建用户时,可以使用JWT token保持状态,就为了给用户保持状态
class CreateUserSerializer(serializers.ModelSerializer):
...
def create(self, validated_data):
"""保存注册用户信息"""
# 清除无用的数据
del validated_data['password2']
del validated_data['sms_code']
del validated_data['allow']
# # 调用父类create方法
# user = super().create(validated_data)
#
# # 对密码进行加密
# password = validated_data['password']
# user.set_password(password)
# user.save()
# 调用create_user方法
user = User.objects.create_user(**validated_data)
# 注册成功就让用户处于登录状态
# 由服务器签发一个jwt token,保存用户身份信息
from rest_framework_jwt.settings import api_settings
jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
# 生成载荷信息(payload)
payload = jwt_payload_handler(user)
# 生成jwt token
token = jwt_encode_handler(payload)
# 给user对象增加一个属性token,保存jwt token信息
user.token = token
# 返回user
return user
14.1用户登录时,也要带 JWT token(参考文档)
15.增加要验证的字段
class User(AbstractUser):
"""
用户信息
"""
mobile = models.CharField(max_length=11, unique=True, verbose_name="手机号")
email_active = models.BooleanField(default=False, verbose_name='邮箱验证状态')
# 这个里面的字段生成的表名为:auth_user
# 添加验证,前段的请求头里需要带字段Authorization,值为:Basic YWRtaW46QWJjLDEyMy4=
# Basic是固定的,后面的是通过base64加密出来,例如:
# 前面是账号,后面是密码,中间加‘ :’隔开
ret = base64.b64encode(b"admin:Abc,123.").decode("utf-8") # YWRtaW46QWJjLDEyMy4=
authentication_classes = (BasicAuthentication,)