light-system-design
Installation
SKILL.md
后端系统与数据库设计
适用场景
科研系统、管理系统、数据分析/可视化平台、竞赛作品、软著申请项目。设计要既能落地(交 a03 实现)又能写进软著/论文(交 m15/m07)。
系统架构
- 模块划分(分层:接口层/业务层/数据层)、职责边界、数据流转图。
- 技术选型按需(见 a09,各框架起手式/分层/配置见 references.md):FastAPI(路由+Pydantic 校验+
Depends注入+/docsSwagger)、Django REST(serializer+ModelViewSet+Router,REST_FRAMEWORK集中配)、Spring Boot(@RestController→@Service→@Repository分层+构造器注入+多 profile)。 - 非功能性:性能(缓存/索引/分页)、可扩展、可观测。
- 向量检索选型(科研 RAG/语义检索常用):百万级以内优先 pgvector + HNSW(一套 Postgres 管关系+向量,运维简单),算子类与查询距离要一致(cosine→
vector_cosine_ops);千万~亿级、高 QPS 或需分布式才上专用向量库(Milvus/Qdrant/Weaviate)。选型对照见 references「pgvector + HNSW」节。 - 可观测:科研 AI 服务用 OpenTelemetry 统一采 trace/metric/log(
opentelemetry-instrument零改代码自动埋点,OTLP 导出到 Jaeger/Prometheus),定位"一次推理耗时花在哪、哪步报错",别用 print 调试;注意采样率与别把密钥/PII 写进 span。详见 references「OpenTelemetry」节。
数据库设计
- ER 图:实体、关系、基数。可用
scripts/er_diagram.py把表结构定义(YAML/JSON:entities + columns(PK/FK/UK) + relationships(基数))一键转成 MermaiderDiagram文本,粘进 Markdown/软著文档或 mermaid.live 预览(python scripts/er_diagram.py --in schema.yaml,纯离线)。 - 表结构:字段、类型、约束、主外键、范式 vs 反范式权衡。刻意选型,别无脑 text/超大 numeric。
- 索引:按查询模式选型——B-Tree(等值/范围/排序/前缀
LIKE 'x%')、GIN(数组/JSONB/全文/trigram)、BRIN(超大表+物理有序时间列)、GiST(几何/最近邻)、Hash(纯等值)。外键必须建索引(最常见漏建);生产建索引用CREATE INDEX CONCURRENTLY避免锁表;上线前EXPLAIN ANALYZE验证计划。 - 迁移:Alembic
revision --autogenerate生成后必须人工审(检不出重命名/匿名约束,报成 drop+add),upgrade head应用,CIalembic check;Prisma 开发migrate dev、生产只能migrate deploy(不 reset/shadow DB),手改 SQL 用--create-only。 - ORM 防 N+1:SQLAlchemy 用
selectinload(二次 IN 查询)/joinedload(JOIN) 预加载;DRF 用select_related/prefetch_related。连接必须用连接池。 - 最佳实践参考 supabase-postgres-best-practices(下方安全段含 RLS 具体写法、命名规范)。