用 .NET 3.5 创建 ToJSON() 扩展方法

今年早些时候，我通过blog介绍了 C# 和 VB 语言的一项新的扩充特性"扩展方法"。

扩展方法让开发者可以向已有的 CLR 类型的公共契约中添加新的方法，而不需要子类化或重新编译原有的类型。通过这种做法，可以使很多有用的应用场景成为可能（包括 LINQ）。同时，扩展方法也可以用来非常方便地向代码中添加"语法糖"。

过去几个月，我一直在准备一些很酷的扩展方法的清单，并计划在有空的时候实现它们（不确定何时...但至少我还能从这些想法中获得乐趣）。在上述清单中有两个扩展方法的应用场景，分别是用于为任意 .NET 对象自动生成JSON (JavaScript Object Notation)或 XML 序列化字符串的。

简单场景：ToJSON() 扩展方法

假设我有一个 Person 类定义如下（注意：我使用了 自动属性的新特性来实现）：

接下来，我就可以初始化一系列 Person 对象的集合，然后只需调用 ToJSON() 扩展方法，就能得到表示该集合内容的 JSON 字符串。如下所示：

这和 .NET 中内建的，Object 类的 ToString() 方法调用方式很相似 —— 只是生成的结果是表示集合内容的 JSON 格式的字符串而已。然后我们就可以在 AJAX 场景的客户端使用它：

注意：点击上图中调试器的放大镜图标，可以打开"文本视图(Text Visualizer)"，能更方便的查看 JSON 序列化字符串：

接下来，这个字符串格式在客户端可以用 JavaScript 来实例化为合适的 JavaScript 对象，用于表示我的集合内容（注： ASP.NET AJAX 有一个内建的 JavaScript 库支持这些特性）。

实现 ToJSON 扩展方法

实现一个基本的 ToJSON() 扩展方法很简单。只要使用 System.Web.Script.Serialization 命名空间下的 JavaScriptSerializer 类即可，然后象下面所示的那样定义两个扩展方法。其中一个方法用于对目标对象图（object graph）进行"深"的序列化，而另一个方法则是一个重载的版本，它允许你指定序列化的深度（比如：ToJSON(2) 只序列化 2 个层次的深度）。

注意，上面的 ToJSON() 扩展方法只是针对 "Object" 类型而定义的——这意味着它可以被用于 .NET 中的任何类型（不限于集合）。也就是说，我们不仅能对上述集合调用　.ToJSON() 方法，还可以对单独的 Person 对象调用 ToJSON() 方法，或者任意其他的 .NET 类型都可以。

要使用上述扩展方法，只需在程序的顶部添加如下命名空间的引用即可：

然后 VS 2008 就可以为任意对象提供针对这些扩展方法的代码自动完成和编译时支持功能：

注意：除了 JavaScriptSerializer 类之外，.NET 3.5 还包含一个新的new System.Runtime.Serialization.DataContractJsonSerializer class 类 ，你也可以用它来做 JSON 序列化/反序列化的工作。

小结

希望以上的例子能给你一个使用扩展方法来封装功能的示例。下次希望我们一起来看一些好的工具库，用于提供类似有用的扩展方法的功能。

我非常想看到其他关于可复用的扩展方法使用场景的建议（请通过这篇帖子的评论来建议）。然后我们可以琢磨出，如何创建一个好的 CodePlex 项目，来把这些方法捆绑到一个库中以便利用。

希望这篇帖子对你有用，