我正在开发一个 Visual Studio C# 项目 (.net 4.7.2),我需要将一些私有(private) API key 存储为常量。该项目已上传到公共(public) github 存储库,但我不希望共享 API key 。
实现这一目标的最佳实践是什么?
如果我使用包含常量值的静态类创建一个常量类文件,然后通过 .gitignore 省略文件,该项目将不会为下载它的其他用户构建,因为该文件将丢失。如果我先上传文件的骨架,然后通过 .gitignore 省略它,那么如果我稍后更改或添加新常量,它不会更新。
我正在寻找实现这一目标的最佳实践。
最佳答案
我经常看到并且我个人使用的模式:
- 创建一个框架文件,例如
settings.json.sample
并为您的键添加占位符值 - 将该文件复制到
settings.json
并输入实际值 - 将
settings.json
添加到.gitignore
- 在自述文件中添加说明,将
settings.json.sample
重命名为settings.json
并填充实际值
关于C#如何定义api key 等全局常量并防止上传到Github,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64159432/