如何在ASP.NET Core中的任何类中访问Configuration？

我已经阅读了ASP.NET Core上的配置文档。文档说您可以从应用程序中的任何位置访问配置。

以下是模板创建的Startup.cs

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

        if (env.IsEnvironment("Development"))
        {
            // This will push telemetry data through Application Insights pipeline faster, allowing you to view results immediately.
            builder.AddApplicationInsightsSettings(developerMode: true);
        }

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

    public IConfigurationRoot Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container
    public void ConfigureServices(IServiceCollection services)
    {
        // Add framework services.
        services.AddApplicationInsightsTelemetry(Configuration);

        services.AddMvc();
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline
    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        loggerFactory.AddConsole(Configuration.GetSection("Logging"));
        loggerFactory.AddDebug();

        app.UseApplicationInsightsRequestTelemetry();

        app.UseApplicationInsightsExceptionTelemetry();

        app.UseMvc();
    }
}

因此，在Startup.cs我们配置所有设置时，Startup.cs也有一个名为Configuration

我不明白如何在控制器或应用程序中的任何位置访问此配置？MS建议使用选项模式，但是我只有4-5个键值对，因此我不想使用选项模式。我只是想访问应用程序中的配置。如何在任何课程中注入它？

更新资料

使用ASP.NET Core 2.0会将应用程序的实例自动添加IConfiguration到依赖项注入容器中。这也适用于连同ConfigureAppConfiguration上WebHostBuilder。

例如：

public static void Main(string[] args)
{
    var host = WebHost.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration(builder =>
        {
            builder.AddIniFile("foo.ini");
        })
        .UseStartup<Startup>()
        .Build();

    host.Run();
}

就像将IConfiguration实例作为单例对象添加到服务集合一样简单ConfigureServices：

public void ConfigureServices(IServiceCollection services)
{
   services.AddSingleton<IConfiguration>(Configuration);

   // ...
}

类中Configuration的实例在哪里Startup。

这使您可以注入IConfiguration任何控制器或服务：

public class HomeController
{
   public HomeController(IConfiguration configuration)
   {
      // Use IConfiguration instance
   }
}

正确的方法：

在.NET Core中，您可以将IConfigurationas作为参数注入到您的Class构造函数中，它将可用。

public class MyClass 
{
    private IConfiguration configuration;
    public MyClass(IConfiguration configuration)
    {
        ConnectionString = new configuration.GetValue<string>("ConnectionString");
    }

现在，当您要创建类的实例时，由于您的类被注入IConfiguration，您将无法执行操作new MyClass()，因为它需要将一个IConfiguration参数注入构造函数中，因此，您需要将类注入为对注入链而言，这意味着两个简单的步骤：

1）将您的Classes添加IConfiguration到IServiceCollection中的ConfigureServices()方法中Startup.cs

services.AddTransient<MyClass>();

2）定义一个实例-假设在中Controller，然后使用构造函数将其注入：

public class MyController : ControllerBase
{
    private MyClass _myClass;
    public MyController(MyClass myClass)
    {
        _myClass = myClass;
    }

现在您应该可以_myClass.configuration自由地享受自己的生活了...

另外的选择：

如果您仍在寻找一种无需将类注入控制器即可使用的方法，则可以将其存储在中static class，将在中进行配置Startup.cs，例如：

public static class MyAppData
{
    public static IConfiguration Configuration;
}

您的Startup构造函数应如下所示：

public Startup(IConfiguration configuration)
{
    Configuration = configuration;
    MyAppData.Configuration = configuration;
}

然后MyAppData.Configuration在程序中的任何地方使用。

不要面对我，为什么第一个选择是正确的方法，我可以看到有经验的开发人员始终避免使用垃圾数据，并且众所周知，始终将大量数据存储在内存中不是最佳实践，它既不对性能和开发都没有好处，而且仅随身携带所需的东西也许也更安全。

我知道这很老，但是鉴于IOptions模式实现起来相对简单：

1. 具有与配置中的设置相匹配的公共获​​取/设置属性的类

   public class ApplicationSettings
   {
       public string UrlBasePath { get; set; }
   }

2. 注册设置

   public void ConfigureServices(IServiceCollection services)
   {
    ...
    services.Configure<ApplicationSettings>(Configuration.GetSection("ApplicationSettings"));
   ...
   }

3. 通过IOptions注入

   public class HomeController
   {
      public HomeController(IOptions<ApplicationSettings> appSettings)
      { ...
       appSettings.Value.UrlBasePath
       ...
       // or better practice create a readonly private reference
       }
    }

我不确定您为什么不这样做。

configuration在startup.cs中还有一个使静态的选项，这样您就可以轻松地在任何地方访问它，方便使用静态变量！

public Startup(IConfiguration configuration)
{
    Configuration = configuration;
}

internal static IConfiguration Configuration { get; private set; }

这使配置在任何地方都可以使用Startup.Configuration.GetSection...哪里会出问题？

我现在正在这样做：

// Requires NuGet package Microsoft.Extensions.Configuration.Json

using Microsoft.Extensions.Configuration;
using System.IO;

namespace ImagesToMssql.AppsettingsJson
{
    public static class AppSettingsJson
    {           
        public static IConfigurationRoot GetAppSettings()
        {
            string applicationExeDirectory = ApplicationExeDirectory();

            var builder = new ConfigurationBuilder()
            .SetBasePath(applicationExeDirectory)
            .AddJsonFile("appsettings.json");

            return builder.Build();
        }

        private static string ApplicationExeDirectory()
        {
            var location = System.Reflection.Assembly.GetExecutingAssembly().Location;
            var appRoot = Path.GetDirectoryName(location);

            return appRoot;
        }
    }
}

然后在需要从appsettings.json文件获取数据的地方使用它：

var appSettingsJson = AppSettingsJson.GetAppSettings();
// appSettingsJson["keyName"]

我查看了选项模式示例并看到了以下内容：

public class Startup
{
    public Startup(IConfiguration config)
    {
        // Configuration from appsettings.json has already been loaded by
        // CreateDefaultBuilder on WebHost in Program.cs. Use DI to load
        // the configuration into the Configuration property.
        Configuration = config;
    }
...
}

在类的构造函数中添加Iconfiguration时，我可以通过DI访问配置选项。

例：

public class MyClass{

    private Iconfiguration _config;

    public MyClass(Iconfiguration config){
        _config = config;
    }

    ... // access _config["myAppSetting"] anywhere in this class
}

我知道可能有几种方法可以做到这一点，我使用的是Core 3.1，并且正在寻找最佳/清洁选项，最后我这样做了：

1. 我的启动课程是默认的

public Startup(IConfiguration configuration)
{
    Configuration = configuration;
}

public IConfiguration Configuration { get; }

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
}

2. 我的appsettings.json是这样的

{
  "CompanySettings": {
    "name": "Fake Co"
  }
}

3. 我的课程是API控制器，因此首先添加了using引用，然后注入了IConfiguration接口

using Microsoft.Extensions.Configuration;

public class EmployeeController 
{
    private IConfiguration _configuration;
    public EmployeeController(IConfiguration configuration)
    {
        _configuration = configuration;
    }
}

4. 最后我使用了GetValue方法

public async Task<IActionResult> Post([FromBody] EmployeeModel form)
{
    var companyName = configuration.GetValue<string>("CompanySettings:name");
    // companyName = "Fake Co"
}

在2017年8月8日，Microsoft推出System.Configuration了.NET CORE v4.4 版本。当前v4.5和v4.6预览。

对于那些致力于从.Net Framework到CORE转换的人们来说，这是至关重要的。它允许保留和使用当前app.config文件，可以从任何程序集访问该文件。appsettings.json由于Microsoft意识到了它的必要性，因此它甚至可以替代。与以前的固件相同。有一个区别：

在Web应用程序，[如ASP.NET核心Web API]你需要使用app.config并没有为你的web.config appSettings或configurationSection。您可能需要使用，web.config但仅当您通过IIS部署站点时才需要使用。您将特定于IIS的设置放入web.config

我已经用netstandard20 DLL和Asp.net Core Web Api测试了它，并且一切正常。

在ASP.NET Core中使用选项模式是可行的方法。我只想添加，如果您需要访问startup.cs中的选项，我建议这样做：

CosmosDbOptions.cs：

public class CosmosDbOptions
{
    public string ConnectionString { get; set; }
}

Startup.cs：

public void ConfigureServices(IServiceCollection services)
{
    // This is how you can access the Connection String:
    var connectionString = Configuration.GetSection(nameof(CosmosDbOptions))[nameof(CosmosDbOptions.ConnectionString)];
}

我必须在启动时读取自己的参数。在启动WebHost 之前
，必须存在该位置（因为我需要“侦听”参数文件中的url / IP和端口并将其应用于WebHost）。此外，我需要在整个应用程序中公开设置。

搜索了一会儿（不完整的示例中，仅段），并经过多方尝试和错误的，我已经决定这样做了“老办法”用自己的.ini文件。之后
所以..如果你想用你的拥有.ini文件和/或自行设置“侦听url / IP”和/或需要公共设置，这是给您的...

完整示例，对核心2.1（mvc）有效：

创建一个.ini文件-示例：

[启动]
URL = http://172.16.1.201:22222
[参数]
* Dummy1 = gew7623
Dummy1 = true
Dummy2 = 1

因此，仅将Dummyx作为字符串以外的其他日期类型的示例（并用于测试“错误的参数”情况）（请参见下面的代码）。

在项目的根目录中添加了一个代码文件，用于存储全局变量：

namespace MatrixGuide
{
    public static class GV
    {
        // In this class all gobals are defined

        static string _cURL;
        public static string cURL // URL (IP + Port) on that the application has to listen
        {
            get { return _cURL; }
            set { _cURL = value; }
        }

        static bool _bdummy1;
        public static bool bdummy1 // 
        {
            get { return _bdummy1; }
            set { _bdummy1 = value; }
        }

        static int _idummy1;
        public static int idummy1 // 
        {
            get { return _idummy1; }
            set { _idummy1 = value; }
        }

        static bool _bFehler_Ini;
        public static bool bFehler_Ini // 
        {
            get { return _bFehler_Ini; }
            set { _bFehler_Ini = value; }
        }

        // add further  GV variables here..
    }
    // Add further classes here... 
}

更改了program.cs中的代码（在CreateWebHostBuilder（）之前）：

namespace MatrixGuide
{
    public class Program
    {
        public static void Main(string[] args)
        {
            // Read .ini file and overtake the contend in globale
            // Do it in an try-catch to be able to react to errors
            GV.bFehler_Ini = false;
            try
            {
                var iniconfig = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddIniFile("matrixGuide.ini", optional: false, reloadOnChange: true)
                .Build();
                string cURL = iniconfig.GetValue<string>("Startup:URL");
                bool bdummy1 = iniconfig.GetValue<bool>("Parameter:Dummy1");
                int idummy2 = iniconfig.GetValue<int>("Parameter:Dummy2");
                //
                GV.cURL = cURL;
                GV.bdummy1 = bdummy1;
                GV.idummy1 = idummy2;
            }
            catch (Exception e)
            {
                GV.bFehler_Ini = true;
                Console.ForegroundColor = ConsoleColor.Red;
                Console.WriteLine("!! Fehler beim Lesen von MatrixGuide.ini !!");
                Console.WriteLine("Message:" + e.Message);
                if (!(e.InnerException != null))
                {
                    Console.WriteLine("InnerException: " + e.InnerException.ToString());
                }

                Console.ForegroundColor = ConsoleColor.White;
            }
            // End .ini file processing
            //
            CreateWebHostBuilder(args).Build().Run();
        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
            .UseStartup<Startup>() //;
            .UseUrls(GV.cURL, "http://localhost:5000"); // set the to use URL from .ini -> no impact to IISExpress

    }
}

这条路：

• 我的应用程序配置与appsettings.json分开，并且如果MS在将来的版本中进行了更改，我也没有担心的副作用；-)
• 我在全局变量中有设置
• 我能够为每台设备（运行我的开发机，Intranet服务器和Internet服务器）上的applicaton设置“侦听url”
• 我可以停用设置的旧方法（只需在之前设置*）
• 我可以做出反应，如果.ini文件中有问题（例如类型不匹配），
  如果-例如-设置了错误的类型（例如* Dummy1 = gew7623被激活，而不是Dummy1 = true），则主机显示红色信息在控制台上（包括异常），并且我也可以在应用程序中做出反应（如果.ini错误，则将GV.bFehler_Ini ist设置为true）