时间戳

首页 > 解决方案 > C#如何定义api键等全局常量并防止上传到Github

c# - C#如何定义api键等全局常量并防止上传到Github

问题描述

我正在开发一个 Visual Studio C# 项目（.net 4.7.2），我需要将一些私有 API 密钥存储为常量。该项目已上传到公共 github 存储库，但我不希望共享 API 密钥。
实现这一目标的最佳实践是什么？

似乎如果我创建一个包含常量值的静态类的常量类文件，然后通过 .gitignore 省略文件，该项目将不会为下载它的其他用户构建，因为该文件将丢失。如果我先上传文件的骨架，然后通过 .gitignore 省略它，如果我稍后更改或添加新常量，它将不会更新。

我正在寻找实现这一目标的最佳实践。

标签： c#gitgithubconstants

解决方案

我经常看到并且我个人使用的模式：

  • 创建一个骨架文件settings.json.sample，并为您的键放置占位符值
  • 将该文件复制到settings.json并放入实际值
  • 添加settings.json到.gitignore
  • 在自述文件中添加说明以重命名settings.json.sample并settings.json填充实际值

推荐阅读