2025-05-07-关于API Key 的安全管理办法
为了确保 API Key 的安全性,避免将敏感信息硬编码在代码中,我们可以使用 环境变量 或 配置文件 来管理敏感信息。以下是两种常见且推荐的方法,帮助你实现 API Key 的安全管理:
✅ 方法一:使用环境变量(推荐)
📌 原理说明
环境变量是一种在运行时动态注入配置信息的方式,适用于本地开发、测试环境、CI/CD 管道、以及生产服务器。这种方式可以有效避免敏感信息被提交到版本控制系统中。
🧩 示例代码(Python)
import os
from openai import OpenAIdef cut_title(long_title):# 从环境变量中读取 API Keyapi_key = os.getenv("OPENAI_API_KEY")if not api_key:raise ValueError("API Key 未设置,请设置环境变量 OPENAI_API_KEY")client = OpenAI(base_url='https://api.siliconflow.cn/v1',api_key=api_key)# ... 其余逻辑保持不变 ...
windowh 使用:cmd
set OPENAI_API_KEY=your_api_key_here
✅ 方法二:使用配置文件(如 .env 或 config.json)
📌 原理说明
使用配置文件(如 .env 或 config.json)也是一种常见的做法,尤其适合本地开发。可以使用 python-dotenv 库自动加载 .env 文件中的变量。
🧩 示例代码(使用 .env 文件)
- 安装依赖
pip install python-dotenv
- 创建 .env 文件
OPENAI_API_KEY=your_api_key_here
- 修改 Python 代码
import os
from dotenv import load_dotenv
from openai import OpenAI# 加载 .env 文件
load_dotenv()def cut_title(long_title):api_key = os.getenv("OPENAI_API_KEY")if not api_key:raise ValueError("API Key 未设置,请检查 .env 文件")client = OpenAI(base_url='https://api.siliconflow.cn/v1',api_key=api_key)# ... 其余逻辑保持不变 ...
如何创建.env文件?
🧪 三、在 Python 代码中加载 .env 文件
使用 dotenv 库加载 .env 文件中的变量:
import os
from dotenv import load_dotenv# 加载 .env 文件
load_dotenv()# 获取环境变量
api_key = os.getenv("OPENAI_API_KEY")
db_password = os.getenv("DATABASE_PASSWORD")print(f"API Key: {api_key}")
print(f"Database Password: {db_password}")
🔒 四、安全提示:不要将 .env 提交到 Git 仓库
为了防止 .env 文件被意外提交到 Git 仓库,你需要将它添加到 .gitignore 文件中。
在 .gitignore 文件中添加以下内容:
.env
*.log
__pycache__
*.pyc
*.pyo
*.pyd
✅ 总结
通过使用 环境变量 或 配置文件 ,你可以有效地避免 API Key 被硬编码在代码中,从而提升项目的安全性。对于本地开发,推荐使用 .env 文件配合 python-dotenv;对于生产环境,建议使用专业的密钥管理服务来保障 API Key 的安全。