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

.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)
11537정성태6/8/20183067.NET Framework: 761. C# - SmtpClient로 SMTP + SSL/TLS 서버를 이용하는 방법 [4]
11536정성태6/8/20183146.NET Framework: 760. Microsoft Build 2018 - The future of C# 동영상 내용 정리 [1]파일 다운로드1
11535정성태6/7/20182948.NET Framework: 759. C# - System.Span<T> 성능 [1]
11534정성태10/7/20194221.NET Framework: 758. C# 7.2 - Span<T> [3]
11533정성태6/8/20185531.NET Framework: 757. 포인터 형 매개 변수를 갖는 C++ DLL의 함수를 C#에서 호출하는 방법파일 다운로드1
11532정성태6/5/20182952.NET Framework: 756. JSON의 escape sequence 문자 처리 방식
11531정성태6/5/20185330오류 유형: 468. JSON.parse가 허용하지 않는 문자 [9]
11530정성태6/10/20183532.NET Framework: 755. C# 7.2 - 스택에만 생성할 수 있는 값 타입 지원 - "ref struct" [2]파일 다운로드1
11529정성태5/23/20182799.NET Framework: 754. 닷넷의 관리 포인터(Managed Pointer)와 System.TypedReference [5]파일 다운로드1
11528정성태6/10/20182771.NET Framework: 753. C# 7.2 - 3항 연산자에 ref 지원(conditional ref operator) [1]
11527정성태5/17/20182558오류 유형: 467. RDP 로그인 에러 - This could be due to CredSSP encryption oracle remediation.
11526정성태6/10/20182322.NET Framework: 752. C# 7.2 - 메서드의 반환값 및 로컬 변수에 ref readonly 기능 추가파일 다운로드1
11525정성태6/10/20182489.NET Framework: 751. C# 7.2 - 메서드의 매개 변수에 in 변경자 추가파일 다운로드1
11524정성태6/10/20183415.NET Framework: 750. C# 7.2 - readonly 구조체 [3]파일 다운로드1
11523정성태5/15/20182854.NET Framework: 749. C# - 값 형식의 readonly 인스턴스에 대한 메서드 호출 시 defensive copy 발생 [1]파일 다운로드1
11522정성태5/15/20181815개발 환경 구성: 378. Azure - VM 진단 설정 화면의 "This subscription is not registered with the Microsoft.Insights resource provider."
11521정성태5/15/20181829개발 환경 구성: 377. Azure - 원하는 성능 데이터로 모니터링 대시보드 구성
11520정성태5/12/20182404.NET Framework: 748. C# 7.1 - 참조 어셈블리(Ref Assemblies)
11519정성태3/13/20192568개발 환경 구성: 376. ASP.NET Web Application 프로젝트의 FileSystem 배포(Publish) 시 Before/After Task 설정 방법 [1]
11518정성태5/11/20182269.NET Framework: 747. C# 7.0에서도 부분적으로 가능해진 "타입 추론을 통한 튜플의 변수명 자동 지정"
11517정성태5/10/20182508.NET Framework: 746. Azure runbook 예제 - 6시간 동안 수행 중인 VM을 중지 [1]파일 다운로드1
11516정성태5/9/20181948.NET Framework: 745. Azure runbook을 PowerShell 또는 C# 코드로 실행하는 방법파일 다운로드1
11515정성태6/8/20182270.NET Framework: 744. C# 6 - Expression bodied function
11514정성태5/3/20183725오류 유형: 466. Bitvise - Error in component session/transport/kexHandler [2]
11513정성태5/10/20184401.NET Framework: 743. C# 언어의 공변성과 반공변성 [5]파일 다운로드1
11512정성태5/3/20182062개발 환경 구성: 375. Azure runbook 실행 시 "Errors", "All Logs"에 오류 메시지가 출력되는 경우
... 16  17  18  19  20  21  22  23  24  25  [26]  27  28  29  30  ...