生成企业级代码架构的 Prompt 指南
根据你当前的项目,这个架构的优秀之处在于:
1. 清晰的分层设计 - 应用层、业务层、基础层职责明确
2. 插件化架构 - 支持动态扩展,依赖管理完善
3. 标准化接口 - 同时支持 REST API 和 MCP 协议
4. 类型安全 - 全面使用 Pydantic 和 Type Hints
5. 事件驱动 - EventBus 实现松耦合
6. 状态管理 - 引擎状态可持久化和恢复
7. 测试友好 - 独立的测试目录和测试文档
8. 文档完善 - README 包含完整的使用指南
使用上述 Prompt 模板,你可以生成类似质量的企业级代码架构!
核心prompt模版
请帮我设计一个企业级的 [项目类型] 系统架构,要求如下: ## 1. 项目定位 - **业务领域**: [如:KUKA 机器人仿真控制环境] - **核心功能**: [如:机器人点动控制、坐标管理、操作模式切换等] - **目标用户**: [如:AI 代理、强化学习智能体、自动化测试系统] - **集成协议**: [如:MCP 协议、RESTful API、Gymnasium 标准接口] ## 2. 架构设计要求 ### 分层架构 - **应用层**: 提供多种接口(REST API、SDK、协议适配器) - **业务逻辑层**: 核心业务逻辑封装 - **基础服务层**: 引擎管理、插件系统、事件总线 - **数据层**: 状态持久化、配置管理 ### 核心模块划分 1. **引擎核心模块** (engine/) - 引擎管理器 (engine.py) - 插件系统 (plugin.py) - 控制器模块 (controller/) - 事件系统 (events/) - 类型定义 (types/) - 工具类 (utility/) 2. **服务端模块** (server/) - 主应用入口 (server.py) - 路由分组 (routers/) - 中间件配置 - 异常处理 3. **环境模块** (env/) - 环境接口 (env.py) - 动作空间 (action/) - 观测空间 (obs/) 4. **测试模块** (tests/) - 单元测试 - 集成测试 - 测试文档 ## 3. 代码质量要求 ### 设计规范 - ✅ 使用 Pydantic 进行数据验证和类型检查 - ✅ 遵循单一职责原则,每个类职责明确 - ✅ 使用依赖注入和插件化设计 - ✅ 实现发布 - 订阅模式的事件系统 - ✅ 支持状态持久化和恢复 ### 工程规范 - ✅ 完整的类型注解(Type Hints) - ✅ 统一的代码风格(遵循 PEP 8) - ✅ 详细的文档字符串(Docstrings) - ✅ 模块化目录结构 - ✅ __init__.py 文件组织包结构 ### API 设计规范 - ✅ RESTful 风格的路由设计 - ✅ 统一的响应格式 - ✅ 全局异常处理 - ✅ OpenAPI 文档自动生成 - ✅ 请求验证和参数校验 ## 4. 企业级特性 ### 安全性 - 权限控制(用户组管理) - 安全状态检查 - 操作审计日志 - CORS 中间件配置 ### 可扩展性 - 插件化架构(支持动态加载) - 依赖管理系统 - 事件驱动设计 - 接口抽象层 ### 可维护性 - 清晰的目录结构 - 模块间低耦合 - 配置与代码分离 - 完整的测试覆盖 ### 可观测性 - 日志系统(Loguru) - 健康检查端点 - 状态监控接口 - 错误追踪 ## 5. 技术栈要求 ### 核心框架 - Web 框架:FastAPI - 数据验证:Pydantic v2 - 异步运行时:AsyncIO - 协议支持:MCP (Model Context Protocol) ### 开发工具 - 测试框架:pytest - 代码质量:ruff, black, mypy - 文档生成:mkdocs - 依赖管理:pip/conda ### 集成支持 - Gymnasium (RL 环境标准) - MCP 协议客户端 - RESTful API 客户端 - WebSocket 支持(可选) ## 6. 文档要求 ### 必需文档 - README.md(项目概述、快速开始) - API 文档(自动生成 + 手动补充) - 架构设计文档 - 开发指南 - 测试文档 ### 代码注释 - 模块级文档字符串 - 类和方法说明 - 复杂逻辑注释 - TODO 标记 ## 7. 输出要求 请提供: 1. 完整的项目目录结构树 2. 核心模块的代码实现 3. 依赖配置文件 (requirements.txt) 4. 使用示例代码 5. 测试用例示例 6. 部署和运行说明
精简prompt:
创建一个企业级 Python 项目架构,要求: 1. **技术栈**: FastAPI + Pydantic v2 + AsyncIO 2. **架构模式**: 分层架构 + 插件化设计 + 事件驱动 3. **核心特性**: - RESTful API + MCP 协议支持 - 插件系统(动态加载、依赖管理) - 状态持久化 - 完整的类型注解 4. **目录结构**: - 业务逻辑层 (engine/) - 服务端层 (server/) - 接口适配层 (routers/) - 测试层 (tests/) 5. **工程规范**: - 遵循 PEP 8 - 统一异常处理 - 日志系统 - 健康检查 - OpenAPI 文档 请生成完整的项目结构和核心代码。
本文来自博客园,作者:limingqi,转载请注明原文链接:https://www.cnblogs.com/limingqi/p/19734634
浙公网安备 33010602011771号