ASP.NET Coreのクラスの構成にアクセスするにはどうすればよいですか？

私が通過した構成ドキュメント ASP.NETコア上。ドキュメントには、アプリケーションのどこからでも設定にアクセスできると記載されています。

以下は、テンプレートによって作成された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ではIConfiguration、Classコンストラクターにパラメーターとしてを挿入できます。これを使用できます。

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

ここで、クラスのインスタンスを作成する場合、クラスにが注入されるため、コンストラクターに注入されるパラメーターが必要なため、IConfigurationだけでは実行できません。したがって、クラスを次のように注入する必要があります。インジェクションチェーンには、次の2つの簡単な手順が必要です。new MyClass()IConfiguration

あなたが使用したい- 1）あなたのクラス/ ESを追加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. 構成の設定と一致するパブリックのget / setプロパティを持つクラス

   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にstatic を作成するオプションがあるため、どこにでも簡単にアクセスでき、static変数は便利です。

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
}

これを行うにはいくつかの方法がある可能性があることを知っています。Core3.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月、MicrosoftはSystem.Configuration.NET CORE v4.4をリリースしました。現在、v4.5およびv4.6プレビュー。

.Net FrameworkからCOREへの変換に取り組んでいる私たちにとって、これは不可欠です。現在のapp.configファイルを保持して使用することができ、任意のアセンブリからアクセスできます。それはおそらく代替手段になることさえありますappsettings.jsonMicrosoftがその必要性に気付いたので、あります。FWでも以前と同じように機能します。違いが1つあります。

Webアプリケーション（[ASP.NET CORE WEB API] app.configなど）では、appSettingsまたはのweb.configではなく、使用する必要がありますconfigurationSection。を使用する必要があるかもしれませんが、web.configIIS経由でサイトを展開する場合のみです。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ファイルを所有するか、独自の「to listen 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が将来のバージョンで変更を行う場合、恐れる副作用はありません;-)
• グローバル変数に設定があります
• 各デバイスの "to listen url"を設定することができ、アプリケーションが実行されます（私の開発マシン、イントラネットサーバー、インターネットサーバー）。
• 古い方法で設定を無効にできます（前に*を設定するだけです）
• .iniファイルに問題がある
  場合（タイプの不一致など）、対応できます。例：間違ったタイプが設定されている（たとえば、Dummy1 = trueの代わりに* Dummy1 = gew7623がアクティブになっている）ホストが赤で表示される情報はコンソールにあり（例外を含む）、アプリケーションでも反応できます（.iniにエラーがある場合、GV.bFehler_Iniはtrueに設定されます）