Technology Sharing

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

Reading custom configuration files in .NET Core is a common requirement, especially when the standardappsettings.json、appsettings.Development.jsonorappsettings.Production.jsonWhen the configuration files are not sufficient to meet your application needs, here are the steps to read custom configuration files:

1. Create a custom configuration file

First, create a custom configuration file in your project root directory or wherever you think is appropriate, such asmycustomsettings.json。

2. Define the configuration class

Next, you need to define a class that matches your custom configuration file structure.mycustomsettings.jsonThe content is as follows:

{  
  "MyCustomSettings": {  
    "Key1": "Value1",  
    "Key2": "Value2"  
  }  
}

You can define the following configuration class:

public class MyCustomSettings  
{  
    public string Key1 { get; set; }  
    public string Key2 { get; set; }  
}  
  
public class MyCustomSettingsOptions  
{  
    public MyCustomSettings MyCustomSettings { get; set; }  
}

3. InStartup.csConfiguring and reading configuration

exist.NET CoreAppliedStartup.csIn the file, you need toConfigureServicesmethod and add it to the dependency injection container.

public void ConfigureServices(IServiceCollection services)  
{  
    // 添加对自定义配置文件的支持  
    var builder = new ConfigurationBuilder()  
        .SetBasePath(Directory.GetCurrentDirectory())  
        .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)  
        .AddJsonFile("mycustomsettings.json", optional: true, reloadOnChange: true); // 添加自定义配置文件  
  
    IConfigurationRoot configuration = builder.Build();  
  
    // 绑定配置到MyCustomSettingsOptions类  
    services.Configure<MyCustomSettingsOptions>(configuration.GetSection("MyCustomSettings"));  
  
    // 其他服务配置...  
  
    services.AddControllers();  
    // 其他配置...  
}

4. Inject and use configuration in controllers or other classes

Now you can use it in your controllers or other services via dependency injectionMyCustomSettingsOptions.

[ApiController]  
[Route("[controller]")]  
public class MyController : ControllerBase  
{  
    private readonly MyCustomSettings _myCustomSettings;  
  
    public MyController(IOptions<MyCustomSettingsOptions> options)  
    {  
        _myCustomSettings = options.Value.MyCustomSettings;  
    }  
  
    [HttpGet]  
    public IActionResult Get()  
    {  
        // 使用_myCustomSettings...  
        return Ok($"Key1: {_myCustomSettings.Key1}, Key2: {_myCustomSettings.Key2}");  
    }  
}

By defining a class that matches the structure of your configuration file, and thenStartup.csConfigure and read these configurations in the application, and finally use these configurations in other parts of the application through dependency injection.