后台日志封装、全局异常处理封装、封装Response、luffy数据库创建、django配置文件、开启media访问
上节回顾
#1 公司里软件开发规范
-作为后端的开发流程
-禅道
# 2 路飞需求分析
-首页板块
-用户板块
-课程列表板块
-课程详情版块
-支付板块
-下单板块
# 3 pip 换源
# 4 虚拟环境
-两个模块
virtualenv----》virtualenv.exe 用来创建虚拟环境
virtualenvwrapper-win---》virtualenvwrapper.bat 批处理文件，命令简化
-命令：创建，查看，进入，退出虚拟环境
-pycharm中使用虚拟环境
-环境变量：在cmd窗口中，敲命令，能够执行，在当前路径下有这个命令，环境变量中有
-D:\Python38\Scripts 已经被加到环境变量
-问题：
-python2
-python3.8 python3.8 pip3.8
-python3.9
-python3.10
-虚拟环境
-python3
-pip3
# 5 创建路飞前后台
-后台---》pychram 在虚拟环境上先把django 3.2.2装好 ；django-admin创建项目，切换到虚拟环境中
-前台
# 6 包导入
- from 或者 import 路径必须从环境变量开始 sys.path
- 相对导入（相对于执行的脚本文件），绝对导入（根是环境变量）
-包下都有个 __init__.py ---》
-requests----》 import requests---》把init导入了---》requests.能点出来的都是init中的
-咱们写包，想给外部用的，都在init中注册一下，以后别人用，简单
# 7 调整目录
- 目录结构调整，做的清晰一些
-配置文件路径变了，现在不能运行了---》修改路径
-开发阶段 manage.py
-上线阶段 wsgi.py asgi.py
-创建app都在 apps文件夹下，想注册，只写app名字
-把apps路径加入到环境变量
-项目根路径(小路飞路径)，加入到环境变量
今日内容
-
后台日志封装
-
前端后端分离的rbac项目演示
-
全局异常处理封装
-
封装Response
-
luffy数据库创建
-
软件开发模式
-
User模块用户表
-
django的配置文件
-
开启media访问
1 后台日志封装
# 以后，项目肯定要记录日志
-日志都可以打印到控制台
-日志可以写道日志文件中
-日志存到某个库中
-所有项目日志统一管理 sentry:django写的服务，收集日志的，可以展示 开源的
# 以后，在项目中不要出现print了，以后都用日志
logger.info()，以后项目上线，只需要调整日志级别，低级别的日志就不打印了，于是日志输出不用删掉
1.1 操作步骤
# 操作步骤：django中集成日志步骤，django使用的就是python内置的日志模块
第一步
在配置文件中加入 日志配置 ---大字典
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.utils.log.RequireDebugTrue',
},
},
'handlers': {
'console': {
# 实际开发建议使用WARNING
'level': 'INFO',
'filters': ['require_debug_true'],
'class': 'logging.StreamHandler',
'formatter': 'simple'
},
'file': {
# 实际开发建议使用ERROR
'level': 'WARNING',
'class': 'logging.handlers.RotatingFileHandler',
# 日志位置,日志文件名,日志保存目录必须手动创建，注：这里的文件路径要注意BASE_DIR代表的是小luffyapi
'filename': os.path.join(os.path.dirname(BASE_DIR), "logs", "luffy.log"),
# 日志文件的最大值,这里我们设置300M
'maxBytes': 300 * 1024 * 1024,
# 日志文件的数量,设置最大日志数量为10
'backupCount': 10,
# 日志格式:详细格式
'formatter': 'verbose',
# 文件内容编码
'encoding': 'utf-8'
},
},
# 日志对象
'loggers': {
'django': {
'handlers': ['console', 'file'],
'propagate': True, # 是否让日志信息继续冒泡给其他的日志处理系统
},
}
}
第二步
在utils新建 common_logger.py ,得到日志对象
import logging
logger = logging.getLogger('django')
第三步
在任意想用日志的地方，导入使用即可
from utils.common_logger import logger
# 测试
def text_logger(request):
logger.info('info级别的日志')
logger.error('error级别的日志')
2 前后端分离的rbac项目演示
# 后台：https://gitee.com/liuqingzheng/rbac_manager
# 前端：https://gitee.com/liuqingzheng/vue_admin
3 全局异常处理封装
# 前端 要接受的格式，要统一，无论后端是否出错
# 三大认证，视图类的方法中只要出了异常，就会执行一个函数，但是这个函数只能处理drf的异常--->我们需要自己写个函数，既能处理drf异常，又能处理django异常，这样统一返回格式，前端看到格式都统一了
3.1 使用步骤
第一步
在utils中新建 common_exceptions.py
第二步
# 写个函数
from rest_framework.views import exception_handler as drf_exception_handler
from rest_framework.response import Response
from utils.common_logger import logger
# 只要走到这个函数中，一定是出异常了，所以要记录日志
def exception_handler(exc, context):
# 1 记录日志:哪个ip地址，用户id是多少，访问哪个路径，执行哪个视图函数，出了什么错
request = context.get('request')
view = context.get('view')
ip = request.META.get('REMOTE_ADDR')
user_id = request.user.pk
path = request.get_full_path()
response = drf_exception_handler(exc, context)
if response:
logger.warning(f'drf出了异常,异常是[{str(exc)}]')
# drf的异常已经处理了---->直接取detail 会有点小问题，碰到在解决
res = Response({'code': 999, 'msg': response.data.get('detail', '服务器异常，请联系系统管理员')})
else:
# django的异常，咱们要自己处理
logger.error(f'用户[{user_id}],ip地址为[{ip}],访问地址为[{path}],执行的视图函数为[{str(view)}],出错的是[{str(exc)}]')
res = Response({'code': 888, 'msg': '服务器异常，请联系系统管理员'})
return res
第三步
配置配置文件，以后只要出了异常，都会走咱们的函数
REST_FRAMEWORK = {
'EXCEPTION_HANDLER':'utils.common_exceptions.exception_handler',
}
4 封装Response
# 本身drf有Response，但是咱们公司规定，前端收到的格式都是固定的
-{code:100,msg:提示,data:{}/[]}
-{code:100,msg:提示,token:asdfasd,user:lqz}
# 对Response进行封装，封装后，code，msg可以不传，不传就用默认的
4.1 使用步骤
第一步
在utils下新建common_response.py
第二步
封装APIRespon
from rest_framework.response import Response
'''
以后使用
-return APIResponse()----------------前端收到-->{code:100,msg:成功}
-return APIResponse(token=xxxx,username=zyl)---------->前端收到-->{code:100,msg:成功,token=xxxx,username:zyl,}
-return APIResponse(data=[{},{},{}])---------->前端收到-->{code:100,msg:成功,data=[{},{},{}],}
-return APIResponse(code=101,msg=失败)---------->前端收到-->{code:101,msg:失败,}
'''
class APIResponse(Response):
def __init__(self, code=100, msg='成功', status=None, headers=None, **kwargs):
# 有值，说明，传了code msg status headers 以外的，咱们都要返回给前端，放到这个data中
data = {'code': code, 'msg': msg}
if kwargs: # 有值，说明，传了code msg status headers 以外的，咱们都要返回给前端，放到这个data中
data.update(kwargs)
super().__init__(data=data, status=status, headers=headers)
# 不要return，你可以这样做 self.data=data self.status=status
第三步
导入使用，视图函数的方法，返回时，都使用咱们自己的
5 luffy数据库创建
5.1 创建用户创建库
# 创建luffy数据库
# 之前项目操作数据库，都是使用root用户，root用户权限太高了，在公司里，一般不会给你root用户权限
# 如果开发人员是root权限，数据安全性就很差
# 开发人员，专门创建一个用户，用户只对当前项目的库有操作权限
# 创建一个luffy库，创建luffy用户，luffy用户只对luffy库有操作权限
# 面试题：utf8 utf8mb4 有什么区别
创建luffy数据库
# 创建luffy数据库
"""
1.管理员连接数据库
>: mysql -uroot -proot
2.创建数据库
>: create database luffy default charset=utf8;
3.查看用户
>: select user,host,password from mysql.user;
只有root用户，要创建luffy用户
# 5.7往后的版本
>: select user,host,authentication_string from mysql.user;
"""
创建路飞用户，授予luffy库所有权限
"""
设置权限账号密码
# 授权账号命令：grant 权限(create, update) on 库.表 to '账号'@'host' identified by '密码'
1.配置任意ip都可以连入数据库的账户
>: grant all privileges on luffy.* to 'luffy'@'%' identified by 'Luffy123?';
2.由于数据库版本的问题，可能本地还连接不上，就给本地用户单独配置
>: grant all privileges on luffy.* to 'luffy'@'localhost' identified by 'Luffy123?';
3.刷新一下权限
>: flush privileges;
只能操作luffy数据库的账户
账号：luffy
密码：Luffy123?
"""
知识补充:
mysql用localhost和IP地址连接有什么区别？
本地连的话没有经过网卡有socket文件直接连的
IP地址连是经过了网卡又通过网卡去连的
5.2 使用项目连接库
# 项目操作mysql，需要安装模块
-pymysql
-mysqlDB
-mysqlclient
-历史：原来py2上有个操作mysql的模块叫mysqlDB，但到py3，没有支持py3，django默认使用这个模块去连接mysql，默认使用-mysqlDB连接，-mysqlDB不支持py3，运行报错
-我们使用pymysql，作为连接mysql的数据库模块，但是需要加代码
imprort pymysql
pymysql.install_as_mysqldb() # 猴子补丁
-django 2.2.2以后，还使用pymysql，需要改djagno源代码
-统一使用mysqlclient来作为操作mysql的底层库
-基于py2的mysqldb，在py3上重新了，但是名字改成了mysqlclient
-使用mysqlclient，只需要安装这个模块，不需要再写任何代码，直接用即可
-但是：mysqlclient 这个模块，不好装
-win 一般人品好，人品好，pip install mysqlclient
-人品不好，装不了，centos部署项目，后面会讲centos上如何装
# mysqlclient
pip install mysqlclient
配置文件修改，连接mysql，使用路飞用户
# 用户名密码写死在代码中,保证安全
name = os.environ.get('LUFFY_NAME', 'luffy')
password = os.environ.get('LUFFY_PASSWORD', 'Luffy123?')
# 拓展：有的公司，直接有个配置中心---》服务--》只用来存放配置文件
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'luffy',
'USER': 'luffy',
'PASSWORD': 'Luffy123?',
'HOST': '127.0.0.1',
'PORT': 3306
}
}
6 软件开发模式
# 瀑布模式：bbs项目就是按照这种模式
-需求分析---》设计--》创建数据库 所有都创建---》开发(3个月)---》交给测试--》测试通过---》上线
# 敏捷开发
-需求分析---》设计---》只设计一个板块---》开发(2周)---》交给测试---》运维上线(测试环境)
-设计---》只设计一个板块---》开发(2周)---》交给测试---》运维上线(测试环境)
-一个sprint周期
-scrum敏捷项目管理
7 User模块用户表
# 你决定使用auth表扩写，项目一定不要先迁移，先建好用户表再迁移
已经迁移完了，再想用auth的user表
-删库，删迁移文件所有app
-删admin和auth的迁移文件
创建luffy用户表
# 用户表使用auth表扩写 pip install Pillow
class User(AbstractUser):
# 扩写手机号和头像字段
mobile = models.CharField(max_length=11, unique=True)
# 需要pillow包的支持
icon = models.ImageField(upload_to='icon', default='icon/default.png')
class Meta:
db_table = 'luffy_user'
verbose_name = '用户表'
verbose_name_plural = verbose_name
def __str__(self):
return self.username
#配置文件中 自定义用户表配置
AUTH_USER_MODEL = 'user.User'
# 遇到的问题，明明小luffyapi已经加入到环境变量，程序运行没问题，但是表迁移，就报错，找不到模块
-打印了看一下，确实环境变量有，但是不是个字符串，是个对象
-程序运行，是没问题
-迁移有问题：配置文件中转成字符串，就解决了
8 djagno的配置文件
# pathlib # 3.6 以后，处理文件路径的模块，原来是os，
# 面试题，md5是对称加密还是非对称加密
-对称加密：加密的秘钥和解密的秘钥是同一个
-非对称加密：加密使用公钥加密，解密使用私钥解密，使用公钥是不能解密的
-摘要算法：没有解密这一说
# 运行django ，跑在0.0.0.0上，局域网内，所有人都能访问
配置文件详解
from pathlib import Path
import os
import sys
# 项目根路径
# 我们就是要让小路飞路径作为项目根路径
BASE_DIR = Path(__file__).resolve().parent.parent # 项目根路径， 小路飞luffy_api路径 D:\pythonProject03\luffy_api\luffy_api
# print(BASE_DIR)
# 把 apps 路径加入到环境变量
sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))
# 把BASE_DIR也加入到环境变量，以后直接从小路飞开始导起即可
sys.path.insert(0, str(BASE_DIR))
# print(sys.path)
# 以后从大路飞开始导起，或者小路飞开始导起，或者apps开始导起都可以
# 秘钥，涉及到加密的django中，都会用它
SECRET_KEY = 'django-insecure-!g(8l%fw_#t$pz$x4jdf#e3$b4+c%xzqyq@3zki08vj&i)z4k-'
# 项目是以debug模式运行，还是非debug模式运行
# 项目上线，要改成false
# debug=True 代码可以热更新
# 调试模式下，对开发者更友好：可以列出所有路径.报了错，前端能看到
DEBUG = False
# 它搭配debug=False，它的意思是，允许我的项目部署在哪个ip地址上，* 表示允许部署在所有地址上
ALLOWED_HOSTS = ['*']
# django 是多个app组成的，里面配置app，默认带的app，django内置的app
# django 是一个大而全的框架，有很多内置app：
# admin后台管理，
# auth权限管理，
# contenttypes表中存app也表的关系，
# sessions session表，django的session相关
# messages：消息框架，flask讲闪现，是一样的东西
# staticfiles：静态资源的
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
# 'luffy_api.apps.home', # luffy_api在环境变量，直接从这一层开始导起, 太长了，以后就想 注册 home
# 'luffy_api.apps.user'
'home',
'user'
]
# 中间件
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware', # 安全相关中间件
'django.contrib.sessions.middleware.SessionMiddleware', # session相关中间件
'django.middleware.common.CommonMiddleware', # 带不带 / 问题
'django.middleware.csrf.CsrfViewMiddleware', # csrf 认证，生成csrf串
'django.contrib.auth.middleware.AuthenticationMiddleware', # 用户认证
'django.contrib.messages.middleware.MessageMiddleware', #消息框架相关
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
# 根路由
ROOT_URLCONF = 'luffy_api.urls'
# 模板文件
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [BASE_DIR / 'templates'], # 坑，模板路径用列表，可以有多个
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
# 项目运行的配置---》项目上线运行，使用uwsgi 运行 application()
WSGI_APPLICATION = 'luffy_api.wsgi.application'
# 用户名密码写死在代码中了，保证安全
name = os.environ.get('LUFFY_NAME', 'luffy')
password = os.environ.get('LUFFY_PASSWORD', 'Luffy123?')
# 拓展：有的公司，直接有个配置中心---》服务--》只用来存放配置文件
# 数据库配置,mysql 主从搭建完，读写分离
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'luffy',
'USER': name,
'PASSWORD': password,
'HOST': '127.0.0.1',
'PORT': 3306
},
}
#忽略掉
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# 国际化
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_L10N = True
USE_TZ = False
# 静态资源
STATIC_URL = '/static/'
#
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
9 开启media访问
配置文件中配置
# 配置文件加入
MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
路由中设置
from django.contrib import admin
from django.urls import path
from user import views
# 导入seve
from django.views.static import serve
# 导入配置文件--->如果你配了用你的 如果没配 用内置
from django.conf import settings
urlpatterns = [
path('admin/', admin.site.urls),
path('media/<path:path>', serve, {'document_root': settings.MEDIA_ROOT})
]
# 访问
http://127.0.0.1:8000/media/icon/default.png
# 以后使用djagno的配置文件都用这个
from django.conf import settings
