php中文网

姜戈 |项目结构|第 1 部分

php中文网

Django 默认的项目结构组织文件和文件夹,帮助开发人员高效管理代码。以下是创建新 Django 项目时典型文件结构的细分:

  1. 项目根文件夹

当您启动一个新的 Django 项目时,它会生成一个以项目命名的根文件夹(例如 my_project/)。该文件夹包含整个项目文件。

  1. 管理.py

此脚本充当与 Django 项目交互的命令行实用程序。您可以运行启动开发服务器、进行迁移、创建超级用户等命令。

用法:

python manage.py runserver
python 管理.py 迁移
python manage.py createsuperuser

  1. 项目子目录 (my_project/)

项目根目录中的子目录,包含 Django 项目的核心设置和配置。

它通常与您的项目具有相同的名称。

项目子目录中的文件:

  1. init.py

一个空文件,告诉 Python 将此目录视为一个包。它允许您导入项目中的其他模块。

  1. settings.py

包含 Django 项目的所有配置设置,例如数据库连接、安装的应用程序、中间件、模板、静态文件等。

您可以通过将此文件拆分为多个设置文件(例如,settings_dev.py、settings_prod.py)来自定义不同环境(开发、暂存、生产)的设置。

  1. urls.py

中央 URL 配置文件。它将 URL 映射到各自的视图。您可以通过导入将其他 URL 配置包含在此处,从而更轻松地管理大型项目。

  1. wsgi.py

代表“Web 服务器网关接口”。该文件用于将项目部署到生产 Web 服务器。它充当 Web 服务器的入口点来为您的 Django 应用程序提供服务。

  1. asgi.py

代表“异步服务器网关接口”。它与 wsgi.py 类似,但它用于处理异步 Web 请求(对 WebSockets、HTTP2 等有用)。

  1. 应用程序文件夹 (my_app/)

应用程序是 Django 项目中可重用的模块。每个应用程序通常处理项目功能的特定部分(例如用户、博客、商店)。

您可以使用以下方式创建新应用:

python manage.py startapp my_app

应用程序文件夹中的文件:

  1. init.py

将目录作为包,让 Python 将其识别为模块。

  1. admin.py

包含用于自定义此应用程序的 Django 管理界面的代码。您可以定义如何在管理面板中呈现和管理模型。

  1. apps.py

存储应用程序的配置,例如应用程序的名称和任何自定义行为。它是在生成应用程序时自动创建的。

  1. models.py

为您的应用定义数据模型(表)。当您运行迁移时,Django 会自动根据这些模型创建表。

  1. views.py

包含处理网络请求和返回响应的逻辑。视图与模型、模板和其他组件交互。

  1. 测试.py

用于为应用程序编写单元测试。编写测试以确保您的应用程序按预期工作是一个很好的做法。

  1. urls.py

定义特定于应用程序的 URL 模式。这些可以包含在主 urls.py 中以保持 URL 配置模块化。

  1. 迁移/

存储跟踪模型更改的迁移文件。迁移用于自动更新数据库架构。

  1. 静态/

存储静态文件,例如 CSS、JavaScript 以及与应用程序相关的图像。它们与您的应用程序代码分开提供。

  1. 模板/

包含应用程序的 HTML 模板。您可以创建子文件夹来更好地组织模板(例如 templates/my_app/index.html)。

  1. 其他重要文件夹

  2. static/(全局静态文件夹)

存储不与特定应用程序绑定的静态文件(CSS、JavaScript、图像)。在部署期间,从每个应用程序的 static/ 目录收集静态文件并将其提供给客户端。

  1. templates/(全局模板文件夹)

存储在整个项目中使用的模板的中心位置。这有利于共享布局和组件。

  1. 媒体/

存储用户上传的文件。确保配置您的settings.py以正确提供媒体文件。

项目结构示例:

我的_项目/

├── 管理.py
├── my_project/ # 项目子目录
│ ├── init.py
│ ├── settings.py
│ ├── urls.py
│ ├── wsgi.py
│ └── asgi.py

├── my_app/ # 一个示例应用程序
│ ├── init.py
│ ├── admin.py
│ ├── apps.py
│ ├── models.py
│ ├──views.py
│ ├── urls.py
│ ├── 测试.py
│ ├── 迁徙/
│ ├── 静态/
│ └── 模板/

├── static/ # 全局静态文件
│ └── css/
│ └── js/

└── templates/ # 全局模板
└── base.html
└──index.html

这种结构有助于让您的项目井然有序、可扩展且易于维护。

以上就是姜戈 |项目结构|第 1 部分的详细内容,更多请关注php中文网其它相关文章!