refactor(#776): 统一配置入口，建立packages/config消除重复定义 #791

Merged

xiaoxia merged 1 commits from refactor/unified-config-entry into develop 2026-07-23 23:55:01 +08:00

Conversation 2 Commits 1 Files Changed 11

+543 -464

xiaoxia commented 2026-07-23 23:23:39 +08:00

Owner

Copy Link

Copy Source

背景

代码质量专项P1：配置文件分散在8处，3处重复单例实现+重复SettingsConfigDict+alembic绕开配置系统。

改动

• ✅ 新增 packages/config/ 作为配置统一入口（base/api_settings/worker_settings）
• ✅ SharedSettings 基类 + 统一单例管理（_settings_cache），消除3处重复单例实现
• ✅ API配置 → packages/config/api_settings.py（APISettings）
• ✅ Worker配置 → packages/config/worker_settings.py（WorkerSettings）
• ✅ 旧路径全部保留为 re-export 向后兼容层
• ✅ alembic/env.py 改用统一配置获取 database_url，不再直接读环境变量
• ✅ 测试更新：改用 reload_settings_cache() 替代手动 _settings=None

验证

• 全量单测 4383 passed, 8 skipped ✅
• 净减 397 行

Issue

#776

## 背景 代码质量专项P1：配置文件分散在8处，3处重复单例实现+重复SettingsConfigDict+alembic绕开配置系统。 ## 改动 - ✅ 新增 `packages/config/` 作为配置统一入口（base/api_settings/worker_settings） - ✅ SharedSettings 基类 + 统一单例管理（_settings_cache），消除3处重复单例实现 - ✅ API配置 → `packages/config/api_settings.py`（APISettings） - ✅ Worker配置 → `packages/config/worker_settings.py`（WorkerSettings） - ✅ 旧路径全部保留为 re-export 向后兼容层 - ✅ alembic/env.py 改用统一配置获取 database_url，不再直接读环境变量 - ✅ 测试更新：改用 `reload_settings_cache()` 替代手动 `_settings=None` ## 验证 - 全量单测 4383 passed, 8 skipped ✅ - 净减 397 行 ## Issue #776

xiaoxia added 1 commit 2026-07-23 23:23:39 +08:00

refactor(#776): 统一配置入口，建立packages/config消除重复定义 ... 25820fc2dc

- 新增 packages/config/ 作为配置统一入口（base/api_settings/worker_settings）
- SharedSettings 基类 + 统一单例管理（_settings_cache），消除3处重复单例实现
- API配置迁移到 packages/config/api_settings.py（APISettings）
- Worker配置迁移到 packages/config/worker_settings.py（WorkerSettings）
- 旧路径全部保留为 re-export 向后兼容层
- alembic/env.py 改用统一配置获取 database_url，不再直接读环境变量
- 测试更新：改用 reload_settings_cache() 替代手动 _settings=None

净减 397 行（4新文件 + 7修改）

auto-approve-bot commented 2026-07-23 23:38:00 +08:00

Collaborator

Copy Link

Copy Source

代码审查结果 - PR #791

⚠️ 问题（3个需要修改）

1. packages/config/api_settings.py 第113行：环境变量校验逻辑错误，存在安全隐患。

   • 问题描述：validate_oss_access_key_id 和 validate_oss_access_key_secret 方法中使用了 os.getenv("APP_ENV", "development") 来判断当前环境。如果 APP_ENV 仅在 .env 文件中定义而未导出为系统环境变量，os.getenv 将获取不到值，从而默认为 "development"。这会导致在非开发环境下，如果未导出环境变量，系统将跳过对 OSS 密钥的强制非空校验，可能导致服务以空密钥启动或暴露配置错误。
   • 修改建议：将校验器的 mode 改为 "after"，通过 self.environment 访问已解析的环境变量，确保校验逻辑与 Pydantic 加载的配置一致。

2. apps/api/app/core/config.py 第12行：reload_settings 函数未更新模块级单例，导致配置热更新失效。

   • 问题描述：在 reload_settings 函数中，虽然调用了 reload_settings_cache() 清空了缓存并返回了新的配置对象，但未更新模块底部的全局变量 settings。如果外部代码通过 from app.core.config import settings 引入了配置，调用 reload_settings() 后，该引用仍指向旧的配置对象，与 app/config.py 中的实现（正确更新了全局变量）不一致。
   • 修改建议：参考 apps/api/app/config.py 的实现，在函数内部添加 global settings 并更新 settings 变量。

3. alembic/env.py 第15行：数据库迁移工具配置回退风险。

   • 问题描述：Alembic 现在通过 get_shared_settings() 获取配置。如果当前工作目录下找不到 .env 文件（例如在某些容器启动脚本或非项目根目录执行时），SharedSettings 会使用硬编码的默认值（database_url = "postgresql+psycopg://postgres:postgres@localhost:5432/..."）。原代码使用 os.getenv，在未设置时会返回 None 从而跳过覆盖。新代码可能导致生产环境迁移脚本意外连接到本地默认数据库，存在严重的安全误操作风险。
   • 修改建议：在 alembic/env.py 中获取配置后，增加检查逻辑：如果 settings.database_url 等于默认的 localhost 地址且当前环境非 development，应抛出异常或显式警告，防止误连。

💡 建议（1个可选）

1. packages/config/base.py 第86行：配置缓存键未包含环境文件路径。
   • 具体内容：get_cached_settings 使用类名作为缓存键。如果在运行时修改了 APP_ENV 环境变量（例如在测试中切换环境），由于缓存键不变，函数将返回基于旧环境文件加载的配置对象，直到手动调用 reload_settings_cache。建议将 env_file 的路径或内容哈希纳入缓存键的考量，或者在文档中明确说明切换环境必须调用 reload。

---

✅ 格式检查通过 | ❌ 逻辑审查需修改 | ⚠️ 建议关注性能

---

_{🤖 由 AI 代码审查机器人自动生成 | 2026-07-23 15:38:00 | 模型:}

## 代码审查结果 - PR #791 ### ⚠️ 问题（3个需要修改） 1. **packages/config/api_settings.py 第113行**：环境变量校验逻辑错误，存在安全隐患。 - **问题描述**：`validate_oss_access_key_id` 和 `validate_oss_access_key_secret` 方法中使用了 `os.getenv("APP_ENV", "development")` 来判断当前环境。如果 `APP_ENV` 仅在 `.env` 文件中定义而未导出为系统环境变量，`os.getenv` 将获取不到值，从而默认为 `"development"`。这会导致在非开发环境下，如果未导出环境变量，系统将跳过对 OSS 密钥的强制非空校验，可能导致服务以空密钥启动或暴露配置错误。 - **修改建议**：将校验器的 `mode` 改为 `"after"`，通过 `self.environment` 访问已解析的环境变量，确保校验逻辑与 Pydantic 加载的配置一致。 2. **apps/api/app/core/config.py 第12行**：`reload_settings` 函数未更新模块级单例，导致配置热更新失效。 - **问题描述**：在 `reload_settings` 函数中，虽然调用了 `reload_settings_cache()` 清空了缓存并返回了新的配置对象，但未更新模块底部的全局变量 `settings`。如果外部代码通过 `from app.core.config import settings` 引入了配置，调用 `reload_settings()` 后，该引用仍指向旧的配置对象，与 `app/config.py` 中的实现（正确更新了全局变量）不一致。 - **修改建议**：参考 `apps/api/app/config.py` 的实现，在函数内部添加 `global settings` 并更新 `settings` 变量。 3. **alembic/env.py 第15行**：数据库迁移工具配置回退风险。 - **问题描述**：Alembic 现在通过 `get_shared_settings()` 获取配置。如果当前工作目录下找不到 `.env` 文件（例如在某些容器启动脚本或非项目根目录执行时），`SharedSettings` 会使用硬编码的默认值（`database_url = "postgresql+psycopg://postgres:postgres@localhost:5432/..."`）。原代码使用 `os.getenv`，在未设置时会返回 None 从而跳过覆盖。新代码可能导致生产环境迁移脚本意外连接到本地默认数据库，存在严重的安全误操作风险。 - **修改建议**：在 `alembic/env.py` 中获取配置后，增加检查逻辑：如果 `settings.database_url` 等于默认的 localhost 地址且当前环境非 development，应抛出异常或显式警告，防止误连。 ### 💡 建议（1个可选） 1. **packages/config/base.py 第86行**：配置缓存键未包含环境文件路径。 - **具体内容**：`get_cached_settings` 使用类名作为缓存键。如果在运行时修改了 `APP_ENV` 环境变量（例如在测试中切换环境），由于缓存键不变，函数将返回基于旧环境文件加载的配置对象，直到手动调用 `reload_settings_cache`。建议将 `env_file` 的路径或内容哈希纳入缓存键的考量，或者在文档中明确说明切换环境必须调用 reload。 --- ✅ 格式检查通过 | ❌ 逻辑审查需修改 | ⚠️ 建议关注性能 --- _{🤖 由 AI 代码审查机器人自动生成 | 2026-07-23 15:38:00 | 模型:} <!-- AI_CODE_REVIEW_AUTO_COMMENT -->

xiaoxia merged commit ed21ee11d2 into develop 2026-07-23 23:55:01 +08:00

xiaoxia deleted branch refactor/unified-config-entry 2026-07-23 23:55:02 +08:00

gitea-actions bot commented 2026-07-23 23:58:02 +08:00

Copy Link

Copy Source

🗑️ 预览环境已清理

PR #791 已关闭或合并，对应的预览环境已被清理。

如有需要，可以重新打开 PR 来重新生成预览环境。

🗑️ **预览环境已清理** PR #791 已关闭或合并，对应的预览环境已被清理。 > 如有需要，可以重新打开 PR 来重新生成预览环境。

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

P0

阻塞性，必须立即处理

P1

高优先级

P2

中优先级

P3

低优先级/后考虑

architecture

架构设计

backend

后端相关

blocked

阻塞中

bug

Bug修复

ci-bug

CI本身的bug

ci-optimization

CI优化类任务

ci-pipeline

CI流水线/workflow相关

cleanup

代码清理

devops

运维/部署/CI

documentation

文档相关

feature

新功能

frontend

前端相关

question

需要讨论确认

ready

PR CI通过，可合并

refactor

代码重构

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

auto-approve-bot xiaoxia

No Assignees

3 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: xiaoxia/xiaoxia-saas#791