如何在环境变量中正确存储连接字符串以供生产 ASP.Net Core MVC 应用程序检索

Question

我正在开发一个 ASP.NET Core MVC 应用程序，但我的连接字符串有问题。

我的生产服务器上有一个 ASPNETCORE_ENVIRONMENT 变量设置为 Production，我的生产服务器是运行 IIS 的 Windows Server 2012R2。我还在生产服务器上安装了 DotNetCore.1.0.4_1.1.1-WindowsHosting.exe。

在开发过程中，我使用UserSecrets 来保存我的连接字符串。这工作正常。

对于生产，我希望我的连接字符串在生产服务器上的环境变量中，这就是我遇到问题的地方。我怀疑这可能是我构建环境变量的方式。

当我尝试访问生产中的数据库时，我收到一个错误，表明它无法解析连接字符串。

An exception occurred in the database while iterating the results of a query.

System.ArgumentException: Keyword not supported: '"server'.
at System.Data.Common.DbConnectionOptions.ParseInternal(Dictionary`2 
parsetable, String connectionString, Boolean buildChain, Dictionary`2 synonyms)
at System.Data.Common.DbConnectionOptions..ctor(String connectionString, Dictionary`2 synonyms)
at System.Data.SqlClient.SqlConnectionString..ctor(String connectionString)

如果我将连接字符串放在appSettings.json 中，生产服务器就可以正常工作。

所以，这是我的 appSettings.json 文件的示例，显示了在生产中有效的连接字符串；

{
  "ConnectionStrings": {
     "TestDb": "Server=TestServer;Database=TestDb;Persist Security Info=True;User ID=TestUser;Password=testpassword;MultipleActiveResultSets=true"
  },

    ...
    ...
    ...
  }
}

如果我将此appSettings.json 文件部署到生产环境，它可以正常工作。

在我的 ASP.Net Core 应用程序的 Startup.cs 文件中，我有以下内容；

public Startup(IHostingEnvironment env)
{
    var builder = new ConfigurationBuilder()
        .SetBasePath(env.ContentRootPath)
        .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
        .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true);

    if (env.IsDevelopment())
    {
        // For more details on using the user secret store see https://go.microsoft.com/fwlink/?LinkID=532709
        builder.AddUserSecrets<Startup>();
    }

    builder.AddEnvironmentVariables();
    Configuration = builder.Build();

}

我的理解是最后列出的 builder.add... 具有优先级，所以在我的情况下，如果环境中存在连接字符串，它应该优先于 appsettings 中的任何内容。

所以在生产中，如果我使用下面的 appSettings.config 文件；

{
  "ConnectionStrings": {
     "TestDb": "Placeholder for connection string. Overridden by User Secrets in Development and Environment Variables in Production. "
  },

    ...
    ...
    ...
  }
}

如果我有一个用于连接字符串的环境变量，那么我在该appsettings.json 文件中拥有的ConnectionStrings:TestDb 的值并不重要。

下面列出的是我正在使用的环境变量；

Variable                    Value
ConnectionStrings:TestDb    "Server=TestServer;Database=TestDb;Persist Security Info=True;User ID=TestUser;Password=testpassword;MultipleActiveResultSets=true"

但是，当我使用此设置时，我在尝试访问数据库时收到错误消息，指出它无法解析连接字符串。

我不得不假设问题是我在环境变量中指定连接字符串的方式，但是在网上搜索了一段时间后，我一直无法找到环境变量值应该是什么样子的示例喜欢。例如，我是否需要在整个字符串前后加上单引号？连接字符串的各个部分需要单引号还是双引号？

任何帮助，例如在环境变量中定义的正确连接字符串的示例，将不胜感激。

Answer 1

在您的配置中，您有这一行：

.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true);

这告诉您的配置系统可能存在一个 JSON 文件，其中包含特定于环境的设置。因此，您只需要存在于生产盒中的名为 appSettings.Production.config 的文件，其中包含以下内容：

{
  "ConnectionStrings": {
     "TestDb": "Server=...;Catalog=...;Etc=..."
  }
}

此处的值将覆盖基本 JSON 设置文件中指定的任何内容。

Answer 2

如果不想存入appsettings，存入文件 C:\Windows\System32\inetsrv\config\applicationHost.config。它将能够工作。

Answer 3

在您的连接变量中设置了错字/错误值。

在您粘贴的这个输出中可以看到：

Variable                    Value
ConnectionStrings:TestDb    "Server=TestServer;Database=TestDb;Persist Security Info=True;User ID=TestUser;Password=testpassword;MultipleActiveResultSets=true"

这可能发生在通过设置变量时

$env:ConnectionStrings:MyDb = """Server=..."""

正确的方法是设置不带引号。

$env:ConnectionStrings:MyDb = "Server=..."

旧答案（对于可能搜索类似问题的其他用户）

连接字符串的约定是 SQLCONNSTR_、MYSQLCONNSTR_、SQLAZURECONNSTR_ 和 CUSTOMCONNSTR_，它们供 Azure Web 应用使用，但也适用于自托管、VM 或任何其他云提供商。

因此，如果您有一个名为 CUSTOMCONNSTR_TestDb 的环境变量，它将与在 appsettings.json 中定义它相同

{
    "connectionStrings": {
        "TestDb": "..."
    }
}

如果在.UseJsonFile(...) 之后调用AddEnvironmentVariables()，它也会覆盖其中的值。最后注册获胜。

var builder = new ConfigurationBuilder()
    .SetBasePath(env.ContentRootPath)
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
    .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
    // This one needs to be last
    .AddEnvironmentVariables();

您还可以使用其他变量来覆盖配置值。 iirc。 ASPNETCORE_ 是默认前缀（但您可以在 AddEnvironmentVariables("MY_") 中更改它）。

所以ASPNETCORE_MySettings 覆盖Configuration["MySettings"]（或Configuration.Get("MySettings")）和ASPNETCORE_My__Settings（在Linux 上使用双下划线 表示级别层次结构，阅读: 用于获取配置的位置- Linux 不允许在变量名中使用冒号）覆盖 Configuration["My:Settings"] 与

相同

{
    "my": {
        "settings": "..."
    }
}

除非他们最近改变了这一点。

FWIW：据我记忆，环境变量/配置键名不区分大小写。