django 多级项目目录的示例代码

目录

• 一、项目初始化
• 1. 创建虚拟环境并安装依赖
• 2. 创建项目和基础结构
• 二、项目目录结构
• 三、配置文件实现
• 1. 环境变量管理（.env.example）
• 2. 配置文件分层（config/settings/）
• 四、核心应用实现
• 1. 核心模型（apps/core/models.py）
• 2. 核心视图（apps/core/views.py）
• 3. 核心 URL 配置（apps/core/urls.py）
• 五、用户应用实现
• 1. 用户模型（apps/users/models.py）
• 2. 用户管理（apps/users/admin.py）
• 六、项目 URL 配置
• 1. 主 URL 配置（config/urls.py）
• 2. 用户应用 URL 配置（apps/users/urls.py）
• 七、模板文件
• 1. 基础模板（templates/base.html）
• 2. 首页模板（templates/home.html）
• 八、工具库实现
• 1. 通用工具函数（libs/utils/common.py）
• 九、项目启动与测试
• 1. 创建并配置环境变量
• 2. 运行数据库迁移
• 3. 创建超级用户
• 4. 启动开发服务器
• 5. 访问网站
• 十、项目优化与扩展
• 1. 添加 docker 支持
• 2. 添加测试用例（tests/）
• 项目总结

一、项目初始化

1. 创建虚拟环境并安装依赖

# 创建虚拟环境
python3 -m venv env
source env/bin/activate

# 安装依赖
pip install django python-decouple

2. 创建项目和基础结构

# 创建项目根目录
mkdir myproject
cd myproject

# 创建配置目录
mkdir config
django-admin startproject myproject config --template=https://github.com/django-templates/django-project-template/archive/master.zip --name=Dockerfile,.env.example

# 创建应用目录
mkdir apps
cd apps
django-admin startapp core
django-admin startapp users
cd ..

# 创建其他目录
mkdir libs static media templates scripts tests
touch .gitignore

二、项目目录结构

myproject/                   # 项目根目录
├── config/                  # 项目配置目录
│   ├── __init__.py
│   ├── settings/            # 配置文件按环境分离
│   │   ├── __init__.py
│   │   ├── base.py          # 基础配置
│   │   ├── dev.py           # 开发环境配置
│   │   └── prod.py          # 生产环境配置
│   ├── urls.py              # 项目URL配置
│   └── wsgi.py              # WSGI应用配置
├── apps/                    # 自定义应用目录
│   ├── core/                # 核心功能应用
│   │   ├── migrations/
│   │   ├── __init__.py
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── models.py
│   │   ├── tests.py
│   │   ├── urls.py
│   │   └── views.py
│   └── users/               # 用户管理应用
├── libs/                    # 自定义库目录
│   └── utils/               # 工具函数
├── static/                  # 静态文件目录
├── media/                   # 上传文件目录
├── templates/               # 模板文件目录
├── scripts/                 # 脚本文件目录
├── tests/                   # 测试目录
├── .env.example             # 环境变量示例
├── .gitignore               # Git忽略规则
├── manage.py                # Django管理脚本
└── requirements.txt         # 依赖包列表

三、配置文件实现

1. 环境变量管理（.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_CODandroidE = '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',
]

# 开发环境数据库配置
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

# config/settings/prod.py
from .base import *

DEBUG = False

# 生产环境需要从环境变量获取敏感信息
SECRET_KEY = config('SECRET_KEY')
ALLOWED_HOSTS = config('ALLOWED_HOSTS', cast=lambda v: [s.strip() for s in v.split(',')])

# 生产环境数据库配置
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'),
    }
}

# 生产环境静态文件配置
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

四、核心应用实现

1. 核心模型（apps/core/models.py）

from django.db import models

class TimeStampedModel(models.Model):
    """所有模型的基类，提供创建时间和更新时间"""
    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'),
]

五、用户应用实现

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')}),
        ('权限', {'fields': ('is_active', 'is_staff', 'is_superuser', 'groups', 'user_permissions')}),
        ('重要日期', {'fields': ('last_login', 'date_joined')}),
    )

admin.site.registephpr(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. 用户应用 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. 基础模板（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" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" 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="navwww.devze.com-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>
    </navjavascript>

    <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的多级项目结构示例</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 %}

八、工具库实现

1. 通用工具函数（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. 创建并配置环境变量

cp .env.example .env
# 编辑 .env 文件，设置 SECRET_KEY 等变量

2. 运行数据库迁移

python manage.py migrate --settings=config.settings.dev

3. 创建超级用户

python manage.py createsuperuser --settings=config.settings.dev

4. 启动开发服务器

python manage.py runserver --settings=config.settings.dev

5. 访问网站

打开浏览器，访问 http://localhost:8000

十、项目优化与扩展

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'))

项目总结

通过这个实战教程，你学会了如何从零开始创建一个结构清晰的 Django 多级项目：

• 项目初始化：创建虚拟环境、安装依赖、生成基础结构
• 多级目录设计：配置目录、应用目录、工具库目录分离
• 配置管理：使用环境变量和分层配置文件
• 核心应用开发：创建基础模型、视图和 URL 配置
• 用户应用开发：扩展用户模型、实现认证功能
• 模板系统：使用继承创建一致的页面结构
• 工具库封装：提取通用功能到独立模块

这种结构使项目具有更好的可维护性、可扩展性和团队协作效率，特别适合中大型项目。

到此这篇关于django 多级项目目录的示例代码的文章就介绍到这了,更多相关django 多级目录内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！