C#の文字列テンプレートクラス（StringTemplate）とは？名前付きプレースホルダーで可読性の高い文字列整形を実現

C#のStringTemplateクラスとは

StringTemplateクラスは、書式指定文字列を解析するためのクラスで、標準のString.Formatと互換性を持つように設計されています。このクラスは、拡張メソッドを多数提供するNStringライブラリに含まれており、文字列操作をより直感的かつ簡単に行えるようになります。

NStringライブラリが提供する主な拡張メソッド

NStringライブラリには、日常的な文字列処理を簡潔に記述できる便利な拡張メソッドが用意されています。代表的なものは以下の通りです。

IsNullOrEmpty()
IsNullOrWhiteSpace()
Join()
Truncate()
Left()
Right()
Capitalize()

これらのメソッドを使うことで、nullチェックや部分文字列の取得、先頭文字の大文字化といった定型的な処理を、わずか1行のコードで実現できます。

String.Formatとの違い：StringTemplate.Formatのメリット

StringTemplate.Formatは、従来のString.Formatよりも優れた点があります。最大の特徴は可読性の高さとエラーの起きにくさです。

通常のString.Formatでは「{0}」「{1}」のように番号付きのプレースホルダーを使用するため、引数の順序を間違えると出力結果が崩れてしまうリスクがありました。一方、StringTemplateでは名前付きプレースホルダーを採用しているため、どの値がどこに挿入されるのかが一目でわかり、順序の誤りによるバグを防げます。

また、値の並び順も柔軟に扱えるため、後からコードを修正する際にも影響範囲が最小限で済みます。書式指定の方法自体はString.Formatと同様なので、既存の知識をそのまま活かせます。

使用例：名前付きプレースホルダーによる文字列整形

以下は、試験名と試験日を含む文字列を生成するサンプルコードです。

string str = StringTemplate.Format("{ExamName} will held on {ExamDate:D}", new { p.ExamName, p.ExamDate });

この例では、「{ExamName}」と「{ExamDate:D}」という名前付きプレースホルダーを使用しています。「:D」は日付の長い形式（Dフォーマット）を指定する書式指定子で、String.Formatと同じ構文が使えます。

匿名オブジェクトのプロパティ名がそのままプレースホルダー名に対応するため、コードを読むだけで出力内容が把握できるのが大きな魅力です。

まとめ

StringTemplateクラスを活用すれば、C#での文字列整形がより安全かつ読みやすくなります。特に複数の値を埋め込む複雑な文字列を扱う場面では、番号ではなく名前で管理できる恩恵は大きく、保守性の向上にもつながります。NStringライブラリの他の拡張メソッドと併せて、ぜひ活用してみてください。