Bagaimana cara mengakses Konfigurasi di semua kelas di ASP.NET Core?

Saya telah melalui dokumentasi konfigurasi pada inti ASP.NET. Dokumentasi mengatakan Anda dapat mengakses konfigurasi dari mana saja dalam aplikasi.

Di bawah ini adalah Startup.cs yang dibuat oleh template

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();
    }
}

Jadi dalam Startup.cskami mengkonfigurasi semua pengaturan, Startup.cs juga memiliki properti bernamaConfiguration

Apa yang saya tidak dapat mengerti bagaimana Anda mengakses konfigurasi ini di pengontrol atau di mana pun dalam aplikasi? MS merekomendasikan untuk menggunakan pola opsi tetapi saya hanya memiliki 4-5 pasangan nilai kunci jadi saya tidak ingin menggunakan pola opsi. Saya hanya ingin memiliki akses ke Konfigurasi dalam aplikasi. Bagaimana cara menyuntikkannya di kelas mana pun?

Memperbarui

Menggunakan ASP.NET Core 2.0 akan secara otomatis menambahkan IConfigurationinstance aplikasi Anda di wadah injeksi ketergantungan. Ini juga bekerja bersama dengan ConfigureAppConfigurationdi WebHostBuilder.

Sebagai contoh:

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

    host.Run();
}

Ini semudah menambahkan IConfigurationinstance ke koleksi layanan sebagai objek tunggal di ConfigureServices:

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

   // ...
}

Di mana Configurationcontoh di Startupkelas Anda .

Ini memungkinkan Anda untuk memasukkan IConfigurationpengontrol atau layanan apa pun:

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

Cara yang benar untuk melakukannya:

Di .NET Core Anda dapat memasukkan IConfigurationsebagai parameter ke konstruktor Kelas Anda, dan itu akan tersedia.

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

Sekarang, ketika Anda ingin membuat sebuah instance dari kelas Anda, karena kelas Anda diinjeksi IConfiguration, Anda tidak akan dapat melakukannya begitu saja new MyClass(), karena ini membutuhkan IConfigurationparameter yang dimasukkan ke dalam konstruktor, jadi, Anda perlu memasukkan kelas Anda sebagai baik ke rantai injeksi, yang berarti dua langkah sederhana:

1) Tambah Kelas / es - di mana Anda ingin menggunakan IConfiguration, untuk IServiceCollectiondi ConfigureServices()metode dalamStartup.cs

services.AddTransient<MyClass>();

2) Definisikan sebuah instance - katakanlah di Controller, dan masukkan menggunakan konstruktor:

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

Sekarang Anda harus dapat menikmati _myClass.configuration...

Pilihan lain:

Jika Anda masih mencari cara untuk membuatnya tersedia tanpa harus memasukkan kelas ke dalam pengontrol, maka Anda dapat menyimpannya di static class, yang akan Anda konfigurasikan di Startup.cs, seperti:

public static class MyAppData
{
    public static IConfiguration Configuration;
}

Dan Startupkonstruktor Anda akan terlihat seperti ini:

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

Kemudian gunakan MyAppData.Configurationdi mana saja di program Anda.

Jangan tanyakan kepada saya mengapa opsi pertama adalah cara yang benar, saya hanya bisa melihat pengembang berpengalaman selalu menghindari data sampah di sepanjang jalan mereka, dan sangat dipahami bahwa bukan praktik terbaik untuk memiliki banyak data yang tersedia di memori setiap saat, juga tidak baik untuk kinerja dan atau untuk pengembangan, dan mungkin juga lebih aman untuk hanya membawa apa yang Anda butuhkan.

Saya tahu ini sudah tua tetapi mengingat pola IOptions relatif sederhana untuk diterapkan:

1. Kelas dengan properti get / set publik yang cocok dengan pengaturan dalam konfigurasi

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

2. daftarkan pengaturan Anda

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

3. menyuntikkan melalui IOptions

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

Saya tidak yakin mengapa Anda tidak melakukan ini begitu saja.

Saya melakukannya seperti ini sekarang:

// 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;
        }
    }
}

Dan kemudian saya menggunakan ini di mana saya perlu mendapatkan data dari file appsettings.json:

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

Ada juga opsi untuk membuat configurationstatis di startup.cs sehingga apa yang bisa Anda akses di mana saja dengan mudah, variabel statis nyaman ya!

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

internal static IConfiguration Configuration { get; private set; }

Ini membuat konfigurasi dapat diakses di mana saja menggunakan Startup.Configuration.GetSection...Apa yang bisa salah?

Saya melihat ke contoh pola opsi dan melihat ini:

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;
    }
...
}

Saat menambahkan Iconfiguration di konstruktor kelas saya, saya dapat mengakses opsi konfigurasi melalui DI.

Contoh:

public class MyClass{

    private Iconfiguration _config;

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

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

Saya tahu mungkin ada beberapa cara untuk melakukan ini, saya menggunakan Core 3.1 dan sedang mencari opsi optimal / bersih dan akhirnya saya melakukan ini:

1. Kelas startup saya sebagai default

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 saya seperti ini

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

3. Kelas saya adalah Pengontrol API, jadi pertama-tama saya menambahkan referensi penggunaan dan kemudian menyuntikkan antarmuka IConfiguration

using Microsoft.Extensions.Configuration;

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

4. Akhirnya saya menggunakan metode GetValue

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

Pada 8-2017 Microsoft keluar dengan System.Configurationuntuk .NET CORE v4.4. Saat ini pratinjau v4.5 dan v4.6.

Bagi kita, yang mengerjakan transformasi dari .Net Framework ke CORE, ini penting. Ini memungkinkan untuk menyimpan dan menggunakan app.configfile saat ini , yang dapat diakses dari perakitan apa pun. Bahkan mungkin bisa menjadi alternatif appsettings.json, karena Microsoft menyadari kebutuhannya. Ini bekerja sama seperti sebelumnya di FW. Ada satu perbedaan:

Dalam aplikasi web, [mis. ASP.NET CORE WEB API] Anda perlu menggunakan app.configdan bukan web.config untuk appSettingsatau configurationSection. Anda mungkin perlu menggunakan web.configtetapi hanya jika Anda menyebarkan situs Anda melalui IIS. Anda menempatkan pengaturan khusus IIS keweb.config

Saya telah mengujinya dengan netstandard20 DLL dan Asp.net Core Web Api dan semuanya berfungsi.

Menggunakan pola Opsi di ASP.NET Core adalah cara yang harus dilakukan. Saya hanya ingin menambahkan, jika Anda perlu mengakses opsi dalam startup.cs Anda , saya sarankan untuk melakukannya dengan cara ini:

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)];
}

Saya harus membaca parameter sendiri saat memulai.
Itu harus ada di sana sebelum WebHost dimulai (karena saya membutuhkan url / IP "untuk mendengarkan" dan port dari file parameter dan menerapkannya ke WebHost). Selanjutnya, saya membutuhkan pengaturan publik di seluruh aplikasi.

Setelah mencari beberapa saat (tidak ada contoh lengkap yang ditemukan, hanya cuplikan) dan setelah berbagai coba-coba, saya memutuskan untuk melakukannya dengan "cara lama" dengan file .ini sendiri.
Jadi .. jika Anda ingin menggunakan memiliki file .ini dan / atau mengatur "untuk mendengarkan url / IP" Anda sendiri dan / atau memerlukan pengaturan publik, ini untuk Anda ...

Contoh lengkap, valid untuk core 2.1 (mvc):

Buat file .ini - contoh:

[Memulai]
URL = http://172.16.1.201:22222
[Parameter]
* Dummy1 = gew7623
Dummy1 = true
Dummy2 = 1

dimana Dummyx hanya disertakan sebagai contoh untuk tipe tanggal lain selain string (dan juga untuk menguji kasus “salah param” (lihat kode di bawah).

Menambahkan file kode di root proyek, untuk menyimpan variabel global:

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... 
}

Mengubah kode di program.cs (sebelum 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

    }
}

Cara ini:

• Konfigurasi Aplikasi saya dipisahkan dari appsettings.json dan saya tidak memiliki efek samping yang perlu ditakuti, jika MS memang berubah di versi mendatang ;-)
• Saya memiliki pengaturan saya di variabel global
• Saya dapat menyetel "untuk mendengarkan url" untuk setiap perangkat, aplikasi dijalankan (mesin dev saya, server intranet dan server internet)
• Saya dapat menonaktifkan pengaturan, dengan cara lama (cukup setel * sebelumnya)
• Saya dapat bereaksi, jika ada yang salah dalam file .ini (mis. Tipe mismatch)
  Jika - eg - tipe yang salah disetel (mis. * Dummy1 = gew7623 diaktifkan alih-alih Dummy1 = true) host menunjukkan warna merah informasi ada di konsol (termasuk pengecualian) dan saya dapat bereaksi juga dalam aplikasi (GV.bFehler_Ini ist disetel ke true, jika ada kesalahan dengan .ini)