OneTimeSecret 项目中的计划配置重构:从硬编码到静态 YAML
2025-07-02 08:23:30作者:仰钰奇
背景与问题分析
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 的这次配置重构从架构层面解决了长期存在的技术债务,通过合理的职责分离和配置规范化,为项目的长期健康发展奠定了坚实基础。这种从硬编码到声明式配置的转变,也是现代软件开发中配置管理的最佳实践。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C081
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python056
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0135
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
465
3.46 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
197
80
暂无简介
Dart
715
172
Ascend Extension for PyTorch
Python
273
311
React Native鸿蒙化仓库
JavaScript
285
331
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
845
424
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.26 K
693
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
106
120