Analyse der Django-Projektstruktur

Indem wir Djangos Projektstruktur verstehen, können wir Code effizienter organisieren, Djangos Best Practices befolgen und wartbare Webanwendungen erstellen.

Im vorherigen Kapitel haben wir gelernt, ... zu verwendendjango-admin startprojectWenn der Befehl ein neues Projekt erstellt, generiert Django automatisch die folgende Grundstruktur:
myproject/
│
├── manage.py
└── myproject/
    ├── __init__.py
    ├── settings.py
    ├── urls.py
    └── wsgi.py

Verwenden Sie django-admin, um das HelloWorld-Projekt zu erstellen:

django-admin startproject HelloWorld

Nach der Erstellung können wir die Verzeichnisstruktur des Projekts anzeigen:

Datei/VerzeichnisDetaillierte Beschreibung
manage.pyDas Kommandozeilen-Verwaltungstool für Django-Projekte, das ... kapseltdjango-adminFunktionalität und automatisch setztDJANGO_SETTINGS_MODULEDie Umgebungsvariable verweist auf die Konfiguration des aktuellen Projekts. Alle Projektverwaltungsbefehle werden darüber ausgeführt, wie zum Beispiel:
- runserver: Startet den Entwicklungsserver
- makemigrations: Datenbank-Migrationsdateien generieren
- shell: Python-Shell mit ORM starten
db.sqlite3Die standardmäßig von Django verwendete SQLite-Datenbankdatei, die nach der ersten Ausführung automatisch erstellt wirdmigrateSie wird nach dem Ausführen des Befehls automatisch erstellt. Sie eignet sich für Entwicklungsumgebungen; für die Produktion wird empfohlen, auf PostgreSQL/MySQL umzusteigen. Der Dateispeicherort wird bestimmt durchsettings.pyinDATABASES['default']['NAME']Definition.
__pycache__/Vom Python-Interpreter generiertes Bytecode-Cache-Verzeichnis mit.pycDatei, die zum Beschleunigen des Modulladens verwendet wird. Sie muss nicht in die Versionskontrolle eingecheckt werden (sollte in.gitignoreignoriert in).


Kern-Dateiparsing

manage.py

manage.pyist der Einstiegspunkt für das Kommandozeilen-Tool von Django-Projekten und bietet viele nützliche Befehle:

Beispiel

#!/usr/bin/env python
import os
import sys

if __name__ == "__main__":
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myproject.settings")
    try:
        from django.core.management import execute_from_command_line
    except ImportError:
        # Importfehler behandeln
        pass
    execute_from_command_line(sys.argv)

Beispiele für gängige Befehle:

  • python manage.py runserver- Entwicklungsserver starten
  • python manage.py migrate- Datenbankmigrationen anwenden
  • python manage.py createsuperuser- Ein Administratorkonto erstellen

settings.py

settings.pyist die Konfigurationsdatei für Django-Projekte, die alle wichtigen Einstellungen enthält:

Beispiel

# Wichtige Konfigurationselemente erklärt:
DEBUG = True  # Während der Entwicklung auf True setzen, um detaillierte Fehler anzuzeigen; in der Produktion muss der Wert auf False gesetzt werden.
ALLOWED_HOSTS = []  # Wenn DEBUG=False, müssen Sie die erlaubten Domains angeben (z. B. ['example.com'])

INSTALLED_APPS = [
    'django.contrib.admin',    # Admin-Verwaltung
    'django.contrib.auth',     # Authentifizierungssystem
    'django.contrib.contenttypes',  # Framework für Inhaltstypen
    'django.contrib.sessions', # Sitzungsverwaltung
    'django.contrib.messages', # Nachrichten-Framework
    'django.contrib.staticfiles',  # Verwaltung statischer Dateien
    # Benutzerdefinierte Anwendung kann hinzugefügt werden: 'myapp.apps.MyAppConfig'
]

DATABASES = {  # Datenbankkonfiguration
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',  # pathlib-Syntax verwenden
        # MySQL-Beispiel:
        # 'ENGINE': 'django.db.backends.mysql',
        # 'NAME': 'mydb',
        # 'USER': 'root',
        # 'PASSWORD': 'password',
    }
}

STATIC_URL = '/static/'  # URL-Präfix für statische Dateien
STATICFILES_DIRS = [BASE_DIR / 'static']  # Suchverzeichnis für statische Dateien in der Entwicklung
MEDIA_URL = '/media/'   # URL-Präfix für von Benutzern hochgeladene Dateien
MEDIA_ROOT = BASE_DIR / 'media'  # Speicherpfad für hochgeladene Dateien

urls.py (URL-Dispatcher)

Beispiel

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),  # Admin-Routen
    path('blog/', include('blog.urls')),  # URL-Routing der Unteranwendung
    # path('api/', include('api.urls', namespace='api')),
]
  • include(): Implementiert die Routing-Modularisierung, indem die Routen verschiedener Anwendungen in ihre jeweiligen urls.py-Dateien getrennt werden.
  • namespace: Wird verwendet, um Namenskonflikte beim Reverse-Auflösen von URLs zu vermeiden.

wsgi.py & asgi.py

DateiZweck
wsgi.pyWSGI (Web Server Gateway Interface)-Konfiguration, verwendet für traditionelle synchrone Server (wie Gunicorn, uWSGI). In der Produktion wird das Projekt über diese Datei gestartet.
asgi.pyASGI(Asynchronous Server Gateway Interface)-Konfiguration, unterstützt asynchrone Server (wie Daphne, Uvicorn). Wird für WebSocket- oder asynchrone Views verwendet.

Erweiterungsverzeichnis (nicht automatisch generiert, aber häufig verwendet)

HelloWorld/
├── apps/               # 推荐:存放所有自定义应用
│   └── blog/          # 示例应用
├── static/             # 静态文件(CSS/JS/图片)
├── media/              # 用户上传文件
├── templates/          # 全局模板目录
└── requirements.txt    # 项目依赖列表

1. apps/-Verzeichnis (empfohlene Struktur)

Anwendungen zentral verwalten und vermeiden, sie im Projektstammverzeichnis zu verstreuen.

Der Python-Pfad muss in settings.py konfiguriert werden:

import sys
sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))

2. Statische Dateien und Mediendateien

  • static/Speichert CSS, JavaScript, Bilder usw., auf die über STATIC_URL zugegriffen wird.

  • media/: Vom Benutzer hochgeladene Dateien (z. B. Avatare) sind über MEDIA_URL erreichbar. Der Server muss konfiguriert werden, um während der Entwicklung Zugriff bereitzustellen:

    # urls.py(仅开发环境)
    from django.conf import settings
    from django.conf.urls.static import static
    
    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

Django-Anwendungsstruktur

In Django kann ein Projekt mehrere Anwendungen enthalten. Mithilfe vonpython manage.py startapp myappNach dem Erstellen einer neuen Anwendung wird die folgende Struktur generiert:

myapp/
│
├── migrations/
│   └── __init__.py
├── __init__.py
├── admin.py
├── apps.py
├── models.py
├── tests.py
└── views.py

Hauptanwendungsdateien

models.py

Definiert Datenmodelle, die den Datenbanktabellen entsprechen:

Beispiel

from django.db import models

class Product(models.Model):
    name = models.CharField(max_length=100)
    price = models.DecimalField(max_digits=10, decimal_places=2)
    description = models.TextField()
   
    def __str__(self):
        return self.name

views.py

Geschäftslogik verarbeiten, Antworten zurückgeben:

Beispiel

from django.shortcuts import render
from .models import Product

def product_list(request):
    products = Product.objects.all()
    return render(request, 'myapp/product_list.html', {'products': products})

admin.py

Django-Admin-Backend konfigurieren:

Beispiel

from django.contrib import admin
from .models import Product

@admin.register(Product)
class ProductAdmin(admin.ModelAdmin):
    list_display = ('name', 'price')

Beispiel für eine vollständige Projektstruktur

Die vollständige Struktur eines typischen Django-Projekts sieht wie folgt aus:

myproject/
│
├── manage.py
├── requirements.txt
├── static/
│   ├── css/
│   ├── js/
│   └── images/
├── media/
├── templates/
│   └── base.html
└── myproject/
    ├── __init__.py
    ├── settings.py
    ├── urls.py
    ├── wsgi.py
    └── asgi.py
└── myapp1/
    ├── migrations/
    ├── templates/
    │   └── myapp1/
    ├── __init__.py
    ├── admin.py
    ├── apps.py
    ├── models.py
    ├── tests.py
    ├── urls.py
    └── views.py
└── myapp2/
    └── ... (类似结构)

Wichtige Verzeichnisbeschreibungen

migrations-Verzeichnis

Speichert Datenbank-Migrationsdateien. Django verwendet diese Dateien, um Modelländerungen zu verfolgen und sie mit der Datenbank zu synchronisieren.

static-Verzeichnis

Speichert statische Dateien (CSS, JavaScript, Bilder usw.), die während der Bereitstellung an einem festgelegten Ort gesammelt werden.

templates-Verzeichnis

Speichert HTML-Template-Dateien. Django verwendet die Template-Sprache, um Seiten dynamisch zu generieren.

media-Verzeichnis

Speichert von Benutzern hochgeladene Dateien, die in settings.py konfiguriert werden müssen:

Beispiel

MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

Übungsvorschläge

  1. Trennung von Projekt und Anwendung: Die Unabhängigkeit jeder Anwendung für einfache Wiederverwendung beibehalten
  2. Umgebungskonfiguration: Verwenden Sie unterschiedliche Einstellungsdateien, um Entwicklungs- und Produktionsumgebungen zu unterscheiden
  3. Verwaltung statischer DateienWird während der Entwicklung verwendetSTATICFILES_DIRSWird in der Produktion verwendetcollectstatic
  4. URL-Design: URLs auf Anwendungsebene definieren und sie dann auf Projektebene einbinden
  5. Template-OrganisationErstellen Sie für jede Anwendung ein Unterverzeichnis zum Speichern von Templates

Unterschiede zwischen Produktions- und Entwicklungsumgebungen

Datei/KonfigurationEntwicklungsumgebungProduktionsumgebung
DEBUGTrue(Fehlerdetails anzeigen)False(Fehler ausblenden, in Datei protokollieren)
DatenbankSQLite (Standard)PostgreSQL/MySQL (Leistungsoptimierung)
Statische DateienrunserverAutomatischer DienstNutzungcollectstaticZum CDN sammeln
ALLOWED_HOSTSLeere Liste oder['localhost']Muss die Domain konfigurieren (z. B.['example.com'])
Weitere Erweiterungen