Django框架结构剖析-扒开神秘的外衣
ccwgpt 2024-09-17 12:42 35 浏览 0 评论
众所周知:
Django 本身基于 MVC 模型,即 Model(模型)+ View(视图)+ Controller(控制器)设计模式,MVC 模式使后续对程序的修改和扩展简化,并且使程序某一部分的重复利用成为可能。
奉上Django结构案例
project_name
|-- prometheus #项目应用,即Controller部分,一个项目可以有多个应用
| |-- asgi.py
| |-- select.py
| |-- __pycache__
| |-- urls.py
| |-- views.py
| |-- wsgi.py
| |-- __init__.py
| |-- settings.py
|-- templates #模板,即View部分
| | -- index.html
|-- PgModel #表结构定义,即Model部分
| |-- admin.py
| |-- apps.py
| |-- __init__.py
| |-- migrations
| |-- models.py
| |-- views.py
| |-- __pycache__
|-- manage.py
|-- uwsgi_params
项目结构说明
manage.py
和项目的交互基本都是基于这个文件。一般都是在终端输入python manage.py [子命令]。可以输入python manage.py help看下能做什么事情。一般情况下不应该编辑这个文件。
DJANGO_SETTINGS_MODULE: 告诉Django使用哪个配置文件,示例为使用prometheus下的settings.py配置:
settings.py
保存项目所有的配置信息。所有和项目相关的配置都保存在里面。
部分配置参数说明如下:
BASE_DIR:
默认值os.path.dirname(os.path.dirname(os.path.abspath(file)))。这个是Django项目文件夹所在目录得绝对路径,一般不要修改。
DEBUG:
默认值是True。在本地开发测试环境下设置DEBUG=True可以显示bug信息,便于开发者找出代码错误所在。当你在部署项目在生产环境时,请务必设置DEBUG=False。因为生成环境下打开Debug会暴露很多敏感设置信息(比如数据库密码)。注意: 当你设置DEBUG=False, 你一定要设置ALLOWED_HOSTS选项, 否则会抛出异常。
ALLOWED_HOSTS:
默认值为空[]。设置ALLOWED_HOSTS是为了限定用户请求中的host值,以防止黑客构造包来进行头部攻击。该选项正确设置方式如下:
DEBUG=True: ALLOWED_HOSTS可以为空,也可设置为[‘127.0.0.01’, ‘localhost’]
DEBUG=False: ALLOWED_HOSTS=[‘46.124.78.xx’, ‘www.bat.com’,‘127.0.0.1’]
当你关闭DEBUG时,HOST一般为服务器公网IP或者注册域名。 当你还需要使用子域名时,你可以用’.bat.com’。它将匹配bat.com, www.bat.com和news.bat.com。在正式部署项目时,请尽量不要设置ALLOWED_HOSTS=[’*’]。
SECRET_KEY:
SECRET_KEY是Django根据自己算法生成的一大串随机数,本质是个加密盐,用于防止CSRF(Cross-site request forgery)跨站请求伪造攻击。当部署Django项目到生产环境中时,Django文档建议不直接在settings.py里输入字符串,而是采取下面两种方法读取SECRET_KEY。
方法一: 从环境变量中读取SECRET_KEY
import os
SECRET_KEY = os.environ['SECRET_KEY']
方法二: 从服务器上Django项目文件价外的某个文件读取
with open('/etc/secret_key.txt') as f:
SECRET_KEY = f.read().strip()
INSTALLED_APPS:
这个设置比较简单,也比较常用,用于增删一个项目(Project)所包含的应用(APP)。只有对列入此项的APP, Django才会生成相应的数据表。
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'PgModel', # 自定义的APP
]
AUTH_USER_MODEL:
默认为auth.user。也可以为自定义用户模型。
STATIC_ROOT和STATIC_URL、STATICFILES_DIRS:
STATIC_URL仅在开发环境有效,原因是开发环境一般是通过python manage.py run project启动,此时静态文件不借助于任何外部代理工具。设置后可以通过使用{% static ‘img/xxx.jpg’ %}方式直接访问/static/文件夹里的静态文件。
生产环境由于使用nginx代理静态文件,所以可不设置STATIC_URL。
当设置了STATIC_ROOT, 运行"python manage.py collectstatic"命令的时候,Django会将各app下所有名为static的文件夹及其子目录以及STATICFILES_DIRS下的文件夹及其子目录复制收集到STATIC_ROOT。把静态文件集中一起的目的是为了更方便地通过Apache或Nginx部署。
这三个参数配置如下,一般情况下我们会尽量把静态文件统一放在STATICFILES_DIRS文件夹:
STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')
STATICFILES_DIRS = [
"/home/user/pictures",
"/opt/webfiles/myfiles",
]
STATICFILES_DIRS告诉django,首先到STATICFILES_DIRS里面寻找静态文件,其次再到各个app的static文件夹里面找。
注意:
django查找静态文件是惰性查找,查找到第一个,就停止查找了。经测试发现只有STATICFILES_DIRS未定义的时候,才会去各个app的static文件夹里面找。
MEDIA_ROOT和MEDIA_URL:
media文件夹一般用于放置用户上传的文件。对于此文件夹的权限设置异常重要,因为用户可能会上传可执行的文件,影响网站和服务器的安全。我们后续会专题介绍文件上传过程中应考虑的安全因素。
MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
国际化(语言与时间):
TIME_ZONE = 'Asia/Shanghai' # 设置时区
USE_I18N = True # 默认为True,是否启用自动翻译系统
USE_L10N = True # 默认False,以本地化格式显示数字和时间
USE_TZ = False # 默认值True。若使用了本地时间,必须设为False
邮箱服务配置:
EMAIL_HOST = 'smtp.qq.com' # 发送者邮箱服务器
EMAIL_PORT = 25 # 端口
EMAIL_HOST_USER = '' # 发送者用户名(邮箱地址)
EMAIL_HOST_PASSWORD = '' # 发送者密码
EMAIL_USE_SSL = True
DEFAULT_FROM_EMAIL = 'xxx@qq.com'
数据库设置:
当这里不建议在settings.py直接写入数据库密码,而是采取读取外部配置文件的方式,更安全。下面以MYSQL为例介绍了基本配置方式。
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql', # 数据库引擎
'NAME': 'mydb', # 你要存储数据的库名,事先要创建之
'USER': 'xxs', # 数据库用户名
'PASSWORD': 'xxxx', # 密码
'HOST': 'localhost', # 主机
'PORT': '3306', # 数据库使用的端口
'OPTIONS': {
'options': '-c search_path=prometheus' #默认模式名
}
}
}
views.py
可以定义传参或者不传参,示例如下:
def login(request):
# 函数体省略
...
def login(request, username, password):
# 函数体省略
...
urls.py
用来做url与视图函数映射的。以后来了一个请求,就会从这个文件中找到匹配的视图函数。
在Django 1.1.x版本中,使用url方法配置路由。
urlpatterns = [
url(正则表达式, view函数, 参数, 别名)
]
在Django 2.2.x之后的版本,可以使用path和re_path两个方法配置路由。
path()方法用于普通路径,不需要自己手动添加正则首位限制符号,底层已经添加。
而re_path()方法用于正则路径,需要自己手动添加正则首位限制符号。
urlpatterns = [
re_path(正则表达式, view函数, 参数, 别名)
]
或
urlpatterns = [
path(路径, view函数, 参数, 别名)
]
示例如下:
path('login/', views.login, name='login'),
re_path(r'login/(?P<username>\d+)&(?P<password>\d+)', views.login, name='login'),
这里的username和password就是输入到views.py的参数,可以看出,两个都是数字构成的数字串。
能够调用views.py的地方只有一个,那就是urls.py。
wsgi.py
一个 WSGI 兼容的 Web 服务器的入口,以便运行你的项目。
migrations
第一次初始化数据库后会将django系统元数据信息保留在该文件夹下,后续每次初始化或更新数据库都会与该文件夹里的表结构做比对。所以即使删除数据库的表,每次执行python3 manage.py makemigrations依然会与文件夹中存储的历史数据库表结构进行比对。
models.py
关于models.py中的__str__
只是用于进行网页显示的。举例如:
class Details(models.Model):
heart_rate = models.FloatField(default=0)
date_added = models.DateTimeField(auto_now=True)
user = models.ForeignKey(User, on_delete=models.CASCADE)
def __str__(self):
result = [self.heart_rate, self.date_added]
return str(result)
效果如下图:
调整如下:
def __str__(self):
result = self.heart_rate
return str(result)
效果如下图:
init.py
一个空文件,告诉 Python 该目录是一个 Python 包。
asgi.py
一个 ASGI 兼容的 Web 服务器的入口,以便运行你的项目
相关推荐
- 如何基于Spring Security框架实现权限管理
-
SpringSecurity是一个功能强大且高度可定制的身份验证和访问控制框架,用于保护基于Spring的应用程序。SpringSecurity主要是从两个方面解决安全性问题:web请求级别:使...
- 一个轻量级 Java 权限认证框架,Sa-Token 让鉴权变得简单、优雅!
-
一、框架介绍Sa-Token是一个轻量级Java权限认证框架,主要解决:登录认证、权限认证、单点登录、OAuth2.0、分布式Session会话、微服务网关鉴权等一系列权限相关问题。官网文档:...
- 16.3K Star!简洁高效的Java权限认证与会话管理框架——Sa-Token
-
简介今天给大家推荐一个轻量级的Java权限认证框架——Sa-Token。它可以为JavaWeb应用同完整的权限认证解决方案,它的目标是简化权限管理和登录认证的流程,具备高度灵活性和简单易用的特点。S...
- 从Shiro迁移到Sa-Token:老版JeecgBoot项目权限框架平滑升级方案
-
背景介绍对于许多维护老版JeecgBoot项目的开发者来说,权限框架的升级一直是个棘手问题。这篇文章分享一种实用的方案,用于将老版JeecgBoot中的ApacheShiro替换为更现代的Sa-To...
- 刑法框架体系,对照着框架体系学习可以事半功倍哦
-
有了它,妈妈再也不用担心我司考过不啦!有了它,妈妈再也不用担心我司考过不了啦!其他部门法正在陆续整理制作中哦看不清的话请戳http://mp.weixin.qq.com/s?__biz=MzA3NDE...
- 全新体验版Windows QQ上线,实现三端统一
-
7月3日,全新体验版WindowsQQ正式上线官网,面向用户开放官方下载渠道。记者从腾讯获悉,继QQ对macOS、Linux版本进行升级后,本次Windows版本的更新,标志QQ基于NT技术架构...
- 农村自建房造价多少?包工头教你怎么算
-
通常我们在找专业人士设计农村自建房设计图时,不管你是打算建独栋一层别墅还是独栋二层别墅或是独栋三层别墅,你是否也找他们打听过相应的房屋工程造价呢?下面简单介绍一下农村自建房的傻瓜式造价估算:1、砖混结...
- QQ大会员品牌运营策划与设计(qq大会员有哪些个性装扮)
-
编辑导语:在互联网产品越来越同质化的今天,做出有差异性和符合品牌调性的设计是品牌运营过程中需要重视的问题。本文作者从QQ大会员品牌项目实践出发,分享了品牌运营设计过程中遇到的一些问题以及具体操作方案,...
- 支持鸿蒙平台,腾讯视频ovCompose跨平台框架发布
-
IT之家6月3日消息,腾讯开源今日官宣发布腾讯视频ovCompose跨平台框架,其是腾讯大前端领域Oteam中,腾讯视频团队基于ComposeMultiplatform生态推出的...
- 腾讯 QQ Mac 版推倒重做,全新 1.0 版本开启内测
-
IT之家9月1日消息,据多位IT之家小伙伴投稿,腾讯QQMac版近日迎来了全新通用版内测,版本号重新由1.0开始,目前放出的体验版为1.0.4-305。从下图可以看到,该版本在U...
- 全新体验版Windows QQ正式上线官网,实现三端统一
-
7月3日,全新体验版WindowsQQ正式上线官网,面向用户开放官方下载渠道。记者从腾讯获悉,继QQ对macOS、Linux版本进行升级后,本次Windows版本的更新,标志QQ基于NT技术架构...
- QQ,到了不能不变的境地(怎么发qq邮件到别人邮箱)
-
相比微信一个小更新,乃至一个小动作,都能上热搜的顶级热度。隔壁的老大哥QQ,显得有些冷清。即使更新再快,功能再激情,都很难引起用户们的集体讨论。机友们细想一番,咱们的老朋友QQ,有多久没上过热搜啦?真...
- 基于Electron框架全面重做:全新Linux版QQ开启公测
-
来源:快科技不久前,腾讯QQ项目组曾发布预告,宣布QQforLinux新版本即将开启公测。现在,新的Linux版QQ已经开启公测,不过目前仅支持x86架构,arm64架构还仍在适配中。与此前极为简...
- QQ全面升级?基于Electron技术的Windows内测版本预计将于明年推出
-
在2022年,作为经典的聊天软件的QQ在经历多次的功能调整后,正式选择基于新技术开发新版本的QQ。今日,据相关媒体报道,腾讯QQ项目组发布预告:QQforLinux将在本周迎来公测,全新的QQf...
- 跨平台三端重构正式统一,QQ Windows全新体验版上架官网
-
7月3日,全新体验版WindowsQQ正式上线官网,面向用户开放官方下载渠道。继QQ对macOS、Linux版本进行升级后,本次Windows版本的更新,标志QQ基于NT技术架构,实现了桌面端Q...
你 发表评论:
欢迎- 一周热门
- 最近发表
-
- 如何基于Spring Security框架实现权限管理
- 一个轻量级 Java 权限认证框架,Sa-Token 让鉴权变得简单、优雅!
- 16.3K Star!简洁高效的Java权限认证与会话管理框架——Sa-Token
- 从Shiro迁移到Sa-Token:老版JeecgBoot项目权限框架平滑升级方案
- 刑法框架体系,对照着框架体系学习可以事半功倍哦
- 全新体验版Windows QQ上线,实现三端统一
- 农村自建房造价多少?包工头教你怎么算
- QQ大会员品牌运营策划与设计(qq大会员有哪些个性装扮)
- 支持鸿蒙平台,腾讯视频ovCompose跨平台框架发布
- 腾讯 QQ Mac 版推倒重做,全新 1.0 版本开启内测
- 标签列表
-
- MVC框架 (46)
- spring框架 (46)
- 框架图 (58)
- flask框架 (53)
- quartz框架 (51)
- abp框架 (47)
- jpa框架 (47)
- laravel框架 (46)
- springmvc框架 (49)
- 分布式事务框架 (65)
- scrapy框架 (56)
- shiro框架 (61)
- 定时任务框架 (56)
- java日志框架 (61)
- JAVA集合框架 (47)
- grpc框架 (55)
- ppt框架 (48)
- 内联框架 (52)
- winform框架 (46)
- gui框架 (44)
- cad怎么画框架 (58)
- ps怎么画框架 (47)
- ssm框架实现登录注册 (49)
- oracle字符串长度 (48)
- oracle提交事务 (47)