Django项目规范化(虚拟环境、目录结构、数据库权限、建表、Media、日志)

本文主要是介绍Django项目规范化(虚拟环境、目录结构、数据库权限、建表、Media、日志),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Django项目规范化(虚拟环境、目录结构、数据库权限、建表、Media、日志)

目录

  • Django项目规范化(虚拟环境、目录结构、数据库权限、建表、Media、日志)
    • 前言
    • 虚拟环境
      • pycharm创建虚拟环境
    • 创建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创建虚拟环境

image-20240509194445879

image-20240509194540519

  • 打开添加解释器页面
  • 新建位置必须为一个空的文件夹
  • 解释器选择自己的python解释器,必须是python.exe

image-20240509194615166

  • 创建完成后打开终端如果能看到括号就说明当前已经处于虚拟环境

创建Django项目

安装Django,版本看自己

pip install django==4.2.12

创建Django项目

django-admin startproject PureDJProject

默认的目录

image-20240226215319531

调整目录结构

  • 在主应用下创建apps、libs、settings、utils目录
  • Django自创建的app会使目录变的复杂难懂,因此首先要将所有app创建进同一个目录下,目录名为apps
# settings
import sys,osBASE_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))

现在的路径应该长这样

image-20240510084241973

  • 由于更改了环境变量,因此startapp会将路径选中在apps目录
  • 现在创建app的语法就要变成python ../../manage.py startapp user
  • ../为上一级目录,也就是apps目录的上两级找到manage.py

创建完后如下:

数据库规范

在实际开发环境中,一般不会允许用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',}
}
  • 这其实是很不安全的,我们可以将账号密码放入环境变量中

image-20240509204908388

  • 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 AbstractUserclass UserLog(AbstractUser):mobile = models.CharField(max_length=11, null=True)# 需要pillow包的支持 pip install pillowicon = models.ImageField(upload_to='icon', default='icon/default.png')class Meta:db_table = 'luffy_user'verbose_name = '用户表'verbose_name_plural = verbose_namedef __str__(self):return self.username

创建Media

  • 与static不同,media需要我们手动开启
  • 创建media目录,和icon/default.png

image-20240510085042087

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 settingsurlpatterns = [path('admin/', admin.site.urls),# 示例:127.0.0.1:8000/media/icon/default.pngpath('media/<path:path>', serve, {'document_root': settings.MEDIA_ROOT})
]

此时浏览器访问的起始就是我们主应用目录下的media目录路径

image-20240509214111522

日志配置

# 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 logginglogger = 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 includeurlpatterns = [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 LoggerViewurlpatterns = [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 Responseclass LoggerView(APIView):def get(self,request):logger.info('这是一条info级别日志')return Response('ok')

image-20240509220117705

成功

这篇关于Django项目规范化(虚拟环境、目录结构、数据库权限、建表、Media、日志)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/986035

相关文章

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

怎样通过分析GC日志来定位Java进程的内存问题

《怎样通过分析GC日志来定位Java进程的内存问题》:本文主要介绍怎样通过分析GC日志来定位Java进程的内存问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、GC 日志基础配置1. 启用详细 GC 日志2. 不同收集器的日志格式二、关键指标与分析维度1.

解读GC日志中的各项指标用法

《解读GC日志中的各项指标用法》:本文主要介绍GC日志中的各项指标用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、基础 GC 日志格式(以 G1 为例)1. Minor GC 日志2. Full GC 日志二、关键指标解析1. GC 类型与触发原因2. 堆

深度解析Java项目中包和包之间的联系

《深度解析Java项目中包和包之间的联系》文章浏览阅读850次,点赞13次,收藏8次。本文详细介绍了Java分层架构中的几个关键包:DTO、Controller、Service和Mapper。_jav... 目录前言一、各大包1.DTO1.1、DTO的核心用途1.2. DTO与实体类(Entity)的区别1

MySQL数据库中ENUM的用法是什么详解

《MySQL数据库中ENUM的用法是什么详解》ENUM是一个字符串对象,用于指定一组预定义的值,并可在创建表时使用,下面:本文主要介绍MySQL数据库中ENUM的用法是什么的相关资料,文中通过代码... 目录mysql 中 ENUM 的用法一、ENUM 的定义与语法二、ENUM 的特点三、ENUM 的用法1

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

mysql中的数据目录用法及说明

《mysql中的数据目录用法及说明》:本文主要介绍mysql中的数据目录用法及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、背景2、版本3、数据目录4、总结1、背景安装mysql之后,在安装目录下会有一个data目录,我们创建的数据库、创建的表、插入的

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置(1)、下载安装SQLite库(2)、解压下载的文件(3)、

如何在Spring Boot项目中集成MQTT协议

《如何在SpringBoot项目中集成MQTT协议》本文介绍在SpringBoot中集成MQTT的步骤,包括安装Broker、添加EclipsePaho依赖、配置连接参数、实现消息发布订阅、测试接口... 目录1. 准备工作2. 引入依赖3. 配置MQTT连接4. 创建MQTT配置类5. 实现消息发布与订阅