Django开发记录（二）：项目结构与开发规范

项目结构与开发规范#

项目背景
在完成基础环境搭建后，我们需要建立清晰的项目结构和开发规范。本篇将详细介绍如何设计合理的项目结构，制定统一的开发规范，为后续模块开发奠定基础。

技术特点
模块化的项目结构设计
标准化的开发规范
优化的数据库设计
完善的测试体系

1. 项目结构设计#

1.1 目录结构#

结构设计
合理的目录结构是项目成功的基础，它能够：
提高代码可维护性
便于团队协作
支持功能扩展
简化部署流程

health_django/
├── manage.py              # 项目管理脚本
├── health_django/         # 项目配置目录
│   ├── __init__.py
│   ├── settings.py        # 项目设置
│   ├── urls.py            # 主URL配置
│   └── wsgi.py            # WSGI配置
├── user/                  # 用户模块
│   ├── models.py          # 用户模型
│   ├── views.py           # 用户视图
│   ├── urls.py            # 用户URL
│   └── tests.py           # 用户测试
├── information/           # 信息模块
│   ├── models.py          # 信息模型
│   ├── views.py           # 信息视图
│   ├── urls.py            # 信息URL
│   └── tests.py           # 信息测试
├── plan/                  # 计划模块
│   ├── models.py          # 计划模型
│   ├── views.py           # 计划视图
│   ├── urls.py            # 计划URL
│   └── tests.py           # 计划测试
├── ai/                    # AI模块
│   ├── deepseek.py        # DeepSeek API
│   ├── response2plan.py   # 计划解析
│   └── test.py            # AI测试
└── docs/                  # 文档目录
    ├── 01_django_basics.md
    ├── 02_project_structure.md
    ├── 03_module_design.md
    └── 04_ai_module.md

2. 开发规范#

2.1 代码规范#

代码规范
统一的代码规范是保证项目质量的关键：
提高代码可读性
便于团队协作
减少维护成本

# 命名规范
class UserService:  # 类名使用大驼峰
    def get_user_info(self):  # 方法名使用小驼峰
        user_id = "test123"  # 变量名使用下划线
        MAX_RETRY = 3  # 常量使用大写

# 注释规范
def calculate_bmi(weight, height):
    """
    计算BMI指数
    Args:
        weight: 体重(kg)
        height: 身高(m)
    Returns:
        float: BMI值
    Raises:
        ValueError: 当输入参数无效时
    """
    if weight <= 0 or height <= 0:
        raise ValueError("体重和身高必须大于0")
    return weight / (height * height)

# 异常处理
@handle_exception
def update_user_info(request):
    try:
        user_id = request.POST.get("user_id")
        if not user_id:
            raise ValueError("用户ID不能为空")
        # 业务逻辑
    except ValueError as e:
        return api_response(400, str(e))
    except Exception as e:
        return api_response(500, "服务器内部错误")

2.2 API规范#

API设计
统一的API设计规范确保接口的：
一致性
可维护性
可扩展性

# 请求格式
POST /api/user/register/
Content-Type: application/x-www-form-urlencoded

user_id=test123&password=123456

# 响应格式
{
    "code": 200,
    "message": "注册成功",
    "data": {
        "user_id": "test123",
        "created_at": "2024-01-01 12:00:00"
    }
}

# 错误码规范
ERROR_CODES = {
    200: "成功",
    400: "请求参数错误",
    500: "服务器内部错误"
}

3. 数据库设计#

3.1 用户表设计#

表结构设计
合理的表结构设计需要考虑：
数据完整性
查询性能
扩展性

CREATE TABLE user (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    user_id VARCHAR(50) UNIQUE NOT NULL,
    password VARCHAR(128) NOT NULL,
    created_at DATETIME NOT NULL,
    updated_at DATETIME NOT NULL
);

CREATE INDEX idx_user_user_id ON user(user_id);

3.2 信息表设计#

关系设计
合理的外键关系设计能够：
保证数据一致性
优化查询性能
便于数据维护

CREATE TABLE user_information (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    user_id INTEGER NOT NULL,
    height FLOAT,
    weight FLOAT,
    age INTEGER,
    target TEXT,
    created_at DATETIME NOT NULL,
    updated_at DATETIME NOT NULL,
    FOREIGN KEY (user_id) REFERENCES user(id)
);

CREATE INDEX idx_user_info_user_id ON user_information(user_id);

总结#

关键收获
掌握了项目结构设计原则
理解了开发规范的重要性
熟悉了数据库设计方法
积累了性能优化经验

注意事项
开发规范
严格执行代码规范
保持文档更新
定期代码审查
性能考虑
优化数据库查询
合理使用缓存

NOTE
本文是Django开发系列的第二篇，重点介绍了项目结构设计和开发规范。建议读者在开发过程中严格遵守规范，确保代码质量和系统性能。