百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

Django框架结构剖析-扒开神秘的外衣

ccwgpt 2024-09-17 12:42 38 浏览 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 服务器的入口,以便运行你的项目

相关推荐

一个基于.Net Core遵循Clean Architecture原则开源架构

今天给大家推荐一个遵循CleanArchitecture原则开源架构。项目简介这是基于Asp.netCore6开发的,遵循CleanArchitecture原则,可以高效、快速地构建基于Ra...

AI写代码翻车无数次,我发现只要提前做好这3步,bug立减80%

写十万行全是bug之后终于找到方法了开发"提示词管理助手"新版本那会儿,我差点被bug整崩溃。刚开始两周,全靠AI改代码架构,结果十万行程序漏洞百出。本来以为AI说没问题就稳了,结果...

OneCode低代码平台的事件驱动设计:架构解析与实践

引言:低代码平台的事件驱动范式在现代软件开发中,事件驱动架构(EDA)已成为构建灵活、松耦合系统的核心范式。OneCode低代码平台通过创新性的注解驱动设计,将事件驱动理念深度融入平台架构,实现了业务...

国内大厂AI插件评测:根据UI图生成Vue前端代码

在IDEA中安装大厂的AI插件,打开ruoyi增强项目:yudao-ui-admin-vue31.CodeBuddy插件登录腾讯的CodeBuddy后,大模型选择deepseek-v3,输入提示语:...

AI+低代码技术揭秘(二):核心架构

本文档介绍了为VTJ低代码平台提供支持的基本架构组件,包括Engine编排层、Provider服务系统、数据模型和代码生成管道。有关UI组件库和widget系统的信息,请参阅UI...

GitDiagram用AI把代码库变成可视化架构图

这是一个名为gitdiagram的开源工具,可将GitHub仓库实时转换为交互式架构图,帮助开发者快速理解代码结构。核心功能一键可视化:替换GitHubURL中的"hub...

30天自制操作系统:第六天:代码架构整理与中断处理

1.拆开bootpack.c文件。根据设计模式将对应的功能封装成独立的文件。2.初始化pic:pic(可编程中断控制器):在设计上,cpu单独只能处理一个中断。而pic是将8个中断信号集合成一个中断...

AI写代码越帮越忙?2025年研究揭露惊人真相

近年来,AI工具如雨后春笋般涌现,许多人开始幻想程序员的未来就是“对着AI说几句话”,就能轻松写出完美的代码。然而,2025年的一项最新研究却颠覆了这一期待,揭示了一个令人意外的结果。研究邀请了16位...

一键理解开源项目:两个自动生成GitHub代码架构图与说明书工具

一、GitDiagram可以一键生成github代码仓库的架构图如果想要可视化github开源项目:https://github.com/luler/reflex_ai_fast,也可以直接把域名替换...

5分钟掌握 c# 网络通讯架构及代码示例

以下是C#网络通讯架构的核心要点及代码示例,按协议类型分类整理:一、TCP协议(可靠连接)1.同步通信//服务器端usingSystem.Net.Sockets;usingTcpListene...

从复杂到优雅:用建造者和责任链重塑代码架构

引用设计模式是软件开发中的重要工具,它为解决常见问题提供了标准化的解决方案,提高了代码的可维护性和可扩展性,提升了开发效率,促进了团队协作,提高了软件质量,并帮助开发者更好地适应需求变化。通过学习和应...

低代码开发当道,我还需要学习LangChain这些框架吗?| IT杂谈

专注LLM深度应用,关注我不迷路前两天有位兄弟问了个问题:当然我很能理解这位朋友的担忧:期望效率最大化,时间用在刀刃上,“不要重新发明轮子”嘛。铺天盖地的AI信息轰炸与概念炒作,很容易让人浮躁与迷茫。...

框架设计并不是简单粗暴地写代码,而是要先弄清逻辑

3.框架设计3.框架设计本节我们要开发一个UI框架,底层以白鹭引擎为例。框架设计的第一步并不是直接撸代码,而是先想清楚设计思想,抽象。一个一个的UI窗口是独立的吗?不是的,...

大佬用 Avalonia 框架开发的 C# 代码 IDE

AvalonStudioAvalonStudio是一个开源的跨平台的开发编辑器(IDE),AvalonStudio的目标是成为一个功能齐全,并且可以让开发者快速使用的IDE,提高开发的生产力。A...

轻量级框架Lagent 仅需20行代码即可构建自己的智能代理

站长之家(ChinaZ.com)8月30日消息:Lagent是一个专注于基于LLM模型的代理开发的轻量级框架。它的设计旨在简化和提高这种模型下代理的开发效率。LLM模型是一种强大的工具,可以...

取消回复欢迎 发表评论: