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

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

ccwgpt 2024-09-17 12:42 27 浏览 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版本众多,傻傻分不清楚

面对.NET众多的版本,尤其还有几个名称的情况下,相信很多初学C#的开发人员都很困惑,搞不清究竟该怎么选择。下面就列举一下.NET的主要版本及其区别:.NETFramework(传统版本,仅适用于W...

.NET Framework 和 .NET Core 有啥区别?如何选择?

.NETFramework和.NETCore都是由Microsoft开发的软件框架,用于创建Windows应用程序和Web应用程序。它们的主要区别在于:支持的操作系统:.NET...

「分享」介绍一款倍受欢迎的.NET 开源UI库

概述今天要带大家了解的是一款WPF的开源控件库MahApps.Metro。MahApps.Metro是用于创建现代WPF应用程序的工具包,它许多开箱即用的好东西。目前支持的NETFramework...

.NET 5.0正式版发布:应用可在ARM64上原生运行

更多:o梵蒂冈图书馆频繁遭黑客攻击oNPM包被发现窃取敏感的Discord和浏览器文件o作者:硬核老王o(本文字数:712,阅读时长大约:1分钟).NET5.0正式版发布:应用可...

盘点8个热门.Net开源项目

一、SmartFormat:轻量级文本模板库,轻松替代string.Format项目地址:https://github.com/axuno/SmartFormatSmartFormat不仅继承了s...

.NET与Java开发:一场从框架到应用实例的深度对决

在软件开发这片广袤的战场上,.NET与Java两大开发平台如同两位身经百战的将军,各自率领着庞大的开发者队伍,在不同的应用场景中大放异彩。今天,我们就来一场从框架到应用实例的深度对决,看看这两大平台究...

TouchSocket:一个功能强大且易于使用的 .NET 网络通信框架

项目介绍TouchSocket是一个功能强大且易于使用的.NET网络通信框架,适用于C#、VB.Net和F#等语言。它提供了多种通信模块,包括TCP、UDP、SSL、WebSocket、Mo...

远离报错烦恼!深入全面掌握.NET Framework

由于Windows系统对.NETFramework这一系统组件有着极为特殊的要求,而部分应用软件及游戏对其的依赖性也近乎达到了驱动级的水准,使用或安装不当会遭遇许多“未知”的问题,因此如何掌握.NE...

想自己搭建.Net Web框架,开源项目太庞大看不懂,可以看这个教程

大家好,我是编程乐趣。一直以来,我都在运营知识星球,这个月也开始全职专心编写教程了。当时编写教程,就是发现很多程序员工作多年了,都没自己搭建过框架,也没接触过公司的框架底层代码。这就导致一些问题,无法...

.NET 8 + React 18 一体化开发框架!苏州码农十年匠心打磨

开篇前言从2014年入行至今,从WebForms到MVC,从JavaScript到React/Vue,从.NETFramework到.NETCore/8,技术栈的变迁伴随了我整个职业生涯。去年,我...

.Net Framework详解

相信有不少小伙伴遇到过这种情况:安装软件时提示.NetFramework未安装导致软件无法打开,或者需要安装.NetFramework4.0以上的组件。那.NetFramework是什么呢?....

系统小技巧:深入全面掌握.NET Framework

由于Windows系统对.NETFramework这一系统组件有着极为特殊的要求,而部分应用软件及游戏对其的依赖性也近乎达到了驱动级的水准,使用或安装不当会遭遇许多“未知”的问题,因此如何掌握.NE...

前端架构师成长之路:如何在 Vue 的计算属性中传递参数

在Vue中,计算属性(computed)是从其他响应式属性派生的属性,是用于自动监听响应式属性的变化,从而动态计算返回值。计算属性(computed)通常是一个没有参数的函数。当然如果需要像调...

Vue2 vs Vue3:核心差异与升级指南

Vue3自2020年发布以来,凭借其革命性的改进迅速成为开发者关注的焦点。本文将从架构设计、API模式、性能优化等多个维度深入对比Vue2和Vue3的核心差异,并提供代码示例帮助开发者...

突发!Vue3 投屏神器引爆程序员朋友圈

【AlarmLevel】重要【AlarmTitle】突发!Vue3投屏神器引爆程序员朋友圈【AlarmOverview】最近GitHub上名为vue-screen-share的仓库突...

取消回复欢迎 发表评论: