.NET 코어 개발 설정 상세 설명

ASP.NET 을 잘 아 는 개발 자 는 웹 config 파일 이 낯 설 지 않 을 것 입 니 다.ASP.NET 환경 에서 설정 파 라 메 터 를 추가 하려 면 보통 이 파일 에서 작 동 합 니 다.그 중에서 가장 많이 사용 되 는 것 은 AppSettings 와 ConnectionStrings 두 가지 이다.코드 에서 파일 의 설정 정 보 를 얻 으 려 면 ConfigurationManager 는 도입 할 프로그램 집합 이 필요 합 니 다.
그러나 ASP.NET Core 시대 에 접어 들 면서 설정 을 저장 하고 읽 는 방식 이 바 뀌 었 다.
ASP.NET Core 프로젝트 에 대해 알 고 있다 면 app settings.json 파일 을 본 적 이 있 을 것 입 니 다.JSON 파일 설정 방식 부터 ASP.NET Core 에서 설정 정 보 를 어떻게 읽 었 는 지 설명 합 니 다.
미리 설 정 된 apptsettings.json 파일 이 있다 고 가정 합 니 다:

{
 "option1": "value1_from_json",
 "option2": 2,

 "subsection": {
  "suboption1": "subvalue1_from_json"
 },
 "wizards": [
  {
   "Name": "Gandalf",
   "Age": "1000"
  },
  {
   "Name": "Harry",
   "Age": "17"
  }
 ]
}

코드 에서 읽 기 는 다음 과 같이 할 수 있 습 니 다.

public class Program
{
  public static IConfiguration Configuration { get; set; }

  public static void Main(string[] args = null)
  {
    var builder = new ConfigurationBuilder()
      .SetBasePath(Directory.GetCurrentDirectory())
      .AddJsonFile("appsettings.json");

    Configuration = builder.Build();

    Console.WriteLine($"option1 = {Configuration["Option1"]}");
    Console.WriteLine($"option2 = {Configuration["option2"]}");
    Console.WriteLine(
      $"suboption1 = {Configuration["subsection:suboption1"]}");
    Console.WriteLine();

    Console.WriteLine("Wizards:");
    Console.Write($"{Configuration["wizards:0:Name"]}, ");
    Console.WriteLine($"age {Configuration["wizards:0:Age"]}");
    Console.Write($"{Configuration["wizards:1:Name"]}, ");
    Console.WriteLine($"age {Configuration["wizards:1:Age"]}");
    Console.WriteLine();

    Console.WriteLine("Press a key...");
    Console.ReadKey();
  }
}

우선 ConfigurationBuilder 대상 을 예화 하고 기본 경 로 를 설정 합 니 다.
SetBasePath 의 동작 은 ConfigurationBuilder 의 속성 사전 에 FileProvider 의 값 을 설정 하 는 것 입 니 다.

public static IConfigurationBuilder SetBasePath(this IConfigurationBuilder builder, string basePath)
{
  ...
  
  return builder.SetFileProvider(new PhysicalFileProvider(basePath));
}

public static IConfigurationBuilder SetFileProvider(this IConfigurationBuilder builder, IFileProvider fileProvider)
{
  ...

  builder.Properties[FileProviderKey] = fileProvider ?? throw new ArgumentNullException(nameof(fileProvider));
  return builder;
}

그리고 JSON 파일 추가.

public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, IFileProvider provider, string path, bool optional, bool reloadOnChange)
{
  ...

  return builder.AddJsonFile(s =>
  {
    s.FileProvider = provider;
    s.Path = path;
    s.Optional = optional;
    s.ReloadOnChange = reloadOnChange;
    s.ResolveFileProvider();
  });
}

public static IConfigurationBuilder AddJsonFile(this IConfigurationBuilder builder, Action<JsonConfigurationSource> configureSource)
  => builder.Add(configureSource);

ConfigurationBuilder 에 Json ConfigurationSource 대상 이 추가 되 었 습 니 다.
마지막 으로 ConfigurationBuilder 의 Build 방법 을 실행 하면 설정 정 보 를 저장 하 는 Configuration 대상 을 얻 을 수 있 습 니 다.
예 에서 코드 를 정리 하고 설정 정 보 를 얻 는 작업 은 두 단계 로 나 뉜 다.

구성 대상 생 성

버튼 값 은 Configuration 대상 에서 정 보 를 얻 습 니 다

Configuration 대상 을 만 드 는 절 차 는 적어도 세 가지 기본 적 인 부분 이 있어 야 합 니 다.

ConfigurationBuilder 대상 생 성

ConfigurationSource 대상 추가

구성 대상 생 성
Configuration 대상 을 만 드 는 코드 를 보면 내부 에서 사용 하 는 것 이 ConfigurationSource 에서 만 든 ConfigurationProvider 대상 임 을 알 수 있 습 니 다.

public IConfigurationRoot Build()
{
  var providers = new List<IConfigurationProvider>();
  foreach (var source in Sources)
  {
    var provider = source.Build(this);
    providers.Add(provider);
  }
  return new ConfigurationRoot(providers);
}

IConfiguraton Source 인 터 페 이 스 를 다시 봐 도 Build 방법 은 하나 밖 에 없다.

public interface IConfigurationSource
{
  IConfigurationProvider Build(IConfigurationBuilder builder);
}

최종 적 으로 만 든 ConfigurationRoot 에는 모든 ConfigurationProvider 가 포함 되 어 있 습 니 다.설정 정 보 는 이 ConfigurationProvider 가 제공 하 는 것 을 설명 합 니 다.
ConfigurationRoot 형식의 구조 방법 을 추적 합 니 다.과연 대상 을 만 들 때 모든 ConfigurationProvider 를 불 러 옵 니 다.

public ConfigurationRoot(IList<IConfigurationProvider> providers)
{
  ...

  _providers = providers;
  foreach (var p in providers)
  {
    p.Load();
    ChangeToken.OnChange(() => p.GetReloadToken(), () => RaiseChanged());
  }
}

예 를 들 어 Json Configuration Provider 에서:

public override void Load(Stream stream)
{
  try
  {
    Data = JsonConfigurationFileParser.Parse(stream);
  }
  ...
}

JSON 해상도 기 를 통 해 JSON 파일 의 설정 정 보 를 ConfigurationProvider 의 Data 속성 으로 읽 습 니 다.이 속성 은 모든 설정 정 보 를 저장 하 는 데 사 용 됩 니 다.

 /// <summary>
 /// The configuration key value pairs for this provider.
 /// </summary>
 protected IDictionary<string, string> Data { get; set; }

ConfigurationRoot 대상 이 있 으 면 설정 정 보 를 얻 는 작업 이 간단 합 니 다.각 ConfigurationProvider 를 옮 겨 다 니 며 키 와 일치 하 는 첫 번 째 데 이 터 를 가 져 옵 니 다.

public string this[string key]
{
  get
  {
    foreach (var provider in _providers.Reverse())
    {
      string value;

      if (provider.TryGet(key, out value))
      {
        return value;
      }
    }

    return null;
  }

  ...
}

ConfigurationProvider 대상 이 Data 속성 에서 설정 값 을 가 져 옵 니 다.

public virtual bool TryGet(string key, out string value)
  => Data.TryGetValue(key, out value);

최초의 예 에서 Configuration["wizards:0:Name"]을 볼 수 있 습 니 다.이것 은 Load 파일 에 저 장 된 방식 은 구분자 로 포 함 된 대상 의 키 값 을 사용 하기 때 문 입 니 다.
설정 정 보 를 대상 으로 연결 하 는 다른 방법 으로 도 쓸 수 있 습 니 다.
대상 형식 을 먼저 정의 합 니 다:

public class AppSettings
{
  public string Option1 { get; set; }
  public int Option2 { get; set; }
  public Subsection Subsection { get; set; }
  public IList<Wizards> Wizards { get; set; }
}

public class Subsection
{
  public string Suboption1 { get; set; }
}

public class Wizards
{
  public string Name { get; set; }
  public string Age { get; set; }
}

재 귀속 대상:

static void Main(string[] args)
{
  var builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json");

  Configuration = builder.Build();

  var appConfig = new AppSettings();
  Configuration.Bind(appConfig);

  Console.WriteLine($"option1 = {appConfig.Option1}");
  Console.WriteLine($"option2 = {appConfig.Option2}");
  Console.WriteLine(
    $"suboption1 = {appConfig.Subsection.Suboption1}");
  Console.WriteLine();

  Console.WriteLine("Wizards:");
  Console.Write($"{appConfig.Wizards[0].Name}, ");
  Console.WriteLine($"age {appConfig.Wizards[0].Age}");
  Console.Write($"{appConfig.Wizards[1].Name}, ");
  Console.WriteLine($"age {appConfig.Wizards[1].Age}");
  Console.WriteLine();

  Console.WriteLine("Press a key...");
  Console.ReadKey();
}

쓰기 방법 은 흔히 볼 수 있 는 대상 호출 속성 방식 이 되 었 으 나 결 과 는 같 았 다.
설정 정 보 를 JSON 파일 로 저장 할 수 있 는 것 외 에 도 ASP.NET Core 는 INI 와 XML 파일 도 지원 한다.물론 다른 형식의 파일 이 있 을 때 도 IConfigurationSource 인 터 페 이 스 를 실현 하고 ConfigurationProvider 클래스 를 계승 하여 사용자 정의 ConfigrationProvider 대상 을 만들어 프로필 을 불 러 올 수 있 습 니 다.
파일 이외 의 방식 에 대해 서 는 ASP.NET Core 도 많이 제공 했다.
명령 행,AddCommandLine환경 변수,AddEnvironment Variables메모리,AddInMemory Collection사용자 기밀,AddUserSecrets

Azure Key Vault，AddAzureKeyVault

어떤 저장 과 읽 기 설정 을 선택 하 는 방법 은 실제 장면 에 달 려 있 습 니 다.ASP.NET Core 는 설정 의 입 구 를 열 었 고 모든 접속 방식 은 이론 적 으로 가능 합 니 다.실천 에 있어 개발 자 들 이 끊임없이 시도 하고 탐색 해 야 한다.