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方法的代码，哎，太累了，就不解释了，大家都是牛人，能看懂的。