通过 
搜索
搜索devkraken / kraken-env-keeper
一个简单高效的PHP库，用于从.env文件中读取环境变量。此包提供了一个强大且具有异常处理的机制，以确保应用程序中环境变量的可靠访问。它允许使用可选的默认值，并且可以轻松集成到您的应用程序中。
v1.0.0
2024-09-03 19:44 UTC
Requires
- php: ^8.3
Requires (Dev)
- phpunit/phpunit: ^11.2@dev
README
KrakenEnvKeeper是一个Composer包，它帮助您从PHP应用程序中的专用.env文件安全地加载和访问环境变量。它提供了一种方便且可靠的敏感数据管理方式。
✨ 特点
- 🔒 从指定的
.env文件安全地加载环境变量。 - 🚨 捕获缺失的变量并抛出异常，以实现更好的错误处理。
- 🚀 通过缓存加载的变量来优化性能。
- 👀 监控
.env文件的变化，在必要时自动重新加载变量。
📝 其他说明
🛡️ 安全注意事项
- ⚠️ 绝对不要 将您的
.env文件存储在版本控制系统（如Git）中。 - 🔐 考虑使用环境变量加密来进一步增强安全性，特别是在生产环境中。加密为您的敏感数据提供了额外的保护层。
⚡ 错误处理
get方法对缺失的变量抛出异常。如果某些情况下可能期望缺失变量，请提供自定义默认值以避免这些异常。这可以提高代码流程和可读性。
🗂️ 可自定义文件路径
- 构造函数允许自定义
.env文件的位置。默认情况下，它在项目的根目录中查找名为.env的文件。您可以根据项目结构进行调整。
💾 缓存优化
- 缓存通过防止不必要的文件重新加载来帮助提高性能。对于复杂的设置，您可能需要考虑替代缓存机制以优化性能。
⚠️ 开发模式注意
请注意，这是KrakenEnvKeeper的开发版本。功能和API可能会发生变化。请考虑在生产环境中使用稳定版本。
🚀 安装
-
使用Composer要求此包
composer require devkraken/kraken-env-keeper
-
(可选) 自定义.env文件路径
默认情况下，KrakenEnvKeeper在项目的根目录中查找名为.env的文件。如果您希望使用不同的位置，请更新您的代码中的构造函数调用
🔧 使用
-
加载环境变量
$envKeeper = new DevKraken\KrakenEnvKeeper(); $envKeeper->load();
-
访问环境变量
-
使用
get方法检索特定变量$apiKey = $envKeeper->get('API_KEY');
-
使用
has方法检查变量是否存在if ($envKeeper->has('DEBUG_MODE')) { // Enable debugging if set }
🤝 贡献
我们欢迎对KrakenEnvKeeper的贡献以提高其质量！以下是您可以参与的途径
- 分支存储库：访问项目的GitHub存储库（稍后提供链接）并将其分支到您的帐户。
- 创建分支：为您的更改创建一个新的分支。
- 实现您的更改：根据需要修改代码、添加测试和改进文档。
- 提交您的更改：使用清晰简洁的消息提交您的更改。
- 创建拉取请求：在上游存储库上打开拉取请求，概述您的建议更改。
📄 许可证
本项目采用MIT许可证。请参阅LICENSE文件以获取详细信息。