Nie jestem pewien, czego tu brakuje, ale nie mogę pobrać wartości z mojego pliku appsettings.json w mojej aplikacji .net core. Mam plik appsettings.json jako:

{
    "AppSettings": {
        "Version": "One"
    }
}

Uruchomienie:

public class Startup
{
    private IConfigurationRoot _configuration;
    public Startup(IHostingEnvironment env)
    {
        _configuration = new ConfigurationBuilder()
    }
    public void ConfigureServices(IServiceCollection services)
    {
      //Here I setup to read appsettings        
      services.Configure<AppSettings>(_configuration.GetSection("AppSettings"));
    }
}

Model:

public class AppSettings
{
    public string Version{ get; set; }
}

Kontroler:

public class HomeController : Controller
{
    private readonly AppSettings _mySettings;

    public HomeController(IOptions<AppSettings> settings)
    {
        //This is always null
        _mySettings = settings.Value;
    }
}

_mySettingsjest zawsze zerowa. Czy jest coś, czego tu brakuje?

Klasa Program i Startup

.NET Core 2.x

Nie musisz wprowadzać nowego IConfigurationw Startupkonstruktorze. Jego implementacja zostanie wstrzyknięta przez system DI.

// Program.cs
public class Program
{
    public static void Main(string[] args)
    {
        BuildWebHost(args).Run();
    }

    public static IWebHost BuildWebHost(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .UseStartup<Startup>()
            .Build();            
}

// Startup.cs
public class Startup
{
    public IHostingEnvironment HostingEnvironment { get; private set; }
    public IConfiguration Configuration { get; private set; }

    public Startup(IConfiguration configuration, IHostingEnvironment env)
    {
        this.HostingEnvironment = env;
        this.Configuration = configuration;
    }
}

.NET Core 1.x

Musisz powiedzieć, Startupaby załadować pliki appsettings.

// Program.cs
public class Program
{
    public static void Main(string[] args)
    {
        var host = new WebHostBuilder()
            .UseKestrel()
            .UseContentRoot(Directory.GetCurrentDirectory())
            .UseIISIntegration()
            .UseStartup<Startup>()
            .UseApplicationInsights()
            .Build();

        host.Run();
    }
}

//Startup.cs
public class Startup
{
    public IConfigurationRoot Configuration { get; private set; }

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

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

Pobieranie wartości

Istnieje wiele sposobów na uzyskanie wartości skonfigurowanej w ustawieniach aplikacji:

• Prosty sposób używania ConfigurationBuilder.GetValue<T>
• Korzystanie z wzorca opcji

Powiedzmy, że appsettings.jsonwyglądasz tak:

{
    "ConnectionStrings": {
        ...
    },
    "AppIdentitySettings": {
        "User": {
            "RequireUniqueEmail": true
        },
        "Password": {
            "RequiredLength": 6,
            "RequireLowercase": true,
            "RequireUppercase": true,
            "RequireDigit": true,
            "RequireNonAlphanumeric": true
        },
        "Lockout": {
            "AllowedForNewUsers": true,
            "DefaultLockoutTimeSpanInMins": 30,
            "MaxFailedAccessAttempts": 5
        }
    },
    "Recaptcha": { 
        ...
    },
    ...
}

Prosta droga

Możesz wstrzyknąć całą konfigurację do konstruktora swojego kontrolera / klasy (przez IConfiguration) i uzyskać żądaną wartość za pomocą określonego klucza:

public class AccountController : Controller
{
    private readonly IConfiguration _config;

    public AccountController(IConfiguration config)
    {
        _config = config;
    }

    [AllowAnonymous]
    public IActionResult ResetPassword(int userId, string code)
    {
        var vm = new ResetPasswordViewModel
        {
            PasswordRequiredLength = _config.GetValue<int>(
                "AppIdentitySettings:Password:RequiredLength"),
            RequireUppercase = _config.GetValue<bool>(
                "AppIdentitySettings:Password:RequireUppercase")
        };

        return View(vm);
    }
}

Wzorzec opcji

ConfigurationBuilder.GetValue<T>Działa świetnie, jeśli trzeba tylko jedną lub dwie wartości w ustawieniach aplikacji. Ale jeśli chcesz uzyskać wiele wartości z ustawień aplikacji lub nie chcesz na stałe kodować tych ciągów kluczy w wielu miejscach, łatwiejsze może być użycie wzorca opcji . Wzorzec opcji używa klas do reprezentowania hierarchii / struktury.

Aby użyć wzorca opcji:

1. Zdefiniuj klasy reprezentujące strukturę
2. Zarejestruj wystąpienie konfiguracji, z którym te klasy są powiązane
3. Wstrzyknij IOptions<T>do konstruktora kontrolera / klasy, dla którego chcesz uzyskać wartości

1. Zdefiniuj klasy konfiguracyjne reprezentujące strukturę

Możesz zdefiniować klasy z właściwościami, które muszą dokładnie odpowiadać kluczom w ustawieniach aplikacji. Nazwa zajęć nie musi odpowiadać nazwie sekcji w ustawieniach aplikacji:

public class AppIdentitySettings
{
    public UserSettings User { get; set; }
    public PasswordSettings Password { get; set; }
    public LockoutSettings Lockout { get; set; }
}

public class UserSettings
{
    public bool RequireUniqueEmail { get; set; }
}

public class PasswordSettings
{
    public int RequiredLength { get; set; }
    public bool RequireLowercase { get; set; }
    public bool RequireUppercase { get; set; }
    public bool RequireDigit { get; set; }
    public bool RequireNonAlphanumeric { get; set; }
}

public class LockoutSettings
{
    public bool AllowedForNewUsers { get; set; }
    public int DefaultLockoutTimeSpanInMins { get; set; }
    public int MaxFailedAccessAttempts { get; set; }
}

2. Zarejestruj instancję konfiguracji

Następnie musisz zarejestrować tę instancję konfiguracyjną ConfigureServices()podczas uruchamiania:

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
...

namespace DL.SO.UI.Web
{
    public class Startup
    {
        ...
        public void ConfigureServices(IServiceCollection services)
        {
            ...
            var identitySettingsSection = 
                _configuration.GetSection("AppIdentitySettings");
            services.Configure<AppIdentitySettings>(identitySettingsSection);
            ...
        }
        ...
    }
}

3. Wstrzyknij IOptions

Na koniec na kontrolerze / klasie, dla której chcesz uzyskać wartości, musisz wstrzyknąć IOptions<AppIdentitySettings>przez konstruktor:

public class AccountController : Controller
{
    private readonly AppIdentitySettings _appIdentitySettings;

    public AccountController(IOptions<AppIdentitySettings> appIdentitySettingsAccessor)
    {
        _appIdentitySettings = appIdentitySettingsAccessor.Value;
    }

    [AllowAnonymous]
    public IActionResult ResetPassword(int userId, string code)
    {
        var vm = new ResetPasswordViewModel
        {
            PasswordRequiredLength = _appIdentitySettings.Password.RequiredLength,
            RequireUppercase = _appIdentitySettings.Password.RequireUppercase
        };

        return View(vm);
    }
}

Po prostu utwórz plik An AnyName.cs i wklej następujący kod.

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

namespace Custom
{
    static class ConfigurationManager
    {
        public static IConfiguration AppSetting { get; }
        static ConfigurationManager()
        {
            AppSetting = new ConfigurationBuilder()
                    .SetBasePath(Directory.GetCurrentDirectory())
                    .AddJsonFile("YouAppSettingFile.json")
                    .Build();
        }
    }
}

Musisz zastąpić nazwę pliku YouAppSettingFile.json nazwą pliku.
Twój plik .json powinien wyglądać jak poniżej.

{
    "GrandParent_Key" : {
        "Parent_Key" : {
            "Child_Key" : "value1"
        }
    },
    "Parent_Key" : {
        "Child_Key" : "value2"
    },
    "Child_Key" : "value3"
}

Teraz możesz go używać.
Nie zapomnij dodać odwołania w swojej klasie, w której chcesz użyć.

using Custom;

Kod do pobierania wartości.

string value1 = ConfigurationManager.AppSetting["GrandParent_Key:Parent_Key:Child_Key"];
string value2 = ConfigurationManager.AppSetting["Parent_Key:Child_Key"];
string value3 = ConfigurationManager.AppSetting["Child_Key"];

Dodając do odpowiedzi Davida Lianga dla Core 2.0 -

appsettings.jsonpliki są połączone ze ASPNETCORE_ENVIRONMENTzmienną.

ASPNETCORE_ENVIRONMENTmożna ustawić na dowolną wartość, ale trzy wartości są obsługiwane przez ramy: Development, Staging, i Production. Jeśli ASPNETCORE_ENVIRONMENTnie jest ustawiona, domyślnieProduction .

Dla tych trzech wartości te pliki appsettings.ASPNETCORE_ENVIRONMENT.json są obsługiwane po wyjęciu z pudełka - appsettings.Staging.json,appsettings.Development.json iappsettings.Production.json

Powyższe trzy pliki json ustawień aplikacji mogą służyć do konfigurowania wielu środowisk.

Przykład - appsettings.Staging.json

{
    "Logging": {
        "IncludeScopes": false,
        "LogLevel": {
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "MyConfig": "My Config Value for staging."
}

Służy Configuration["config_var"]do pobierania dowolnej wartości konfiguracyjnej.

public class Startup
{
    public Startup(IHostingEnvironment env, IConfiguration config)
    {
        Environment = env;
        Configuration = config;
        var myconfig = Configuration["MyConfig"];
    }

    public IConfiguration Configuration { get; }
    public IHostingEnvironment Environment { get; }
}

Myślę, że najprostszym sposobem jest DI. Przykład sięgnięcia do kontrolera.

// StartUp.cs
public void ConfigureServices(IServiceCollection services)
{
    ...
    // for get appsettings from anywhere
    services.AddSingleton(Configuration);
}

public class ContactUsController : Controller
{
    readonly IConfiguration _configuration;

    public ContactUsController(
        IConfiguration configuration)
    {
        _configuration = configuration;

        // sample:
        var apiKey = _configuration.GetValue<string>("SendGrid:CAAO");
        ...
    }
}

W konstruktorze klasy Startup można uzyskać dostęp do pliku appsettings.json i wielu innych ustawień za pomocą wstrzykniętego obiektu IConfiguration:

Startup.cs Konstruktor

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;

        //here you go
        var myvalue = Configuration["Grandfather:Father:Child"];

    }

public IConfiguration Configuration { get; }

Zawartość pliku appsettings.json

  {
  "Grandfather": {
    "Father": {
      "Child": "myvalue"
    }
  }

    public static void GetSection()
    {
        Configuration = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json")
            .Build();

        string BConfig = Configuration.GetSection("ConnectionStrings")["BConnection"];

    }

W moim przypadku było to proste, jak użycie metody Bind () na obiekcie Configuration. Następnie dodaj obiekt jako singleton w DI.

var instructionSettings = new InstructionSettings();
Configuration.Bind("InstructionSettings", instructionSettings);
services.AddSingleton(typeof(IInstructionSettings), (serviceProvider) => instructionSettings);

Obiekt instrukcji może być tak złożony, jak chcesz.

{  
 "InstructionSettings": {
    "Header": "uat_TEST",
    "SVSCode": "FICA",
    "CallBackUrl": "https://UATEnviro.companyName.co.za/suite/webapi/receiveCallback",
    "Username": "s_integrat",
    "Password": "X@nkmail6",
    "Defaults": {
    "Language": "ENG",
    "ContactDetails":{
       "StreetNumber": "9",
       "StreetName": "Nano Drive",
       "City": "Johannesburg",
       "Suburb": "Sandton",
       "Province": "Gauteng",
       "PostCode": "2196",
       "Email": "[email protected]",
       "CellNumber": "0833 468 378",
       "HomeNumber": "0833 468 378",
      }
      "CountryOfBirth": "710"
    }
  }

W przypadku ASP.NET Core 3.1 możesz postępować zgodnie z tym przewodnikiem:

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1

Podczas tworzenia nowego projektu ASP.NET Core 3.1 będziesz mieć następujący wiersz konfiguracji Program.cs:

Host.CreateDefaultBuilder(args)

Umożliwia to:

1. ChainedConfigurationProvider: dodaje istniejącą IConfiguration jako źródło. W przypadku konfiguracji domyślnej dodaje konfigurację hosta i ustawia ją jako pierwsze źródło konfiguracji aplikacji.
2. appsettings.json przy użyciu dostawcy konfiguracji JSON.
3. appsettings.Environment.json przy użyciu dostawcy konfiguracji JSON. Na przykład appsettings.Production.json i appsettings.Development.json.
4. Informacje tajne aplikacji, gdy aplikacja działa w środowisku programistycznym.
5. Zmienne środowiskowe korzystające z dostawcy konfiguracji zmiennych środowiskowych.
6. Argumenty wiersza polecenia przy użyciu dostawcy konfiguracji wiersza polecenia.

Oznacza to, że możesz wstrzyknąć IConfiguration i pobierać wartości za pomocą klucza ciągu, nawet wartości zagnieżdżone. LubićIConfiguration["Parent:Child"];

Przykład:

appsettings.json

{
  "ApplicationInsights":
    {
        "Instrumentationkey":"putrealikeyhere"
    }
}

WeatherForecast.cs

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;
    private readonly IConfiguration _configuration;

    public WeatherForecastController(ILogger<WeatherForecastController> logger, IConfiguration configuration)
    {
        _logger = logger;
        _configuration = configuration;
    }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        var key = _configuration["ApplicationInsights:InstrumentationKey"];

        var rng = new Random();
        return Enumerable.Range(1, 5).Select(index => new WeatherForecast
        {
            Date = DateTime.Now.AddDays(index),
            TemperatureC = rng.Next(-20, 55),
            Summary = Summaries[rng.Next(Summaries.Length)]
        })
        .ToArray();
    }
}

Myślę, że najlepszą opcją jest:

1. Utwórz klasę modelu jako schemat konfiguracji

2. Zarejestruj się w DI: services.Configure (Configuration.GetSection ("democonfig"));

3. Pobierz wartości jako obiekt modelowy z DI w kontrolerze:

   private readonly your_model myConfig;
   public DemoController(IOptions<your_model> configOps)
   {
       this.myConfig = configOps.Value;
   }

Z Asp.net core 2.2 do powyżej możesz kodować jak poniżej:

Krok 1. Utwórz plik klasy AppSettings.

Ten plik zawiera metody ułatwiające uzyskanie wartości według klucza z pliku appsettings.json. Wygląda jak kod poniżej:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ReadConfig.Bsl
{
  public class AppSettings
  {
      private static AppSettings _instance;
      private static readonly object ObjLocked = new object();
      private IConfiguration _configuration;

      protected AppSettings()
      {
      }

      public void SetConfiguration(IConfiguration configuration)
      {
          _configuration = configuration;
      }

      public static AppSettings Instance
      {
          get
          {
              if (null == _instance)
              {
                  lock (ObjLocked)
                  {
                      if (null == _instance)
                          _instance = new AppSettings();
                  }
              }
              return _instance;
          }
      }

      public string GetConnection(string key, string defaultValue = "")
      {
          try
          {
              return _configuration.GetConnectionString(key);
          }
          catch
          {
              return defaultValue;
          }
      }

      public T Get<T>(string key = null)
      {
          if (string.IsNullOrWhiteSpace(key))
              return _configuration.Get<T>();
          else
              return _configuration.GetSection(key).Get<T>();
      }

      public T Get<T>(string key, T defaultValue)
      {
          if (_configuration.GetSection(key) == null)
              return defaultValue;

          if (string.IsNullOrWhiteSpace(key))
              return _configuration.Get<T>();
          else
              return _configuration.GetSection(key).Get<T>();
      }

      public static T GetObject<T>(string key = null)
      {
          if (string.IsNullOrWhiteSpace(key))
              return Instance._configuration.Get<T>();
          else
          {
              var section = Instance._configuration.GetSection(key);
              return section.Get<T>();
          }
      }

      public static T GetObject<T>(string key, T defaultValue)
      {
          if (Instance._configuration.GetSection(key) == null)
              return defaultValue;

          if (string.IsNullOrWhiteSpace(key))
              return Instance._configuration.Get<T>();
          else
              return Instance._configuration.GetSection(key).Get<T>();
      }
  }
}

Krok 2. Wstępna konfiguracja obiektu AppSettings

Musimy zadeklarować i załadować plik appsettings.json podczas uruchamiania aplikacji i załadować informacje konfiguracyjne dla obiektu AppSettings. Wykonamy tę pracę w konstruktorze pliku Startup.cs. Proszę zwrócić uwagę na linięAppSettings.Instance.SetConfiguration(Configuration);

public Startup(IHostingEnvironment evm)
{
    var builder = new ConfigurationBuilder()
      .SetBasePath(evm.ContentRootPath)
      .AddJsonFile("appsettings.json", true, true)
      .AddJsonFile($"appsettings.{evm.EnvironmentName}.json", true)
      .AddEnvironmentVariables();
    Configuration = builder.Build(); // load all file config to Configuration property 
    AppSettings.Instance.SetConfiguration(Configuration);       
}

OK, teraz mam plik appsettings.json z kilkoma kluczami, jak poniżej:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "ConnectionString": "Data Source=localhost;Initial Catalog=ReadConfig;Persist Security Info=True;User ID=sa;Password=12345;"
  },
  "MailConfig": {
    "Servers": {
      "MailGun": {
        "Pass": "65-1B-C9-B9-27-00",
        "Port": "587",
        "Host": "smtp.gmail.com"
      }
    },
    "Sender": {
      "Email": "[email protected]",
      "Pass": "123456"
    }
  }
}

Krok 3. Odczytaj wartość konfiguracyjną z akcji

Robię demo jako akcję w kontrolerze Home, jak poniżej:

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var connectionString = AppSettings.Instance.GetConnection("ConnectionString");
        var emailSender = AppSettings.Instance.Get<string>("MailConfig:Sender:Email");
        var emailHost = AppSettings.Instance.Get<string>("MailConfig:Servers:MailGun:Host");

        string returnText = " 1. Connection String \n";
        returnText += "  " +connectionString;
        returnText += "\n 2. Email info";
        returnText += "\n Sender : " + emailSender;
        returnText += "\n Host : " + emailHost;

        return Content(returnText);
    }
}

A poniżej jest wynik:

Kliknij, aby zobaczyć wynik

Aby uzyskać więcej informacji, możesz odwołać się do artykułu get value from appsettings.json w asp.net core, aby uzyskać bardziej szczegółowy kod.

To proste: w pliku appsettings.json

  "MyValues": {
    "Value1": "Xyz"
  }

W pliku .cs:

static IConfiguration conf = (new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()).AddJsonFile("appsettings.json").Build());
        public static string myValue1= conf["MyValues:Value1"].ToString();