原文
WPF:使用Json.NET在TreeView中树形显示JSON数据
据
读者可以参考这个开源的可以树形显示XML和JSON的工具:
Mgen Object 603:XML/JSON树形显示小工具
或者一个更大的开源工程(构建和分析HTTP并支持XML及JSON的树形显示):
Mgen Bluckbadda
效果如下:
(每一个项目中的左侧黑字是数据的值,右侧灰字是数据的类型。对于对象或数组,黑字会显示对象的属性个数或数组的成员个数)
(上图中的JSON数据来自:http://www.jsonexample.com/ 中的最下面的示例JSON)
具体实现方法是通过利用Json.NET中的Json对象基类:JToken类型,在Newtonsoft.Json.Linq命名空间内,这个类型的派生类型有:
JValue类型代表着一个Json数据值,也就是不会再有子节点的原子值。
而另一个JToken的直接继承者是JContainer类型,代表数据对象有子节点,它的派生类型:JProperty,JObject和JArray分别代表属性,对象和数组。
我最初想到的是用JToken类型的Type属性来构建树,但是随后发现JTokenType的定义完全平面化,不利于不同类型成员结构的创建,于是采用直接判断JToken对象类型的方式来构建树。也就是直接根据不同JToken类型来生成其相应的成员节点数据。
整个树的数据类型由一个类型来完成,名称是JsonHeaderLogic,它定义三个属性:
public string Header { get; private set; }
public IEnumerable<JsonHeaderLogic> Children { get; private set; }
public JToken Token { get; private set; }
Header是当前节点的显示文字。
Children是子节点。(如果没有的话值是null)
Token是原始的Json.NET中的JToken对象。
那么在界面上,我们就可以直接使用WPF中TreeView和HierarchicalDataTemplate来这样定义DataTemplate:
<TreeView Name="treeView">
<TreeView.ItemTemplate>
<HierarchicalDataTemplate ItemsSource="{Binding Children}">
<StackPanel Orientation="Horizontal">
<TextBlock Text="{Binding Header}"/>
<TextBlock Text="{Binding Token.Type}" Margin="10 0 0 0" Foreground="Gray"/>
StackPanel>
HierarchicalDataTemplate>
TreeView.ItemTemplate>
TreeView>
JsonHeaderLogic类型的完整定义:
//+ using Newtonsoft.Json.Linq;
class JsonHeaderLogic
{
//用于对应Json对象类型的格式化字符
const string NULL_TEXT = "";
const string ARRAY = "[{0}]";
const string OBJECT = "[{0}]";
const string PROPERTY = "{0}";
//用于界面绑定的属性定义
public string Header { get; private set; }
public IEnumerable<JsonHeaderLogic> Children { get; private set; }
public JToken Token { get; private set; }
//内部构造函数,使用FromJToken来创建JsonHeaderLogic
JsonHeaderLogic(JToken token, string header, IEnumerable<JsonHeaderLogic> children)
{
Token = token;
Header = header;
Children = children;
}
//外部的从JToken创建JsonHeaderLogic的方法
public static JsonHeaderLogic FromJToken(JToken jtoken)
{
if (jtoken == null)
{
throw new ArgumentNullException("jtoken");
}
var type = jtoken.GetType();
if (typeof(JValue).IsAssignableFrom(type))
{
var jvalue = (JValue)jtoken;
var value = jvalue.Value;
if (value == null)
value = NULL_TEXT;
return new JsonHeaderLogic(jvalue, value.ToString(), null);
}
else if (typeof(JContainer).IsAssignableFrom(type))
{
var jcontainer = (JContainer)jtoken;
var children = jcontainer.Children().Select(c => FromJToken(c));
string header;
if (typeof(JProperty).IsAssignableFrom(type))
header = String.Format(PROPERTY, ((JProperty)jcontainer).Name);
else if (typeof(JArray).IsAssignableFrom(type))
header = String.Format(ARRAY, children.Count());
else if (typeof(JObject).IsAssignableFrom(type))
header = String.Format(OBJECT, children.Count());
else
throw new Exception("不支持的JContainer类型");
return new JsonHeaderLogic(jcontainer, header, children);
}
else
{
throw new Exception("不支持的JToken类型");
}
}
}
定义好了JsonHeaderLogic类型,在相应界面事件后使用FromJToken方法来创建JsonHeaderLogic对象然后绑定到界面TreeView控件数据源就可以了:
//创建JObject
//textfile1.txt存储着需要解析的JSON数据
var jobj = JObject.Parse(System.IO.File.ReadAllText("textfile1.txt"));
//创建TreeView的数据源
treeView.ItemsSource = jobj.Children().Select(c => JsonHeaderLogic.FromJToken(c));
源代码下载
下载地址
注意:此为微软SkyDrive存档,请用浏览器直接下载,用某些下载工具可能无法下载
示例程序运行环境:.NET Framework 4.0 Client Profile
源代码环境:Microsoft Visual Studio Express 2012 for Windows Desktop
注意:源代码不包含引用的外部类库文件: Json.NET