Microsoft MVP성태의 닷넷 이야기
.NET Framework: 739. .NET Framework 4.7.1의 새 기능 - Configuration builders [링크 복사], [링크+제목 복사]
조회: 3344
글쓴 사람
홈페이지
첨부 파일

.NET Framework 4.7.1의 새 기능 - Configuration builders

.NET 4.7.1에 추가된 기능 중에,

Announcing the .NET Framework 4.7.1
; https://blogs.msdn.microsoft.com/dotnet/2017/10/17/announcing-the-net-framework-4-7-1/

Configuration builders라는 것이 있는데 이에 대한 소개를 해보겠습니다. ^^




간혹, App.config의 appSettings에 값을 보관하는 경우가 있습니다. 문제는, 이 값이 너무 정적이다는 것입니다. 예를 들어, 다음과 같이 app.config에 값을 정의했을 때,

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="Setting1" value="1" />
        <add key="Setting2" value="2" />
    </appSettings>
</configuration>

각각의 값을 다음과 같은 식으로 AppSettingsReader를 통해 읽을 수 있습니다.

using System;
using System.Configuration;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            System.Configuration.AppSettingsReader reader = new System.Configuration.AppSettingsReader();

            PrintValue(reader, "Setting1");
            PrintValue(reader, "Setting2");
            PrintValue(reader, "my");
        }

        private static void PrintValue(AppSettingsReader reader, string key)
        {
            string txt1 = null;

            try
            {
                txt1 = reader.GetValue(key, typeof(string)) as string;
            }
            catch
            {
                Console.WriteLine($"'{key}' is not defined");
                return;
            }

            Console.WriteLine($"'{key}' == {txt1}");
        }
    }
}

// 출력 결과
/*

'Setting1' == 1
'Setting2' == 
'my' is not defined

*/

그런데 만약, "Setting1"이라는 값이 "환경 변수"에 정의되어 있다면 app.config이 아닌 환경 변수의 값을 활용하고 싶다면 어떻게 해야 할까요? 물론, 그냥 AppSettingsReader로 값을 읽기 전 환경 변수를 한번 더 체크하면 됩니다.

.NET 4.7.1부터는 AppSettingsReader에 그런 부가적인 작업을 할 필요 없이 동적으로 app.config의 값을 추가/변경/삭제할 수 있는 기능을 제공하는데 그것이 바로 "Configuration Builder"입니다. 이를 위해 필요한 작업은 app.config에 builder 클래스를 알리는 정도입니다.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <section name="configBuilders" type="System.Configuration.ConfigurationBuildersSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" restartOnExternalChanges="false" requirePermission="false"/>
    </configSections>

    <configBuilders>
        <builders>
            <add name="MyConfigBuilder" type="ConsoleApp1.MyConfigBuilder, ConsoleApp1" />
        </builders>
    </configBuilders>

    <appSettings configBuilders="MyConfigBuilder">
        <add key="Setting1" value="May Be Replaced" />
        <add key="Setting2" value="May Be Removed" />
        <!-- Setting3 could be added by a builder without even being declared here. -->
    </appSettings>

    <startup>
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.1" />
    </startup>
</configuration>

물론, Configuration Builder 역할을 하는 사용자 클래스는 구현해야 합니다. 이론 상으로는 해당 클래스가 GAC에 등록한 어셈블리에 있다면 기존 응용 프로그램의 코드는 전혀 변경하지 않아도 되지만, 그렇지 않은 경우라면 자신의 프로젝트에 다음과 같은 클래스를 정의해 제공해야 합니다.

using System.Collections.Specialized;
using System.Configuration;
using System.Xml;

namespace ConsoleApp1
{
    public class MyConfigBuilder : ConfigurationBuilder
    {
        protected MyConfigBuilder()
        {
        }

        public override void Initialize(string name, NameValueCollection config)
        {
            // name == "MyConfigBuilder"
            base.Initialize(name, config);
        }

        public override ConfigurationSection ProcessConfigurationSection(ConfigurationSection configSection)
        {
            return base.ProcessConfigurationSection(configSection);
        }

        public override XmlNode ProcessRawXml(XmlNode rawXml)
        {
            return base.ProcessRawXml(rawXml);
        }
    }
}

위의 클래스는 기본 제공 코드일 뿐, 원한다면 다음과 같이 app.config의 configBuilders 속성이 추가된 XML 노드를 직접 제어할 수 있습니다.

public override XmlNode ProcessRawXml(XmlNode rawXml)
{
    XmlNode node = rawXml.SelectSingleNode("./add[@key = 'Setting1']");
    SetAttrValue(node, "value", "Replaced");

    node = rawXml.SelectSingleNode("./add[@key = 'Setting2']");
    rawXml.RemoveChild(node);

    AppendAddNode(rawXml, "my", "value");

    return base.ProcessRawXml(rawXml);
}

private void AppendAddNode(XmlNode rawXml, string addName, string addValue)
{
    XmlNode addNode = rawXml.OwnerDocument.CreateNode(XmlNodeType.Element, "add", rawXml.NamespaceURI);

    XmlAttribute keyNode = rawXml.OwnerDocument.CreateAttribute(rawXml.Prefix, "key", rawXml.NamespaceURI);
    keyNode.Value = "my";

    XmlAttribute valueNode = rawXml.OwnerDocument.CreateAttribute(rawXml.Prefix, "value", rawXml.NamespaceURI);
    valueNode.Value = "value";

    addNode.Attributes.SetNamedItem(keyNode);
    addNode.Attributes.SetNamedItem(valueNode);

    rawXml.AppendChild(addNode);
}

private void SetAttrValue(XmlNode node, string attrName, string attrValue)
{
    XmlNode attrNode = node.Attributes.GetNamedItem(attrName);
    attrNode.Value = attrValue;
}

위의 코드에서는 "Setting1"의 값을 변경하고, "Setting2"의 설정은 제거한 후 새롭게 "my"라는 설정을 추가하고 있습니다. 따라서 기존 응용 프로그램을 실행하면 다음과 같은 결과를 볼 수 있습니다.

'Setting1' == Replaced
'Setting2' is not defined
'my' == value

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




github에 소스 코드 공개 문화가 생기다 보니, 간혹 보면 개발자 PC에서 appSettings에 Facebook 등의 인증 정보를 넣고 테스트하다가 실수로 github 등에 올리는 문제가 있는데요. configBuilders를 잘 활용하면 그런 실수를 미연에 방지할 수 있습니다.

마지막으로 살짝 아쉬운 것이 있다면,

With Configuration Builders, applications can apply a custom-defined set of builders to any section of config.

"any section"을 어떻게 해석해야 할지 모르겠는데 분명한 것은 "all of"는 아니고 "some of"... 도 아니고 "a few of" 정도라는 점입니다. 일단은 appSettings, connectionStrings에 대해 제공하는 것을 확인했고 그 외의 노드는 Visual Studio의 app.config 편집 시에 인텔리센스로 "configBuilders"가 지원되는 지 여부로 쉽게 확인할 수 있습니다.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]





[최초 등록일: ]
[최종 수정일: 4/12/2018 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer@outlook.com

비밀번호

댓글 쓴 사람
 



2018-05-23 04시44분
정성태

... 16  17  18  19  20  21  22  23  24  25  26  27  28  [29]  30  ...
NoWriterDateCnt.TitleFile(s)
11516정성태5/9/20182128.NET Framework: 745. Azure runbook을 PowerShell 또는 C# 코드로 실행하는 방법파일 다운로드1
11515정성태6/8/20182495.NET Framework: 744. C# 6 - Expression bodied function
11514정성태5/3/20183947오류 유형: 466. Bitvise - Error in component session/transport/kexHandler [2]
11513정성태5/10/20184847.NET Framework: 743. C# 언어의 공변성과 반공변성 [5]파일 다운로드1
11512정성태5/3/20182215개발 환경 구성: 375. Azure runbook 실행 시 "Errors", "All Logs"에 오류 메시지가 출력되는 경우
11511정성태5/2/20182557개발 환경 구성: 374. Azure - Runbook 기능 소개
11510정성태4/30/20184190.NET Framework: 742. windbg로 확인하는 Finalizer를 가진 객체의 GC 과정파일 다운로드1
11509정성태4/28/20183663.NET Framework: 741. windbg로 확인하는 객체의 GC 여부
11508정성태4/23/20182896개발 환경 구성: 373. MSBuild를 이용해 프로젝트 배포 후 결과물을 zip 파일로 압축하는 방법파일 다운로드1
11507정성태9/29/20183113개발 환경 구성: 372. MSBuild - 빌드 전/후, 배포 전/후 실행하고 싶은 Task 정의
11506정성태6/27/20186013.NET Framework: 740. C#에서 enum을 boxing 없이 int로 변환하기 - 두 번째 이야기 [7]파일 다운로드1
11505정성태4/19/20182507개발 환경 구성: 371. Azure Web App 확장 예제 - Simple WebSite Extension
11504정성태4/19/20182653오류 유형: 465. Azure Web App 확장 - Extplorer File manager 적용 시 오류
11503정성태4/19/20182611오류 유형: 464. PowerShell - Start-Service 명령 오류 (Service 'xxx' cannot be started)
11502정성태5/12/20183653개발 환경 구성: 370. Azure VM/App Services(Web Apps)에 Let's Encrypt 무료 인증서 적용 방법 [2]
11501정성태4/17/20182400개발 환경 구성: 369. New-AzureRmADServicePrincipal로 생성한 계정의 clientSecret, key 값을 구하는 방법파일 다운로드1
11500정성태4/17/20182715개발 환경 구성: 368. PowerShell로 접근하는 Azure의 Access control 보안과 Azure Active Directory의 계정 관리 서비스
11499정성태4/17/20182290개발 환경 구성: 367. Azure - New-AzureRmADServicePrincipal / New-AzureRmRoleAssignment 명령어
11498정성태4/17/20182310개발 환경 구성: 366. Actvie Azure Directory의 사용자 유형 구분 - Guest/Member
11497정성태4/17/20182444개발 환경 구성: 365. Azure 리소스의 액세스 제어(Access control) 별로 사용자에게 권한을 할당하는 방법 [2]
11496정성태4/17/20182055개발 환경 구성: 364. Azure Portal에서 구독(Subscriptions) 메뉴가 보이지 않는 경우
11495정성태4/18/20182650개발 환경 구성: 363. Azure의 Access control 보안과 Azure Active Directory의 계정 관리 서비스
11494정성태4/16/20182424개발 환경 구성: 362. Azure Web Apps(App Services)에 사용자 DNS를 지정하는 방법
11493정성태4/16/20182415개발 환경 구성: 361. Azure Web App(App Service)의 HTTP/2 프로토콜 지원
11492정성태4/13/20182388개발 환경 구성: 360. Azure Active Directory의 사용자 도메인 지정 방법
11491정성태9/30/20192655개발 환경 구성: 359. Azure 가상 머신에 Web Application을 배포하는 방법
... 16  17  18  19  20  21  22  23  24  25  26  27  28  [29]  30  ...