OneTimeSecret 项目中的计划配置重构:从硬编码到静态 YAML
2025-07-02 15:09:23作者:仰钰奇
背景与问题分析
OneTimeSecret 作为一个秘密分享服务,长期以来一直采用硬编码的方式管理用户计划(plans)配置。这种传统做法虽然简单直接,但随着项目发展逐渐暴露出几个关键问题:
- 系统能力与功能边界耦合:原有实现将系统能力与功能边界混合在一起,导致职责不清晰
- 配置对象命名冲突:计划配置与核心配置中的
plans对象存在命名冲突 - 业务逻辑耦合:代码库直接使用customer.planid字段进行UI逻辑判断,限制了系统灵活性
解决方案设计
项目团队提出了一个全面的重构方案,主要包含以下几个关键改进点:
1. 配置分离原则
将原本混合在一起的配置拆分为两部分:
- 静态配置(capabilities):定义系统的基础能力,如API访问、邮件功能等
- 可变配置(secret_options):包含可动态调整的参数,如默认TTL、大小限制等
这种分离使得系统核心能力与运行时配置解耦,提高了系统的可维护性。
2. 配置结构优化
对原有配置结构进行了以下调整:
- 将原有的
plans对象重命名为billing,避免命名冲突 - 简化用户类型为"anonymous"和"authenticated"两种基础分类
- 引入层级化的配置结构,提高可读性
3. 术语规范化
采用更准确的术语来描述系统功能,避免直接使用商业化术语,使配置更加面向技术实现而非商业模型。
技术实现细节
新的配置采用YAML格式,分为静态和可变两部分:
静态配置示例
capabilities:
anonymous:
api: true
email: false
custom_domains: false
authenticated:
api: true
email: true
custom_domains: false
可变配置示例
secret_options:
anonymous:
default_ttl: <%= ENV['DEFAULT_TTL'] || nil %>
ttl_options: <%= (ENV['TTL_OPTIONS'] || nil) %>
standard:
default_ttl: null
ttl_options: null
size: null
迁移注意事项
对于现有安装环境,需要注意:
- 部分环境变量将变为废弃状态
- 系统会通过迁移自动创建
etc/mutable.yaml文件 - 初始加载时会使用环境变量值设置匿名用户配置
- 后续所有变更必须通过数据库进行
未来扩展性
这种新的配置架构为系统带来了更好的扩展性:
- 可以轻松支持A/B测试等灵活的功能部署
- 便于引入团队级别或对象级别的细粒度权限控制
- 配置变更不再需要代码部署,提高了运维效率
总结
OneTimeSecret 的这次配置重构从架构层面解决了长期存在的技术债务,通过合理的职责分离和配置规范化,为项目的长期健康发展奠定了坚实基础。这种从硬编码到声明式配置的转变,也是现代软件开发中配置管理的最佳实践。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00
jiuwenclawJiuwenClaw 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。Python0193- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
AtomGit城市坐标计划AtomGit 城市坐标计划开启!让开源有坐标,让城市有星火。致力于与城市合伙人共同构建并长期运营一个健康、活跃的本地开发者生态。01
awesome-zig一个关于 Zig 优秀库及资源的协作列表。Makefile00
项目优选
收起
deepin linux kernel
C
27
12
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
601
4.04 K
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
Ascend Extension for PyTorch
Python
441
531
AscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优
C++
112
170
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.46 K
825
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
922
770
暂无简介
Dart
847
204
React Native鸿蒙化仓库
JavaScript
321
375
openGauss kernel ~ openGauss is an open source relational database management system
C++
174
249