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

时间:2017-07-05 16:31:50

标签: c# asp.net-core environment-variables asp.net-core-mvc

我正在使用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. "
  },

    ...
    ...
    ...
  }
}

如果我有一个连接字符串的环境变量,那么ConnectionStrings:TestDb文件中appsettings.json的值是什么并不重要。

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

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

但是,当我使用此设置时,当我尝试访问数据库时指示它无法解析连接字符串时出现错误。

我必须假设问题是我在环境变量中指定连接字符串的方式,但经过一段时间在线搜索后,我无法找到一个确切的环境变量值应该是什么样的示例喜欢。例如,我是否需要在整个字符串周围放置前导和尾随单引号?连接字符串的各个部分是否需要单引号或双引号?

任何帮助,例如在环境变量中定义的正确连接字符串的示例,都将非常感激。

3 个答案:

答案 0 :(得分:17)

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

在您粘贴的输出中可以看到:

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=..."

旧答案(针对可能搜索类似问题的其他用户)

连接字符串的约定是Azure Web Apps使用的SQLCONNSTR_MYSQLCONNSTR_SQLAZURECONNSTR_CUSTOMCONNSTR_,但也适用于自托管,VM或任何其他云提供商。

因此,如果您有一个名为CUSTOMCONNSTR_TestDb的环境变量,它将与在

中的appsettings.json中定义它一样
{
    "connectionStrings": {
        "TestDb": "..."
    }
}

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

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上使用双下划线作为级别层次结构,请在{ {1}}用于获取配置 - Linux禁止变量名中的冒号)覆盖:,与

相同
Configuration["My:Settings"]

除非他们最近改变了。

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

答案 1 :(得分:0)

在您的配置中,您有以下这一行:

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

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

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

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

答案 2 :(得分:-1)

如果您不想存储在appsettings中,请将其存储在文件中 C:\ WINDOWS \ SYSTEM32 \ INETSRV \设置\的applicationHost.config。它将能够工作。