Django项目规范化(虚拟环境、目次布局、数据库权限、建表、Media、日志)
前言
调整Django项目目次是为了提高项目的可维护性、可扩展性、协作性,使组织布局更清楚,提高代码可读性,使开辟职员更清楚的明白和定位
调整后的目次
- ├── Project_api # 项目根路径
- ├── logs/ # 项目运行时/开发时产生的日志【软件包】
- ├── manage.py # 脚本文件
- ├── Project_api/ # 项目主应用,开发时的代码保存【软件包】
- ├── apps/ # 保存所有app的目录【软件包】
- ├── libs/ # 第三方类库的保存目录[第三方组件、模块]【软件包】
- ├── settings/ # 配置目录【软件包】
- ├── dev.py # 项目开发时的本地配置
- └── prod.py # 项目上线时的运行配置
- ├── asgi.py # 项目上线用
- ├── wsgi.py # 项目上线用
- ├── urls.py # 总路由
- └── utils/ # 多个模块[app]的公共函数类库[自己开发的组件]
-
- └── scripts/ # 保存项目运营时,测试的脚本文件【软件包】
复制代码 虚拟环境
在创建每个项目时都应该利用虚拟环境,使项目之间的依赖隔离,避免全局污染,并且便于后期的迁徙和分享,同时还能降低打包难度
pycharm创建虚拟环境
- 打开添加解释器页面
- 新建位置必须为一个空的文件夹
- 解释器选择本身的python解释器,必须是python.exe
- 创建完成后打开终端假如能看到括号就说明当前已经处于虚拟环境
创建Django项目
安装Django,版本看本身
- pip install django==4.2.12
复制代码 创建Django项目
- django-admin startproject PureDJProject
复制代码 默认的目次
调整目次布局
在主应用下创建apps、libs、settings、utils目次
- Django自创建的app会使目次变的复杂难懂,因此首先要将所有app创建进同一个目次下,目次名为apps
- # settings
- import sys,os
- BASE_DIR = Path(__file__).resolve().parent.parent
- apps = os.path.join(BASE_DIR,'apps')
- # 将apps和根路径添加进环境变量
- sys.path.insert(0,apps)
- sys.path.insert(0,str(BASE_DIR))
复制代码 现在的路径应该长这样
- 由于更改了环境变量,startapp会将路径选中在apps目次
- 所以路径也要切换到DjangoProject\DjangoProject\apps
- 现在创建app的语法就要酿成python ../../manage.py startapp user
- ../为上一级目次,也就是apps目次的上两级找到manage.py
创建完后如下:
在settings目次下创建dev(测试)和pro(上线)两个py文件代替原来的setting.py
- # 路径修改为settings下的dev文件
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'DjangoProject.settings.dev')
复制代码 启动django方式变更
方式1 手动启动
- 将路径移动到manage.py上一级的DjangoProject,然后启动python manage.py runserver
- D:\...\MyProject\DjangoProject\python manage.py runserver
复制代码 方式2 pycharm启动
- 打开右上角运行设置-添加django服务器-修改环境变量
- 新增一句DJANGO_SETTINGS_MODULE=terminal.settings.dev
- 这句话的意思实在就是manage.py中的settings路径
数据库规范
在现实开辟环境中,一般不会答应用root用户作为项目的数据库用户(因为权限太高,安全隐患重)
因此最好接纳多用户授权,每个数据库用户都有各自的权限和管理的库
创建用户语句
- # 1 创建项目库
- create database luffy default charset=utf8mb4;
- # 2 查看用户
- SELECT User, Host FROM mysql.user;
- # 3 创建用户
- CREATE USER 'luffy'@'localhost' IDENTIFIED BY '123'; # 创建本地连接权限的用户luffy,密码123
- CREATE USER 'luffy'@'%' IDENTIFIED BY '123'; # 创建远程连接权限的用户luffy,密码123
- GRANT ALL PRIVILEGES ON luffy.* TO 'luffy'@'localhost' WITH GRANT OPTION; # 允许luffy对luffy表进行本地操作
- GRANT ALL PRIVILEGES ON luffy.* TO 'luffy'@'%' WITH GRANT OPTION; # 允许luffy对luffy表进行远程操作
复制代码 本地开辟时我们常用固定值来定义数据库账号暗码
- DATABASES = {
- 'default': {
- 'ENGINE': 'django.db.backends.mysql',
- 'NAME': 'paple',
- 'HOST': '127.0.0.1',
- 'PORT': '3307',
- 'USER': 'user1',
- 'PASSWORD': '222',
- }
- }
复制代码
- 这实在是很不安全的,我们可以将账号暗码放入环境变量中
- settings中改成这样(记得重启pycharm)
- # 从环境变量中取出账号密码
- user = os.environ.get('MYSQL_USER')
- password = os.environ.get('MYSQL_PASSWORD')
- DATABASES = {
- 'default': {
- 'ENGINE': 'django.db.backends.mysql',
- 'NAME': 'paple',
- 'HOST': '127.0.0.1',
- 'PORT': '3307',
- 'USER': user,
- 'PASSWORD': password,
- }
- }
复制代码 创建用户表
扩写auth表
- # setting.py
- AUTH_USER_MODEL = 'user.UserLog'
复制代码 继承并扩写auth字段
- from django.db import models
- from django.contrib.auth.models import AbstractUser
- class UserLog(AbstractUser):
- mobile = models.CharField(max_length=11, null=True)
- # 需要pillow包的支持 pip install 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
复制代码 创建Media
- 与static不同,media需要我们手动开启
- 创建media目次,和icon/default.png
setting设置media路径
- # setting.py
- MEDIA_URL = '/media/'
- MEDIA_ROOT = os.path.join(BASE_DIR,'media')
复制代码 路由层注册media
- # urls.py
- from django.contrib import admin
- from django.urls import path
- from django.views.static import serve
- from django.conf import settings
- urlpatterns = [
- path('admin/', admin.site.urls),
- # 示例:127.0.0.1:8000/media/icon/default.png
- path('media/<path:path>', serve, {'document_root': settings.MEDIA_ROOT})
- ]
复制代码 此时欣赏器访问的起始就是我们主应用目次下的media目次路径
日志设置
- # setting.py
- # 项目上线后,日志文件打印级别不能过低,因为一次日志记录就是一次文件io操作
- 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': 'DEBUG',
- 'filters': ['require_debug_true'],
- 'class': 'logging.StreamHandler',
- 'formatter': 'simple'
- },
- 'file': {
- # 实际开发建议使用ERROR
- 'level': 'INFO',
- 'class': 'logging.handlers.RotatingFileHandler',
- # 日志位置,日志文件名,日志保存目录必须手动创建,注:这里的文件路径要注意BASE_DIR的位置
- '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, # 是否让日志信息继续冒泡给其他的日志处理系统
- },
- }
- }
复制代码- import logging
- logger = logging.getLogger('django')
- # 以后只需在其他py文件中导入logger就能主动输出/存储日志
- """
- 级别:
- DEBUG:最详细的日志级别,通常用于调试目的。可以记录所有详细信息,包括调试信息等。
- INFO:用于输出程序运行的重要信息。不如DEBUG详细,但比WARNING等级高。
- WARNING:用于表示可能出现问题的情况,但程序仍能正常运行。
- ERROR:指出发生了错误,但程序仍能继续运行。
- CRITICAL:最高级别的日志,表示严重的错误发生,可能导致程序无法继续运行。
- """
复制代码
- # 主路由 urls.py
- from django.contrib import admin
- from django.urls import path
- from django.views.static import serve
- from django.conf import settings
- from django.conf.urls import include
- urlpatterns = [
- path('admin/', admin.site.urls),
- path('media/<path:path>', serve, {'document_root': settings.MEDIA_ROOT}),
- # app路由
- path('api/v1/user/', include('user.urls'))
- ]
- # 子路由 apps/user/urls.py
- from django.urls import path
- from .views import LoggerView
- urlpatterns = [
- path('logger/', LoggerView.as_view()),
- ]
复制代码
- # apps/user/views.py
- from django.shortcuts import render
- from utils.common_logger import logger
- from rest_framework.views import APIView
- from rest_framework.response import Response
- class LoggerView(APIView):
- def get(self,request):
- logger.info('这是一条info级别日志')
- return Response('ok')
复制代码
成功
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |