python应用目录规划
mhr18 2025-08-06 21:10 4 浏览 0 评论
Python 大型应用目录结构规划(企业级最佳实践)
核心原则
- 模块化:按业务功能拆分,高内聚低耦合
- 可扩展性:支持插件机制和动态加载
- 环境隔离:清晰区分开发/测试/生产环境
- 自动化:内置标准化的构建测试部署流程
- 可维护性:结构自说明,新成员能快速理解
完整目录结构
project-root/ # 项目根目录(Git仓库根目录)
├── .github/ # CI/CD工作流配置
│ └── workflows/
│ ├── ci.yml # 持续集成流程
│ └── cd.yml # 持续部署流程
│
├── .vscode/ # IDE配置(可选)
│ ├── settings.json
│ └── extensions.json
│
├── config/ # 配置中心
│ ├── base/ # 基础配置
│ │ ├── logging.yaml # 日志配置
│ │ ├── database.py # 数据库连接池
│ │ └── constants.py # 全局常量
│ │
│ ├── dev/ # 开发环境
│ │ ├── __init__.py
│ │ └── settings.toml
│ │
│ ├── test/ # 测试环境
│ └── prod/ # 生产环境(敏感配置通过Vault注入)
│
├── src/ # 主代码库
│ └── your_project/ # 项目主包
│ ├── __init__.py # 包初始化
│ ├── application/ # 业务逻辑层
│ │ ├── services/ # 业务服务
│ │ │ ├── user_service.py
│ │ │ └── payment_service.py
│ │ │
│ │ ├── models/ # 业务模型(DTO/BO)
│ │ │ ├── user.py
│ │ │ └── order.py
│ │ │
│ │ └── use_cases/ # 业务用例
│ │ ├── checkout_use_case.py
│ │ └── report_generation.py
│ │
│ ├── domain/ # 领域层(DDD)
│ │ ├── entities/ # 聚合根/实体
│ │ ├── value_objects/ # 值对象
│ │ ├── events/ # 领域事件
│ │ └── repositories/ # 仓储接口
│ │
│ ├── infrastructure/ # 基础设施层
│ │ ├── database/ # 数据访问
│ │ │ ├── migrations/ # 数据库迁移脚本
│ │ │ ├── models.py # ORM映射
│ │ │ └── repositories_impl/ # 仓储实现
│ │ │
│ │ ├── cache/ # 缓存实现(Redis/Memcached)
│ │ ├── message_broker/ # 消息队列实现
│ │ └── third_party/ # 第三方服务集成
│ │
│ ├── interfaces/ # 接口层
│ │ ├── web/ # Web接口
│ │ │ ├── api/ # REST API
│ │ │ │ ├── v1/ # 版本控制
│ │ │ │ │ ├── routers/
│ │ │ │ │ ├── schemas/ # Pydantic模型
│ │ │ │ │ └── dependencies.py
│ │ │ │ ├── v2/
│ │ │ │ └── middleware/ # 中间件
│ │ │ │
│ │ │ ├── templates/ # HTML模板(如需要)
│ │ │ └── static/ # 静态资源
│ │ │
│ │ ├── rpc/ # gRPC接口
│ │ ├── cli/ # 命令行接口
│ │ └── event_handlers/ # 事件处理器
│ │
│ ├── utils/ # 公共工具
│ │ ├── security/ # 安全相关
│ │ ├── logging/ # 日志扩展
│ │ ├── error_handling/ # 异常处理
│ │ └── helpers.py # 通用辅助函数
│ │
│ └── main.py # 应用入口
│
├── tests/ # 测试套件
│ ├── unit/ # 单元测试
│ │ ├── application/
│ │ ├── domain/
│ │ └── utils/
│ │
│ ├── integration/ # 集成测试
│ │ ├── database/
│ │ └── api/
│ │
│ ├── e2e/ # 端到端测试
│ │ └── workflows/ # 核心业务流程测试
│ │
│ ├── benchmark/ # 性能测试
│ └── conftest.py # pytest全局fixture
│
├── scripts/ # 运维脚本
│ ├── deployment/ # 部署相关
│ │ ├── docker/
│ │ │ ├── Dockerfile
│ │ │ └── docker-compose.yml
│ │ ├── k8s/ # Kubernetes配置
│ │ └── ansible/ # Ansible脚本
│ │
│ ├── data/ # 数据处理
│ │ ├── migration/ # 数据迁移
│ │ └── seeding/ # 数据初始化
│ │
│ ├── monitoring/ # 监控脚本
│ └── maintenance.py # 系统维护任务
│
├── docs/ # 项目文档
│ ├── architecture/ # 架构设计
│ ├── api-reference/ # API文档
│ ├── decisions/ # 技术决策记录
│ └── onboarding.md # 新成员指南
│
├── requirements/ # 依赖管理
│ ├── base.in # 核心依赖
│ ├── dev.in # 开发环境
│ ├── test.in # 测试环境
│ └── prod.in # 生产环境
│
├── .env.example # 环境变量示例
├── .pre-commit-config.yaml # 代码提交前检查
├── pyproject.toml # 项目元数据(PEP518)
├── Makefile # 项目自动化命令
└── README.md # 项目入口文档
关键目录解析
分层(src/your_project)
接口层 interfaces :HTTP/RPC/CLI入口,只做参数校验和格式转换
应用层 application :业务流程编排,事务边界控制
领域层 domain :核心业务逻辑,与技术实现解耦
基础设施层 infrastructure :数据库/缓存等具体实现
配置(config/)
# config/__init__.py
import os
ENV = os.getenv("APP_ENV", "dev")
def load_config():
if ENV == "prod":
from .prod import settings
elif ENV == "test":
from .test import settings
else:
from .dev import settings
return settings
current_config = load_config()
测试(tests/)
测试类型 | 覆盖范围 | 执行频率 | 工具组合 |
单元测试 | 独立函数/类 | 每次提交 | pytest + unittest.mock |
集成测试 | 模块间交互/数据库 | 每日 | pytest + testcontainers |
E2E测试 | 完整API流程 | 发布前 | playwright + pytest |
性能测试 | 关键路径响应时间 | 版本发布 | locust + py-spy |
契约测试 | 微服务间接口 | 接口变更 | pytest + pact |
部署(scripts/deployment)
容器化部署
# Dockerfile 多阶段构建
FROM python:3.11-slim AS builder
COPY requirements/prod.txt .
RUN pip install --no-cache-dir -r prod.txt
FROM python:3.11-slim AS runtime
COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
COPY ./src /app
ENV PYTHONPATH=/app
CMD ["python", "/app/your_project/main.py"]
依赖(requirements/)
# requirements/base.in
fastapi==0.95.0
sqlalchemy[asyncio]==2.0.10
pydantic-settings==2.0.2
# requirements/dev.in
-r base.in
pytest==7.3.1
ipdb==0.13.9
jupyterlab==3.6.3
# 使用pip-tools管理:
pip-compile --output-file=requirements.txt requirements/prod.in
大型项目
project-root/
└── services/ # 微服务拆分子目录
├── user-service/ # 独立服务
│ ├── src/ # 服务专用代码
│ └── tests/
│
├── order-service/
├── payment-service/
└── shared-lib/ # 公共库
├── common-utils/
├── database-client/
└── messaging-sdk/
实践清单
环境一致性:所有环境使用相同Python版本(pyenv + .python-version)
启动优化:冷启动时间超过5秒需拆分懒加载
依赖安全:定期扫描漏洞(safety/dependabot)
文档自动化:API文档随代码更新(FastAPI/Sphinx)
监控埋点:关键路径添加性能探针(OpenTelemetry)
资源限制:数据库连接池/线程池上限配置
异常处理:全局异常处理器记录堆栈
配置分离:敏感信息使用环境变量或配置中心
相关推荐
- 订单超时自动取消业务的 N 种实现方案,从原理到落地全解析
-
在分布式系统架构中,订单超时自动取消机制是保障业务一致性的关键组件。某电商平台曾因超时处理机制缺陷导致日均3000+订单库存锁定异常,直接损失超50万元/天。本文将从技术原理、实现细节、...
- 使用Spring Boot 3开发时,如何选择合适的分布式技术?
-
作为互联网大厂的后端开发人员,当你满怀期待地用上SpringBoot3,准备在项目中大显身手时,却发现一个棘手的问题摆在面前:面对众多分布式技术,究竟该如何选择,才能让SpringBoot...
- 数据库内存爆满怎么办?99%的程序员都踩过这个坑!
-
你的数据库是不是又双叒叕内存爆满了?!服务器监控一片红色警告,老板在群里@所有人,运维同事的电话打爆了手机...这种场景是不是特别熟悉?别慌!作为一个在数据库优化这条路上摸爬滚打了10年的老司机,今天...
- springboot利用Redisson 实现缓存与数据库双写不一致问题
-
使用了Redisson来操作Redis分布式锁,主要功能是从缓存和数据库中获取商品信息,以下是针对并发时更新缓存和数据库带来不一致问题的解决方案1.基于读写锁和删除缓存策略在并发更新场景下,...
- 外贸独立站数据库炸了?对象缓存让你起死回生
-
上周黑五,一个客户眼睁睁看着服务器CPU飙到100%——每次页面加载要查87次数据库。这让我想起2024年Pantheon的测试:Redis缓存能把WooCommerce查询速度提升20倍。跨境电商最...
- 手把手教你在 Spring Boot3 里纯编码实现自定义分布式锁
-
为什么要自己实现分布式锁?你是不是早就受够了引入各种第三方依赖时的繁琐?尤其是分布式锁这块,每次集成Redisson或者Zookeeper,都得额外维护一堆配置,有时候还会因为版本兼容问题头疼半...
- 如何设计一个支持百万级实时数据推送的WebSocket集群架构?
-
面试解答:要设计一个支持百万级实时数据推送的WebSocket集群架构,需从**连接管理、负载均衡、水平扩展、容灾恢复**四个维度切入:连接层设计-**长连接优化**:采用Netty或Und...
- Redis数据结构总结——面试最常问到的知识点
-
Redis作为主流的nosql存储,面试时经常会问到。其主要场景是用作缓存,分布式锁,分布式session,消息队列,发布订阅等等。其存储结构主要有String,List,Set,Hash,Sort...
- skynet服务的缺陷 lua死循环
-
服务端高级架构—云风的skynet这边有一个关于云风skynet的视频推荐给大家观看点击就可以观看了!skynet是一套多人在线游戏的轻量级服务端框架,使用C+Lua开发。skynet的显著优点是,...
- 七年Java开发的一路辛酸史:分享面试京东、阿里、美团后的心得
-
前言我觉得有一个能够找一份大厂的offer的想法,这是很正常的,这并不是我们的饭后谈资而是每个技术人的追求。像阿里、腾讯、美团、字节跳动、京东等等的技术氛围与技术规范度还是要明显优于一些创业型公司...
- mysql mogodb es redis数据库之间的区别
-
1.MySQL应用场景概念:关系型数据库,基于关系模型,使用表和行存储数据。优点:支持ACID事务,数据具有很高的一致性和完整性。缺点:垂直扩展能力有限,需要分库分表等方式扩展。对于复杂的查询和大量的...
- redis,memcached,nginx网络组件
-
1.理解阻塞io,非阻塞io,同步io,异步io的区别2.理解BIO和AIO的区别io多路复用只负责io检测,不负责io操作阻塞io中的write,能写多少是多少,只要写成功就返回,譬如准备写500字...
- SpringBoot+Vue+Redis实现验证码功能
-
一个小时只允许发三次验证码。一次验证码有效期二分钟。SpringBoot整合Redis...
- AWS MemoryDB 可观测最佳实践
-
AWSMemoryDB介绍AmazonMemoryDB是一种完全托管的、内存中数据存储服务,专为需要极低延迟和高吞吐量的应用程序而设计。它与Redis和Memcached相似,但具有更...
- 从0构建大型AI推荐系统:实时化引擎从工具到生态的演进
-
在AI浪潮席卷各行各业的今天,推荐系统正从幕后走向前台,成为用户体验的核心驱动力。本文将带你深入探索一个大型AI推荐系统从零起步的全过程,揭示实时化引擎如何从单一工具演进为复杂生态的关键路径。无论你是...
你 发表评论:
欢迎- 一周热门
-
-
Redis客户端 Jedis 与 Lettuce
-
高并发架构系列:Redis并发竞争key的解决方案详解
-
redis如何防止并发(redis如何防止高并发)
-
Java SE Development Kit 8u441下载地址【windows版本】
-
开源推荐:如何实现的一个高性能 Redis 服务器
-
redis安装与调优部署文档(WinServer)
-
Redis 入门 - 安装最全讲解(Windows、Linux、Docker)
-
一文带你了解 Redis 的发布与订阅的底层原理
-
Redis如何应对并发访问(redis控制并发量)
-
Oracle如何创建用户,表空间(oracle19c创建表空间用户)
-
- 最近发表
- 标签列表
-
- oracle位图索引 (74)
- oracle批量插入数据 (65)
- oracle事务隔离级别 (59)
- oracle主从同步 (56)
- oracle 乐观锁 (53)
- redis 命令 (83)
- php redis (97)
- redis 存储 (67)
- redis 锁 (74)
- 启动 redis (73)
- redis 时间 (60)
- redis 删除 (69)
- redis内存 (64)
- redis并发 (53)
- redis 主从 (71)
- redis同步 (53)
- redis结构 (53)
- redis 订阅 (54)
- redis 登录 (62)
- redis 面试 (58)
- redis问题 (54)
- 阿里 redis (67)
- redis的缓存 (57)
- lua redis (59)
- redis 连接池 (64)