StringTemplate.Net 学习笔记（6）：自定义输出格式

ST对于attribute的输出，默认都是调用attribute.ToString()方法。如果要自定义输出格式，则需要实现IAttributeRenderer接口。

下面来定义一个自定义日期格式化输出：

    class CustomDataRenderer : IAttributeRenderer {
        public string ToString(object o)
        {
            if (o == null)
                return null;
            string str = o.ToString();
            DateTime dt;
            if (!DateTime.TryParse(o.ToString(), out dt))
                return str;
            return dt.ToString("yyyy年MM月dd日 HH点mm分");
        }
        public string ToString(object o, string formatName)
        {
            throw new NotImplementedException();
        }
    }

使用：

    StringTemplate st = new StringTemplate("$d$");
    st.RegisterRenderer(typeof(DateTime), new CustomDataRenderer());//在当前Template注册DateTime类型的默认输出格式
    st.SetAttribute("d", DateTime.Now);
    Console.WriteLine(st.ToString());    输出结果：2010年04月30日 21点30分

可以看到输出了前面定义的ToString(object o)方法定义的格式，那么如果需要输出多种格式，这个方法就显得力不从心了。

接下来改造CustomDataRenderer类，使它能输出多种格式：

    ///

    /// 自定义ST日期格式输出
    ///

    class CustomDataRenderer : IAttributeRenderer {
        ///

        /// 默认的输出方法
        ///

        public string ToString(object o)
        {
            return ToString(o, null);
        }
        ///

        /// 指定输出格式时的输出方法
        ///

        /// 格式名称
        public string ToString(object o, string formatName)
        {
            if (o == null)
                return null;
            string str = o.ToString();
            DateTime dt;
            if (!DateTime.TryParse(o.ToString(), out dt))
                return str;
            switch (formatName) {
                case "CNDate":
                    return dt.ToString("yyyy年MM月dd日");
                case "CNTime":
                    return dt.ToString("HH点mm分");
                default :
                    return dt.ToString("yyyy年MM月dd日 HH点mm分");
            }
        }
    }

使用：

    StringTemplate st = new StringTemplate("[$d1$] [$d2;format=/"CNDate/"$] [$d3;format=/"CNTime/"$]");
    st.RegisterRenderer(typeof(DateTime), new CustomDataRenderer());//在当前Template注册DateTime类型的默认输出格式
    st.SetAttribute("d1", DateTime.Now);
    st.SetAttribute("d2", DateTime.Now);
    st.SetAttribute("d3", DateTime.Now);
    Console.WriteLine(st.ToString());    输出：[2010年04月30日 21点40分] [2010年04月30日] [21点40分]

OK，完成了预期的目的。通过实现IAttributeRenderer接口，我们相可以实现对其他任意类型的输出进行格式化。需要注意的是，每一个Template的一种类型只能注册一个Renderer，对于模板组则通过StringTemplateGroup的 SetAttributeRenderers方法注册。

参考：http://www.antlr.org/wiki/display/ST/Object+rendering#Objectrendering-FormatOption