常用的配置文件格式对比(ini,toml,yaml,json,env,settings.py)及应用程序修改自身配置并保留注释

代码与环境配置解耦

git分支的代码应做到“环境无关”:代码本身不硬编码任何环境特定的配置(如数据库连接、密钥、API地址),而是通过外部机制动态注入。

配置与代码分离:将配置信息存储在代码库之外(如环境变量、独立配置文件、密钥管理服务),避免提交到 Git 仓库。

环境变量/配置文件 随便用,对内存的影响完全可以忽略不记
案例:典型 Web 应用的配置
  • 环境变量:约 10 个变量(如数据库 URL、API 密钥、调试模式),总大小约 1KB
  • 配置文件:一个 500 行的 JSON 文件(约 5KB),解析后内存占用约 10-20KB
  • 总内存影响:不到 50KB,远低于一个简单 Python 对象(如空列表占用 40KB)。

对于YAML和TOML的选择来说,我更倾向于TOML,主要是TOML对缩进及空格数量不敏感,YAML的缩进和横杠-真烦啊!

各种配置文件的优缺点对比

配置格式语法复杂度结构化数据支持注释支持数据类型支持适用场景解析库
.ini差(仅支持键值对)否(所有值为字符串)小型应用configparser
settings.py强(Python 代码)Django/Python 项目Python 直接解析
.env差(仅键值对)否(所有值为字符串)12 Factor Apppython-dotenv
json强(嵌套支持)Web 开发、APIjson
yaml强(嵌套支持)DevOps、KubernetesPyYAML
toml强(嵌套支持)Python/Rust 配置toml

选择合适的配置文件

  • Web 开发/Djangosettings.py
  • 存储环境变量/API 密钥.env
  • 前后端通用配置、API 交互json
  • DevOps/Kubernetesyaml
  • Python、Rust 工程配置toml
  • 小型桌面应用、简单配置.ini

在 Web 应用中,使用数据库存储用户配置(如用户偏好、通知设置、API 密钥等)是一种常见的方法。与 .env、配置文件或环境变量相比,数据库存储具有更强的可管理性,但也存在一定的性能和安全性问题。下面是数据库存储用户配置的优缺点分析实现方式

Python 代码(Django ORM)

from django.db import models

class UserSettings(models.Model):
    user = models.OneToOneField("auth.User", on_delete=models.CASCADE)
    theme = models.CharField(max_length=50, default="light")
    notifications = models.BooleanField(default=True)
    language = models.CharField(max_length=10, default="en")
    updated_at = models.DateTimeField(auto_now=True)

查询用户配置

settings = UserSettings.objects.get(user=request.user)
print(settings.theme)  # "light"

应用程序修改自身配置并保留注释

通常情况下,配置文件(如 .ini, .env, .yaml, .toml, .json)主要用于存储应用的静态配置,而应用程序一般只读取配置。但在某些特定场景下,应用程序允许修改自身的配置文件。

配置格式只读解析库解决方案(修改保存)
.iniconfigparser使用 ConfigObj
.envdotenv_values手动读取/合并
.yamlPyYAML使用 ruamel.yaml
.tomltoml使用 tomlkit
.jsonjson使用 commentjson
from configobj import ConfigObj

config = ConfigObj("config.ini", encoding="utf-8")

# 修改配置
config["settings"]["theme"] = "dark"

# 保存时会保留注释
config.write()

from tomlkit import parse

with open("config.toml", "r") as f:
    toml_data = parse(f.read())

# 修改配置
toml_data["app"]["debug"] = False

# 保存 (保留注释)
with open("config.toml", "w") as f:
    f.write(toml_data.as_string())

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值