C#中的ICustomFormatter及IFormatProvider接口用法揭秘

 更新时间:2015年06月17日 09:21:30   投稿:junjie   我要评论

这篇文章主要介绍了C#中的ICustomFormatter及IFormatProvider接口用法揭秘,本文能过分析一段代码得出一些研究结果,需要的朋友可以参考下

最近在学习IFormatProvider接口的用法时,在网络上找了段实例代码(具体哪个网站不记得了,就不给出链接了),通过研究实例代码,初步了解了IFormatProvider接口的用法。

在学习代码之前,我们先来了解一下本例中使用到的两个接口ICustomFormatter及IFormatProvider。

查看MSDN,得到以下关于ICustomFormatter及IFormatProvider接口的说明。

接口ICustomFormatter:定义一种方法,它支持自定义设置对象的值的格式。 ICustomFormatter 接口包含单个方法:ICustomFormatter.Format。当此接口由引用或值类型实现时,Format 方法会返回对象值的自定义格式字符串表示形式。

接口IFormatProvider:提供用于检索控制格式化的对象的机制。 类或数值类型实现此接口的 GetFormat方法,以获得提供格式信息或实现类型的处理的对象。IFormatProvider接口同样只包含一个方法。

可能单纯阅读MSDN的说明,还是有点一知半解的感觉。

不过,别急,继续往下看。

下面给出详细代码,看下面...

public class MyFormater:ICustomFormatter,IFormatProvider
{
  public object GetFormat(Type format)
  {
    if (format == typeof(ICustomFormatter))
      return this;
    return null;
  }

  public string Format(string format, object arg, IFormatProvider provider)
  {
    if (format == null)
    {
      if (arg is IFormattable)
       return ((IFormattable)arg).ToString(format, provider);
      return arg.ToString();
    }
    else
    {
      if (format == "MyFormater")
      {
        return "**" + arg.ToString();
      }
      else
      {
        if (arg is IFormattable)
          return ((IFormattable)arg).ToString(format, provider);
        return arg.ToString();
      }
    }
  }
}
static void Main(string[] args)
{   
   int i = 100;
   string printString;
   MyFormater myFormater = new MyFormater();
   printString = string.Format(myFormater, "{0}", i);
   Console.WriteLine("{0}", printString);
   printString = string.Format(myFormater, "{0:C}", i);
   Console.WriteLine("{0}", printString);
   printString = string.Format(myFormater, "{0:MyFormater}", i);
   Console.WriteLine("{0}", printString);
}

代码中定义了类MyFormater(暂且叫作“自定义格式化类”),该类实现了ICustomFormatter及IFormatProvider接口,所以该类实现了 GetFormat及Format方法,其实该类除了实现这两个方法外,也没有完成其他任何工作。

GetFormat方法对传入参数(类型format)进行判断,如果传入的类型format为ICustomFormatter,就返回类本身,否则返回null。我个人的理解就是:调用MyFormater类的GetFormat方法时,传入类型要求,告诉类MyFormater,你必须满足类型要求,否则我就不要你了,你要是满足条件,我就要定你了。从MyFormater的角度来思考的话,就是:我(MyFormater)就能提供类型为ICustomFormatter的我。举个不恰当的例子,你非得要个人妖,我怎么能给你呢,我可是绝对的纯爷们,呵呵大哭。可见,GetFormat方法主要提供一个满足指定要求的对象,该对象提供格式信息。那该对象提供的格式信息由谁来提供呢,当然是Format方法,msdn对这个有很明确的说明,“Format 方法会返回对象值的自定义格式字符串表示形式。”

学习到这里,是不是感觉自己有一丁点的明白了呢。

如果还是一团浆糊,也没事,接着往下看。

不过,到这里,不管你脑子里到底有多浆糊。我都希望你至少能明白一点,那就是GetFormat方法负责返回提供格式信息的对象(这里的MyFormater),而Format 方法负责返回具体的格式信息。说得再简单点,那就是:先得到提供格式化信息的对象,再得到该对象提供的格式化信息。

好了,不罗嗦了,继续往下看。

在解释Format方法的具体实现前,先来看看我们的代码到底是怎样运行的。

在Main函数中,定义整型变量i,并初始化为100;定义字符串printString用来保存返回值;实例化MyFormater,得到对象myFormater。并调用string.Format方法生成printString。

printString = string.Format(myFormater, "{0}", i);
printString = string.Format(myFormater, "{0:C}", i);
printString = string.Format(myFormater, "{0:MyFormater}", i);

代码中采用上面三种方式来调用string.Format方法,三者的区别仅在第二个参数。要想弄清楚三者的区别,只有搞清楚string.Format方法到底做了些什么才能知道,所以下面来看看string.Format方法都做了些什么。

在这里,我们需要使用Reflector来查看string.Format方法的源码。

string.Format方法的代码如下:

public static string Format(IFormatProvider provider, string format, params object[] args)
{
  if ((format == null) || (args == null))
  {
    throw new ArgumentNullException((format == null) ? "format" : "args");
  }
  StringBuilder sb = StringBuilderCache.Acquire(format.Length + (args.Length * 8));
  sb.AppendFormat(provider, format, args);
  return StringBuilderCache.GetStringAndRelease(sb);
}

结合我们的函数调用阅读函数签名,了解到:string.Format方法的第一个参数接收我们传入的自定义格式化类对象myFormater,第二个参数接收格式化字符串format,第三个参数接收需要被格式化的参数集合args,这里仅变量i。

查看string.Format方法体,可以了解到:方法先对传入参数format及args进行非法判断,参数为空时抛出参数空异常。参数正常时,初始化StringBuilder 对象(关于StringBuilderCache.Acquire的使用这里不做过多介绍,自己去研究),接着调用sb.AppendFormat方法,最后通过语句return StringBuilderCache.GetStringAndRelease(sb)返回结果。可见,真正的格式化操作都在sb.AppendFormat方法中完成,这里并不打算给出sb.AppendFormat方法的完整代码,只是给出sb.AppendFormat方法中调用GetFormat 方法和Format 方法的代码。

if (provider != null)
{
    formatter = (ICustomFormatter) provider.GetFormat(typeof(ICustomFormatter)); 
}

代码传入参数typeof(ICustomFormatter),返回ICustomFormatter类型的formatter 。

if (formatter != null)
{
  if (builder != null)
  {
    str = builder.ToString();    
  }
  str2 = formatter.Format(str, arg, provider);
}

上面就是代码中调用Format方法的地方。

执行上面代码都会去执行我们的自定义格式化类MyFormater的代码。

要想了解详细的执行情况,那就请代开你的VS,开始敲代码吧。

好像到这里,我也没有把问题很好的解释清楚。

这与我对.NET库代码一窍不通是有很大关系的。其实,到这里,我对sb.AppendFormat方法的具体操作也还是停留在了解的层面上,所以就没有过多叙述了。希望大家能谅解。但是到最后,大家至少对我们自定义的格式化类MyFormater在.NET库中是如何被使用的应该有一个初步认识了。

就到这里了。最后给出程序执行结果。看下面...

哦,忘了解释Format方法的代码,哎,太累了,就不解释了,大家都是牛人,能看懂的。

相关文章

  • C#随机生成Unicode类型字符串

    C#随机生成Unicode类型字符串

    做测试时经常需要生成一些随机数据,最常见的就是生成随机字符串。而且往往要生成Unicode字符串,有时还要特别指定生成的字符的语言范围。下面是我觉得比较灵活的方法:
    2013-04-04
  • C# winform 模拟键盘输入自动接入访问网络的实例

    C# winform 模拟键盘输入自动接入访问网络的实例

    本篇文章主要介绍了C# winform 模拟键盘输入自动接入访问网络,有兴趣的可以了解一下。
    2016-11-11
  • C#中TCP粘包问题的解决方法

    C#中TCP粘包问题的解决方法

    这篇文章主要为大家详细介绍了C#中TCP粘包问题的解决方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • C#词法分析器之构造NFA详解

    C#词法分析器之构造NFA详解

    本篇文章介绍了,C#词法分析器之构造NFA详解。需要的朋友参考下
    2013-05-05
  • C#实现根据数字序号输出星期几的简单实例

    C#实现根据数字序号输出星期几的简单实例

    这篇文章主要介绍了C#实现根据数字序号输出星期几的简单实例,代码简洁实用,也有助于初学者更好的理解C#的switch和if语句的流程控制,需要的朋友可以参考下
    2014-07-07
  • C# 骑士飞行棋的源码(分享)

    C# 骑士飞行棋的源码(分享)

    以下是骑士飞行棋的源码,需要的朋友可以拿去用
    2013-05-05
  • C#面向对象设计的七大原则

    C#面向对象设计的七大原则

    这篇文章主要为大家详细介绍了C#面向对象设计的七大原则,未读文章之前大家说一说都有哪七大原则,是不是七大原则都可以全部列出,想要了解的朋友可以参考一下
    2016-05-05
  • 解决C#中Linq GroupBy 和OrderBy失效的方法

    解决C#中Linq GroupBy 和OrderBy失效的方法

    最近发现了一个问题,在服务器端的Linq GroupBy 和OrderBy居然不管用,后来终于解决了所以现在分享给大家,有需要的朋友们可以参考借鉴。
    2016-09-09
  • C#中this的用法集锦

    C#中this的用法集锦

    本文给大家汇总介绍了C#中的几种this用法,相信大家应该有用过,但你用过几种?以下是个人总结的this几种用法,欢迎大家拍砖,废话少说,直接列出用法及相关代码。
    2015-06-06
  • c#自带缓存使用方法 c#移除清理缓存

    c#自带缓存使用方法 c#移除清理缓存

    这篇文章主要介绍了c#自带缓存使用方法,包括获取数据缓存、设置数据缓存、移除指定数据缓存等方法,需要的朋友可以参考下
    2014-02-02

最新评论