C# - FormattableString 타입

C#의 언어 발전을 보면, 참 재미있는 현상을 하나 볼 수 있습니다.

가령, 어떤 기능이 추가되면, 그로 인해 또 다른 기능이 필요해진다는 점입니다. 예를 들어 지난번 Lambda 개선도 그 한 예입니다. 메서드를 람다 식으로 정의할 수 있도록 해줬더니, 람다 식을 정적(static) 메서드로도 지원해야 하고, 특성도 지정할 수 있게 바꿔야 하는 것입니다.

FormattableString도 그와 같은 연유로 나온 것입니다. 일반적이었다면 이것은 필요 없는 타입입니다. 그런데, 문자열 보간 문법이 C# 6에 추가되면서 "추가되어야만" 했던 기능입니다. 이 타입에 대한 자세한 설명을 다음의 책이 하고 있습니다.

C#을 다루는 기술 - 9.3 FormattableString을 사용한 현지화 (371페이지)
; http://www.yes24.com/Product/Goods/101511486

이에 대해 간략하게 정리를 해볼까요? ^^

일단, 보간 문법이 String.Format으로 바뀐다는 사실은 익히 알고 있을 것입니다.

// C# 5.0 이전에는 string.Format으로 처리
string text = string.Format("{0}", DateTime.Now);

// C# 6.0 이후부터 문자열 보간 지원
// 보간 문자열을 C# 컴파일러는 string.Format으로 변경
string text = $"{DateTime.Now}";

그런데, 여기엔 작은 문제가 하나 있습니다. 보간 문자열을 지원하기 전에는, 문자열에 대해 Localization을 하고 싶다면 string.Format에 CultureInfo를 받아들이는 오버로드 메서드를 사용하면 됐습니다.

public static string Format(IFormatProvider? provider, string format, object? arg0)
public static string Format(string format, object? arg0)

반면, 문자열 보간에서는 저 "IFormatProvider? provider"를 받아들일 수 있는 방법이 없는 것입니다. 이로 인해 마이크로소프트는 보간 문자열을 위한 CultureInfo를 반영할 수 있도록 .NET 4.6/.NET Standard 1.3부터 FormattableString을 만들었고, C# 컴파일러에서도 다시 이를 지원하기 위한 변경을 추가합니다. 즉, 보간 문자열을 string 타입으로도 받을 수 있지만, FormattableString 타입으로도 받을 수 있게 한 것입니다.

// C# 컴파일러는, 보간 문자열의 반환 타입이 string이라면 string.Format으로 변경
string text1 = $"test: {v.ToString()}, {subText.ToString()}";

// 만약 보간 문자열의 반환 타입이 FormattableString이라면 (string.Format으로 처리하지 않고) FormattableString 인스턴스를 반환
FormattableString text2 = $"test: {v.ToString()}, {subText.ToString()}";

// 만약 var로 추론하는 경우라면 string으로 판단해 string.Format 처리
var text3 = $"test: {v.ToString()}, {subText.ToString()}";

// FormattableString은 IFormattable을 상속한 추상 클래스이고,
// 정확한 반환 타입은 FormattableString을 상속한 System.Runtime.CompilerServices.FormattableStringFactory.ConcreteFormattableString
IFormattable text4 = $"test: {v.ToString()}, {subText.ToString()}";

뭐랄까, 이것은 마치 람다 표현식이 대입이 되는 대상 타입에 따라 ExpressionTree 또는 Delegate로 처리되는 것과 유사합니다. 이렇게 FormattableString으로 받게 되면 이후 "문자열 보간"에서는 지원하지 못했던 Localization을 다음과 같이 처리할 수 있습니다.

// 중립 처리
string t1 = FormattableString.Invariant(text2);      
string t2 = text2.ToString(CultureInfo.InvariantCulture); // t1 == t2

// Localization 명시
string t3 = text2.ToString(CultureInfo.GetCultureInfo("en-US"));

// 현재 스레드의 Localization 처리
string t4 = FormattableString.CurrentCulture(text2);     
string t5 = text2.ToString(); // t4 == t5

얼핏 보면, FormattableString의 등장으로 인해 사용법이 더 복잡해진 것 같은데요, 그래도 간략화하면 이전의 string.Format과 유사한 정도로 단순해집니다.

{
    DateTime now = DateTime.UtcNow;

    // string.Format에서 중립 처리
    string text1 = string.Format(CultureInfo.InvariantCulture, "{0:yyyy-MM-dd}", now);

    // FormattableString에서 중립 처리
    string text2 = FormattableString.Invariant($"{now:yyyy-MM-dd}");
    string text3 = $"{now:yyyy-MM-dd}".ToString(CultureInfo.InvariantCulture);
              // = ((FormattableString)$"{now:yyyy-MM-dd}").ToString(CultureInfo.InvariantCulture);
} 

그나저나, "https://miriam40.github.io/2019/07/15/5-post/" 글에 보면, effective C#의 예제라면서 다음의 코드를 소개하는데요,

public static string ToGerman(FormattableString src)
{
   return string.Format(CultureInfo.CreateSpecificCulture("de-de"), src.Format, src.GetArguments());
}

public static string ToGerman(FormattableString src)
{
   return string.Format(CultureInfo.CreateSpecificCulture("fr-CA"), src.Format, src.GetArguments());
}

좀 복잡하게 해서 그렇지, 이것 역시 다음과 같이 단순화할 수 있습니다.

static string ToGerman(FormattableString src)
{
    return src.ToString(CultureInfo.GetCultureInfo("de-de"));
}

static string ToFrench(FormattableString src)
{
    return src.ToString(CultureInfo.GetCultureInfo("fr-CA"));
}

---

위의 소스 코드에서 FormattableString의 Format과 GetArguments() 메서드를 볼 수 있는데요, 사실 C# 컴파일러는 FormattableString으로 반환해야 하는 보간 문자열을 만나면 string.Format이 아닌, 포맷 문자열과 인자 목록을 별도로 취해 FormattableString으로 넘겨주는 역할을 합니다.

string name = "World";
FormattableString text = $"Hello {name}";

// 아래와 같이 처리
ConcreteFormattableString
    Format = "Hello {0}";
    Arguments = object [] { name };

그러니까, 최종 문자열이 반환되기보다는 중간 처리 결과를 보관하고 있으므로 일종의 "지연 연산"과 같은 기능을 하는 것입니다. 그리고, LINQ 쿼리에서 Expression Tree로 받아 SQL 쿼리를 생성했던 것처럼, 위와 같은 특성으로 FormattableString 역시 그와 유사한 전처리를 할 수 있는 여지가 있습니다.

"C#을 다루는 기술" 책에서는 FormattableString의 그런 특성을 반영해, raw query를 Parameterized Query로 자동으로 변형해 주는 코드를 보여줍니다. (관심있으신 분은 책 구매로... ^^)

그런데 만약, C# 컴파일러 개발진이 문자열 보간에 CultureInfo를 받아들일 수 있는 쪽으로 보완을 했다면 어땠을까요? ^^

// 컴파일되지 않음!
string text = $(CultureInfo.GetCultureInfo("de-de"))"{DateTime.Now}";

만약 저런 형식을 허용했다면 FormattableString은 나오지 않았을지도 모를 일입니다. ^^

---

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

[최초 등록일: 8/31/2021]
[최종 수정일: 8/31/2021]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com