C#實現類似"hello $world"的格式化字符串方法

 　　C#自帶的string.Format可以格式化字符串，但是還是不太好用，由於格式的字符占位符都是數字，當數目較多時容易混淆。其實可以擴展string的方法，讓C#的字符串具備其他的方法，下面介紹一個實現類似String.jQueryStringFormat("hello $world", new {world="cnblog" })的擴展方法。

1 變量前綴$

可以仿照jQuery中的選擇器方法，用$作為變量前綴。例如 I love \$something 中的$someting就是變量，可以將something變量的值替換到字符串中。

//模板字符串前綴
private static readonly string __prefix = "$";
// $ 正則表達式 $name
private static readonly Regex VariableRegex = new Regex(@"\$(@{0,1}[a-zA-Z_\.0-9]+)");
        

2 正則表達式捕獲變量

上面定義了變量的規則，必須是$打頭的有效變量，下面將字符串用該正則表達式進行捕獲

private static IEnumerable<string> GetEnumerateVariables(string s)
{
     var matchCollection = VariableRegex.Matches(s);

     for (int i = 0; i < matchCollection.Count; i++)
     {
        yield return matchCollection[i].Groups[1].Value;
     }
}

3 用反射獲取對象屬性的值

傳入的對象含有各個屬性，寫一個方法獲取指定屬性的值

        /// <summary>
        /// 獲取對象的對應屬性值
        /// </summary>
        /// <param name="oValue">包含值的對象</param>
        /// <param name="name">屬性名</param>
        /// <returns></returns>
        private static object ValueForName(object oValue, string name)
        {
            Type type = oValue.GetType();
            var property = type.GetProperty(name);
            if (property != null)
            {
                return property.GetValue(oValue, new object[0]);
            }

            var field = type.GetField(name);
            if (field != null)
            {
                return field.GetValue(oValue);
            }
            throw new FormatException("未找到命名參數: " + name);
        }

4 String方法擴展

        public static string jQueryStringFormat(this String @this, string sjQueryStringT, object oValue)
        {
       
            //檢測驗證
            if (string.IsNullOrEmpty(sjQueryStringT))
                return sjQueryStringT;
            if (!sjQueryStringT.Contains(__prefix))
                throw new Exception("字符串中變量不包含$前綴");
            if (oValue == null)
                return sjQueryStringT;

            //解析
            //need  using System.Linq;
            var variables = GetEnumerateVariables(sjQueryStringT).ToArray();
            foreach (string vname in variables)
            {
                //獲取值
                string vvalue = ValueForName(oValue, vname).ToString();
                //字符串替換
                sjQueryStringT = sjQueryStringT.Replace("$" + vname, vvalue);
               

            }
            return sjQueryStringT;
        }

5 單元測試

其實在VS2012中可以自動生成單元測試代碼，然后稍加改動就可以對編寫的方法進行單元測試，非常方便

       /// <summary>
        ///jQueryStringFormat 的測試
        ///</summary>
        [TestMethod()]
        public void jQueryStringFormatTest()
        {
            string @this = ""; // TODO: 初始化為適當的值

            string Name = "JackWang";
            int ID = 100;
            string sjQueryStringT = "exec func($Name,$$ID)"; // TODO: 初始化為適當的值
            object oValue = new { ID, Name }; // TODO: 初始化為適當的值
            string expected = "exec func(JackWang,$100)"; // TODO: 初始化為適當的值
            string actual;
            actual = StringFormat.jQueryStringFormat(@this, sjQueryStringT, oValue);
            Assert.AreEqual(expected, actual);
            //Assert.Inconclusive("驗證此測試方法的正確性。");
        }

6 應用示范

string Name = "jack";
int ID = 200;
string template = "exec func($Name,$ID)";
string parseText = template.jQueryStringFormat(template, new { ID, Name });
           

也可以傳入一個類的實例

template = "the $Name who ID is $$ID";
parseText = template.jQueryStringFormat(template, new Person { ID = "2", Name = "JackWang" });

 7 GitHub開源

項目源碼放於GitHub中https://github.com/JackWangCUMT/jQueryStringFormat