今日内容概要

• 后台日志封装
• 前后端分离的rbac项目演示
• 全局异常处理封装
• 封装Response
• luffy数据库创建
• 软件开发模式
• user模块用户表
• django的配置文件
• 开启media访问

今日内容详细

后台日志封装

1.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.utils.log.RequireDebugTrue',
            },
        },
        'handlers': {
            # 控制台打印配置
            'console': {
                # 实际开发建议使用WARNING
                'level': 'INFO',
                'filters': ['require_debug_true'],
                'class': 'logging.StreamHandler',
                'formatter': 'simple'
            },
            # 写入文件配置
            'file': {
                # 实际开发建议使用ERROR
                'level': 'INFO',
                '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,  # 是否让日志信息继续冒泡给其他的日志处理系统
            },
        }
    }

2.在utils中新建一个common_logger.py 并取到日志对象
	import logging
	logger = loggin.getLogger('django')

3.在需要用到日志的地方导入即可
	from utils.common_logger import logger
	logger.info('记录内容')

前后端分离的rbac项目演示

# 后台：https://gitee.com/liuqingzheng/rbac_manager
# 前端：https://gitee.com/liuqingzheng/vue_admin

全局异常处理封装

无论后端是否出错 前段收到的格式都需要统一 所以需要封装全局异常处理

使用drf 执行三大认证的时候只要出现了异常 就会执行一个函数自动捕获 所以我们模仿它 写个函数处理 是格式统一

1.在utils中新建一个common_exceptions.py
2.写个函数
    # 给原本处理异常的函数起个别名 反之冲突
    from rest_framework.views import exception_handler as drf_exception_handler
    from rest_framework.response import Response
    from .common_logger import logger


    def exception_handler(exc, context):
        # context中可以取到请求时的request 及访问的视图
        request = context.get('request')
        view = context.get('view')
        # 判断出错是用户是否登录
        user = request.user.pk
        # 走了这个函数就说明出错了 日志详细记录错误信息
        logger.error(
            f'用户:【{user}】 使用请求方式【{request.method}】 请求了【{request.get_full_path()}】地址 视图:【{view.__class__.__name__}】 发生了错误【{str(exc)}】')
        # 调用原本drf处理异常的函数
        res = drf_exception_handler(exc, context)
        # 判断是否是drf捕获的异常
        if res:
            # 如果是drf的异常 统一返回格式
            res = Response(data={'code': 999, 'msg': res.data.get('detail', '未知异常 请联系管理员')})
        else:
            # 如果不是drf的异常 而是其他异常 将错误转成字符串 并统一返回格式
            res = Response(data={'code': 888, 'msg': str(exc)})
        return res

封装response

drf本身就有response 但是返回的格式不符合我们的要求 所以我们进行二次封装

1.在utils下新建common_response.py
2.封装自己的response
	from rest_framework.response import Response


# 继承drf的response
class APIResponse(Response):
    # 返回的时候都是response实例化的对象 所以写一个__init__函数
    # 默认code是100 msg是成功 status是http状态码 headers是响应头 kwargs用于接收多余位置参数
    def __init__(self, code=100, msg='成功', status=None, headers=None, **kwargs):
        # 重组返回格式
        data = {'code': code, 'msg': msg}
        # 判断kwargs是否有值 如果有值说明传了其他参数
        if kwargs:
            # update方法可以将传进来的字典更新到旧字典中
            data.update(kwargs)
        # 调用drf的response的__init__ 并将对应参数传入 完成真正的返回
        super().__init__(data=data, status=status, headers=headers)
        

luffy数据库创建

创建用户

由于root用户的权限太高了 一般项目都不会使用root用户 而是创一个新的用户

1.创建一个luffy库
	create database luffy;
2.创建路飞用户 并授予luffy库的权限
	授权账号命令：grant 权限(create, update) on 库.表 to '账号'@'host' identified by '密码'
	grant all privileges on luffy.* to 'luffy'@'localhost' identified by 'luffy123?';
3.刷新一下权限
	flush privileges

后续路飞项目使用该用户 保证数据安全

项目连接库

在python2上操作数据库的模块叫做mysqlDB 但是不支持python3 django默认使用的就是这个模块 所以直接运行的话是会报错的

所以需要安装pymysql或者mysqlclient
	django2.2.2版本之前 只需要导入pymysql并用猴子补丁即可
		import pymysql
		pymysql.install_as_mysqldb()
	但是后续版本要使用就需要修改源代码 所以我们改用另一个模块

安装mysqlclient
	pip install mysqlclient
基于mysqldb 在python3上重写了 但是名字改成了mysqlclient
安装完成后不需要写任何额外代码 直接用即可

在配置文件中修改 使用路飞用户
# os.environ可以去系统环境变量中取值 我们可以将用户密码保存在系统环境变量中 防止密码泄露
name = os.environ.get('LUFFY_USER', 'luffy')
# 如果取不到就使用默认值 可以设为本地测试库的密码或者假的 真正的密码还在系统环境变量中 并不会暴露
pwd = os.environ.get('LUFFY_PWD', 'luffy123')

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'luffy',
        'USER': name,
        'PASSWORD': pwd,
        'HOST': '127.0.0.1',
        'PORT': 3306
    }
}

软件开发模式

# 瀑布模式：bbs项目就是按照这种模式
	-需求分析---》设计--》创建数据库 所有都创建---》开发(3个月)---》交给测试--》测试通过---》上线
	
# 敏捷开发
	-需求分析---》设计---》只设计一个板块---》开发(2周)---》交给测试---》运维上线(测试环境)
    -设计---》只设计一个板块---》开发(2周)---》交给测试---》运维上线(测试环境)

一个sprint周期 就是敏捷开发单板块的开发周期

创建user表

如果决定继承auth表进行扩写 那么表一定不要先迁移 把表建好在进行迁移 否则很麻烦
	如果已经迁移完了 再想用auth的user表
		1.删库 删除迁移记录文件
		2.django下contrib下删除admin和auth下migrations的迁移记录文件

用户表

from django.db import models
from django.contrib.auth.models import AbstractUser

# Create your models here.


class UserInfo(AbstractUser):
    # 扩写手机号和头像字段
    mobile = models.CharField(max_length=11, unique=True)
    # 使用ImageField字段需要安装pillow模块 
    icon = models.ImageField(upload_to='icon', default='icon/default.png')

    class Meta:
        # 指定表名为luffy_user
        db_table = 'luffy_user'
        verbose_name = '用户表'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.username


	在执行表迁移命令的时候 遇到了小问题 就是小luffy已经在环境变量中了 程序运行不会报错 但是迁移表就会报错 是因为虽然环境变量中有了小luffy的路径 但是个对象 并不是字符串 将它转为字符串即可
	sys.path.append(str(BASE_DIR))

django的配置文件

from pathlib import Path
import os
import sys

# 醒目的根路径
BASE_DIR = Path(__file__).resolve().parent.parent

# 秘钥 涉及到加密 在django中都会使用它
SECRET_KEY = 'django-insecure-0t3)i4y(az4sxgs%3y8xahvm$l#_n^i4z$&-xi_2rmo9377$ck'

# 是否以debug模式运行项目 开发阶段可以使用它 报错的时候 前端可以看到错误信息 并且列出所有路由路径
# 如果改为False需要配合ALLOWED_HOSTS使用
DEBUG = True
# 搭配DEBUT=False使用 意思是允许项目部署在哪个ip地址上 *表示允许部署在所有地址上
ALLOWED_HOSTS = []

# 注册app django自带了很多app
INSTALLED_APPS = [
    'django.contrib.admin', # 后台管理
    'django.contrib.auth',  # 权限管理
    'django.contrib.contenttypes',  # 关系表 表中存着app与表的关系
    'django.contrib.sessions',  # session表 与django的session相关
    'django.contrib.messages',  # 消息框架 
    'django.contrib.staticfiles',  # 静态资源
]

# 中间件
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.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.wsgi.application'


# os.environ可以去系统环境变量中取值 我们可以将用户密码保存在系统环境变量中 防止密码泄露
name = os.environ.get('USER', 'luffy')
# 如果取不到就使用默认值 可以设为本地测试库的密码或者假的 真正的密码还在系统环境变量中 并不会暴露
pwd = os.environ.get('PWD', 'luffy123')

# 数据库配置 可以有多个 可以用于数据库主从搭建 以及读写分离
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'luffy',
        'USER': name,
        'PASSWORD': pwd,
        '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'

开启media访问

添加配置
MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

总路由中设置 二选一 推荐path
from django.urls import path, include
from django.views.static import serve
from django.conf import settings

urlpatterns = [
    path('api/v1/home/', include('apps.home.urls')),
    path('media/<path:path>', serve, kwargs={'document_root': settings.MEDIA_ROOT}),
]