ฉันจะเข้าถึง Configuration ในคลาสใดก็ได้ใน ASP.NET Core ได้อย่างไร

ฉันได้อ่านเอกสารการกำหนดค่าบน 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 คู่ดังนั้นฉันจึงไม่ต้องการใช้รูปแบบตัวเลือก ฉันแค่ต้องการเข้าถึง Configuration ในแอปพลิเคชัน ฉันจะฉีดมันในชั้นเรียนใดได้อย่างไร?

ปรับปรุง

การใช้ 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เป็นพารามิเตอร์ลงในตัวสร้างคลาสของคุณและจะพร้อมใช้งาน

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

ตอนนี้เมื่อคุณต้องการสร้างอินสแตนซ์ของชั้นเรียนของคุณเนื่องจากชั้นเรียนของคุณได้รับการฉีดเข้าไปIConfigurationคุณจะไม่สามารถทำได้new MyClass()เพราะมันต้องการIConfigurationพารามิเตอร์ที่ฉีดเข้าไปในตัวสร้างดังนั้นคุณจะต้องฉีดคลาสของคุณเป็น ดีกับโซ่ฉีดซึ่งหมายถึงสองขั้นตอนง่ายๆ:

1) เพิ่มคลาสของคุณ - ตำแหน่งที่คุณต้องการใช้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ได้อย่างอิสระ ...

อีกทางเลือกหนึ่ง:

หากคุณยังคงมองหาวิธีที่จะทำให้พร้อมใช้งานโดยไม่ต้องฉีดคลาสลงในคอนโทรลเลอร์คุณสามารถจัดเก็บไว้ใน a 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...What can go wrong?

ฉันกำลังทำสิ่งนี้ในขณะนี้:

// 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 ดังนั้นก่อนอื่นฉันเพิ่มการอ้างอิงโดยใช้แล้วจึงแทรกอินเทอร์เฟซ 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"
}

ใน 8-2017 Microsoft ออกมาพร้อมกับSystem.Configuration. NET CORE v4.4 ปัจจุบัน v4.5แสดงตัวอย่างและ v4.6 ในปัจจุบัน

สำหรับพวกเราที่ทำงานเกี่ยวกับการแปลงจาก. Net Framework เป็น CORE นี่เป็นสิ่งสำคัญ อนุญาตให้เก็บและใช้app.configไฟล์ปัจจุบันซึ่งสามารถเข้าถึงได้จากแอสเซมบลีใดก็ได้ อาจเป็นอีกทางเลือกหนึ่งappsettings.jsonเนื่องจาก Microsoft ตระหนักถึงความจำเป็น ใช้งานได้เหมือนเดิมใน FW มีความแตกต่างอย่างหนึ่ง:

ในการใช้งานเว็บ [เช่น ASP.NET CORE เว็บ 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" ของคุณเองและ / หรือต้องการการตั้งค่าสาธารณะสิ่งนี้เหมาะสำหรับคุณ ...

ตัวอย่างที่สมบูรณ์ใช้ได้สำหรับ core 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 ทำการเปลี่ยนแปลงในเวอร์ชันอนาคต ;-)
• ฉันมีการตั้งค่าของฉันในตัวแปรส่วนกลาง
• ฉันสามารถตั้งค่า "เพื่อฟัง url" สำหรับแต่ละอุปกรณ์แอปพลิเคชันทำงานบน (เครื่อง dev ของฉันเซิร์ฟเวอร์อินทราเน็ตและเซิร์ฟเวอร์อินเทอร์เน็ต)
• ฉันสามารถปิดการใช้งานการตั้งค่าได้ด้วยวิธีเดิม (เพียงแค่ตั้งค่า * ไว้ก่อน)
• ฉันสามารถตอบสนองได้หากมีบางอย่างผิดปกติในไฟล์. ini (เช่นพิมพ์ไม่ตรงกัน)
  ถ้า - เช่น - ตั้งค่าประเภทผิด (เช่น * Dummy1 = gew7623 เปิดใช้งานแทน Dummy1 = true) โฮสต์จะแสดงสีแดง ข้อมูลบนคอนโซล (รวมถึงข้อยกเว้น) และฉันสามารถตอบสนองในแอปพลิเคชันได้เช่นกัน (GV.bFehler_Ini ตั้งค่าเป็น true หากมีข้อผิดพลาดกับ. ini)