django 多級項目目錄的示例代碼
更新時間:2025年07月16日 09:55:01 作者:alden_ygq
本文主要介紹了django 多級項目目錄的示例代碼,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
一、項目初始化
1. 創(chuàng)建虛擬環(huán)境并安裝依賴
# 創(chuàng)建虛擬環(huán)境 python3 -m venv env source env/bin/activate # 安裝依賴 pip install django python-decouple
2. 創(chuàng)建項目和基礎(chǔ)結(jié)構(gòu)
# 創(chuàng)建項目根目錄 mkdir myproject cd myproject # 創(chuàng)建配置目錄 mkdir config django-admin startproject myproject config --template=https://github.com/django-templates/django-project-template/archive/master.zip --name=Dockerfile,.env.example # 創(chuàng)建應(yīng)用目錄 mkdir apps cd apps django-admin startapp core django-admin startapp users cd .. # 創(chuàng)建其他目錄 mkdir libs static media templates scripts tests touch .gitignore
二、項目目錄結(jié)構(gòu)
myproject/ # 項目根目錄 ├── config/ # 項目配置目錄 │ ├── __init__.py │ ├── settings/ # 配置文件按環(huán)境分離 │ │ ├── __init__.py │ │ ├── base.py # 基礎(chǔ)配置 │ │ ├── dev.py # 開發(fā)環(huán)境配置 │ │ └── prod.py # 生產(chǎn)環(huán)境配置 │ ├── urls.py # 項目URL配置 │ └── wsgi.py # WSGI應(yīng)用配置 ├── apps/ # 自定義應(yīng)用目錄 │ ├── core/ # 核心功能應(yīng)用 │ │ ├── migrations/ │ │ ├── __init__.py │ │ ├── admin.py │ │ ├── apps.py │ │ ├── models.py │ │ ├── tests.py │ │ ├── urls.py │ │ └── views.py │ └── users/ # 用戶管理應(yīng)用 ├── libs/ # 自定義庫目錄 │ └── utils/ # 工具函數(shù) ├── static/ # 靜態(tài)文件目錄 ├── media/ # 上傳文件目錄 ├── templates/ # 模板文件目錄 ├── scripts/ # 腳本文件目錄 ├── tests/ # 測試目錄 ├── .env.example # 環(huán)境變量示例 ├── .gitignore # Git忽略規(guī)則 ├── manage.py # Django管理腳本 └── requirements.txt # 依賴包列表
三、配置文件實現(xiàn)
1. 環(huán)境變量管理(.env.example)
# .env.example SECRET_KEY=your-secret-key-here DEBUG=True ALLOWED_HOSTS=localhost,127.0.0.1
2. 配置文件分層(config/settings/)
# config/settings/base.py from decouple import config from pathlib import Path BASE_DIR = Path(__file__).resolve().parent.parent.parent SECRET_KEY = config('SECRET_KEY') DEBUG = config('DEBUG', default=False, cast=bool) ALLOWED_HOSTS = config('ALLOWED_HOSTS', default='', cast=lambda v: [s.strip() for s in v.split(',')]) INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'apps.core', 'apps.users', ] MIDDLEWARE = [ 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', ] ROOT_URLCONF = 'config.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [BASE_DIR / 'templates'], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'config.wsgi.application' DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': BASE_DIR / 'db.sqlite3', } } AUTH_PASSWORD_VALIDATORS = [ { 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', }, { 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', }, { 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', }, { 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', }, ] LANGUAGE_CODE = 'zh-hans' TIME_ZONE = 'Asia/Shanghai' USE_I18N = True USE_L10N = True USE_TZ = True STATIC_URL = '/static/' STATICFILES_DIRS = [BASE_DIR / 'static'] MEDIA_URL = '/media/' MEDIA_ROOT = BASE_DIR / 'media' DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
# config/settings/dev.py from .base import * DEBUG = True SECRET_KEY = 'development-secret-key' ALLOWED_HOSTS = ['*'] INSTALLED_APPS += [ 'debug_toolbar', ] MIDDLEWARE += [ 'debug_toolbar.middleware.DebugToolbarMiddleware', ] INTERNAL_IPS = [ '127.0.0.1', ] # 開發(fā)環(huán)境數(shù)據(jù)庫配置 DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': BASE_DIR / 'db.sqlite3', } }
# config/settings/prod.py from .base import * DEBUG = False # 生產(chǎn)環(huán)境需要從環(huán)境變量獲取敏感信息 SECRET_KEY = config('SECRET_KEY') ALLOWED_HOSTS = config('ALLOWED_HOSTS', cast=lambda v: [s.strip() for s in v.split(',')]) # 生產(chǎn)環(huán)境數(shù)據(jù)庫配置 DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'NAME': config('DB_NAME'), 'USER': config('DB_USER'), 'PASSWORD': config('DB_PASSWORD'), 'HOST': config('DB_HOST'), 'PORT': config('DB_PORT'), } } # 生產(chǎn)環(huán)境靜態(tài)文件配置 STATIC_ROOT = BASE_DIR / 'staticfiles' # 安全配置 SECURE_SSL_REDIRECT = True SESSION_COOKIE_SECURE = True CSRF_COOKIE_SECURE = True SECURE_HSTS_SECONDS = 31536000 SECURE_HSTS_INCLUDE_SUBDOMAINS = True SECURE_HSTS_PRELOAD = True
四、核心應(yīng)用實現(xiàn)
1. 核心模型(apps/core/models.py)
from django.db import models class TimeStampedModel(models.Model): """所有模型的基類,提供創(chuàng)建時間和更新時間""" created_at = models.DateTimeField(auto_now_add=True) updated_at = models.DateTimeField(auto_now=True) class Meta: abstract = True class UUIDModel(models.Model): """使用UUID作為主鍵的模型基類""" id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False) class Meta: abstract = True
2. 核心視圖(apps/core/views.py)
from django.shortcuts import render from django.views.generic import TemplateView class HomeView(TemplateView): template_name = 'home.html'
3. 核心 URL 配置(apps/core/urls.py)
from django.urls import path from .views import HomeView urlpatterns = [ path('', HomeView.as_view(), name='home'), ]
五、用戶應(yīng)用實現(xiàn)
1. 用戶模型(apps/users/models.py)
from django.db import models from django.contrib.auth.models import AbstractUser from apps.core.models import TimeStampedModel class User(AbstractUser, TimeStampedModel): """自定義用戶模型""" phone = models.CharField(max_length=20, blank=True, null=True) bio = models.TextField(blank=True, null=True) def __str__(self): return self.username
2. 用戶管理(apps/users/admin.py)
from django.contrib import admin from django.contrib.auth.admin import UserAdmin from .models import User class CustomUserAdmin(UserAdmin): fieldsets = ( (None, {'fields': ('username', 'password')}), ('個人信息', {'fields': ('first_name', 'last_name', 'email', 'phone', 'bio')}), ('權(quán)限', {'fields': ('is_active', 'is_staff', 'is_superuser', 'groups', 'user_permissions')}), ('重要日期', {'fields': ('last_login', 'date_joined')}), ) admin.site.register(User, CustomUserAdmin)
六、項目 URL 配置
1. 主 URL 配置(config/urls.py)
from django.contrib import admin from django.urls import path, include from django.conf import settings from django.conf.urls.static import static urlpatterns = [ path('admin/', admin.site.urls), path('', include('apps.core.urls')), path('users/', include('apps.users.urls')), ] if settings.DEBUG: urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
2. 用戶應(yīng)用 URL 配置(apps/users/urls.py)
from django.urls import path, include from django.contrib.auth import views as auth_views from .views import UserProfileView urlpatterns = [ path('profile/', UserProfileView.as_view(), name='user-profile'), path('login/', auth_views.LoginView.as_view(template_name='users/login.html'), name='login'), path('logout/', auth_views.LogoutView.as_view(), name='logout'), ]
七、模板文件
1. 基礎(chǔ)模板(templates/base.html)
<!DOCTYPE html> <html lang="zh-CN"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>{% block title %}MyProject{% endblock %}</title> <link rel="stylesheet" rel="external nofollow" > {% block extra_css %}{% endblock %} </head> <body> <nav class="navbar navbar-expand-lg navbar-light bg-light"> <div class="container"> <a class="navbar-brand" href="{% url 'home' %}" rel="external nofollow" rel="external nofollow" >MyProject</a> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav"> <li class="nav-item"> <a class="nav-link" href="{% url 'home' %}" rel="external nofollow" rel="external nofollow" >首頁</a> </li> {% if user.is_authenticated %} <li class="nav-item"> <a class="nav-link" href="{% url 'user-profile' %}" rel="external nofollow" >個人中心</a> </li> <li class="nav-item"> <a class="nav-link" href="{% url 'logout' %}" rel="external nofollow" >退出登錄</a> </li> {% else %} <li class="nav-item"> <a class="nav-link" href="{% url 'login' %}" rel="external nofollow" rel="external nofollow" >登錄</a> </li> {% endif %} </ul> </div> </div> </nav> <div class="container mt-4"> {% if messages %} {% for message in messages %} <div class="alert alert-{{ message.tags }}"> {{ message }} </div> {% endfor %} {% endif %} {% block content %}{% endblock %} </div> <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.bundle.min.js"></script> {% block extra_js %}{% endblock %} </body> </html>
2. 首頁模板(templates/home.html)
{% extends 'base.html' %} {% block title %}首頁{% endblock %} {% block content %} <div class="jumbotron"> <h1 class="display-4">歡迎來到MyProject</h1> <p class="lead">這是一個基于Django的多級項目結(jié)構(gòu)示例</p> <hr class="my-4"> {% if user.is_authenticated %} <p>你已登錄,{{ user.username }}!</p> {% else %} <p>請登錄以訪問更多功能</p> <a class="btn btn-primary btn-lg" href="{% url 'login' %}" rel="external nofollow" rel="external nofollow" role="button">登錄</a> {% endif %} </div> {% endblock %}
八、工具庫實現(xiàn)
1. 通用工具函數(shù)(libs/utils/common.py)
import uuid import random import string def generate_random_string(length=10): """生成隨機字符串""" return ''.join(random.choices(string.ascii_letters + string.digits, k=length)) def generate_uuid(): """生成UUID""" return str(uuid.uuid4()) def get_client_ip(request): """獲取客戶端IP地址""" x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR') if x_forwarded_for: ip = x_forwarded_for.split(',')[0] else: ip = request.META.get('REMOTE_ADDR') return ip
九、項目啟動與測試
1. 創(chuàng)建并配置環(huán)境變量
cp .env.example .env # 編輯 .env 文件,設(shè)置 SECRET_KEY 等變量
2. 運行數(shù)據(jù)庫遷移
python manage.py migrate --settings=config.settings.dev
3. 創(chuàng)建超級用戶
python manage.py createsuperuser --settings=config.settings.dev
4. 啟動開發(fā)服務(wù)器
python manage.py runserver --settings=config.settings.dev
5. 訪問網(wǎng)站
打開瀏覽器,訪問 http://localhost:8000
十、項目優(yōu)化與擴展
1. 添加 Docker 支持
# Dockerfile FROM python:3.9-slim WORKDIR /app COPY requirements.txt . RUN pip install --no-cache-dir -r requirements.txt COPY . . CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
2. 添加測試用例(tests/)
# tests/unit/test_models.py from django.test import TestCase from apps.users.models import User class UserModelTestCase(TestCase): def setUp(self): self.user = User.objects.create_user( username='testuser', email='test@example.com', password='testpassword' ) def test_user_creation(self): self.assertEqual(User.objects.count(), 1) self.assertEqual(self.user.username, 'testuser') self.assertEqual(self.user.email, 'test@example.com') self.assertTrue(self.user.check_password('testpassword'))
項目總結(jié)
通過這個實戰(zhàn)教程,你學(xué)會了如何從零開始創(chuàng)建一個結(jié)構(gòu)清晰的 Django 多級項目:
- 項目初始化:創(chuàng)建虛擬環(huán)境、安裝依賴、生成基礎(chǔ)結(jié)構(gòu)
- 多級目錄設(shè)計:配置目錄、應(yīng)用目錄、工具庫目錄分離
- 配置管理:使用環(huán)境變量和分層配置文件
- 核心應(yīng)用開發(fā):創(chuàng)建基礎(chǔ)模型、視圖和 URL 配置
- 用戶應(yīng)用開發(fā):擴展用戶模型、實現(xiàn)認(rèn)證功能
- 模板系統(tǒng):使用繼承創(chuàng)建一致的頁面結(jié)構(gòu)
- 工具庫封裝:提取通用功能到獨立模塊
這種結(jié)構(gòu)使項目具有更好的可維護性、可擴展性和團隊協(xié)作效率,特別適合中大型項目。
到此這篇關(guān)于django 多級項目目錄的示例代碼的文章就介紹到這了,更多相關(guān)django 多級目錄內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
python中關(guān)于對super()函數(shù)疑問解惑
Python中的super()是用于調(diào)用父類(或父類的父類...)方法的函數(shù),主要用于多繼承,單繼承問題不大,下面這篇文章主要給大家介紹了關(guān)于python中關(guān)于對super()函數(shù)疑問解惑的相關(guān)資料,需要的朋友可以參考下2022-08-08python3?flask使用連接池連接數(shù)據(jù)庫實例
這篇文章主要為大家介紹了python3?flask使用連接池連接數(shù)據(jù)庫實例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-08-08