Fork me on GitHub

ASP.NET Web API 2.1支持Binary JSON(Bson)

ASP.NET Web API 2.1内建支持XMLJsonBsonform-urlencodedMiME type,今天重点介绍下BsonBSON是由10gen开发的一个数据格式,目前主要用于MongoDB中,是MongoDB的数据存储格式。BSON基于JSON格式,选择JSON进行改造的原因主要是JSON的通用性及JSON的schemaless的特性。

BSON主要会实现以下三点目标:

1.更快的遍历速度

对JSON格式来说,太大的JSON结构会导致数据遍历非常慢。在JSON中,要跳过一个文档进行数据读取,需要对此文档进行扫描才行,需要进行麻烦的数据结构匹配,比如括号的匹配,而BSON对JSON的一大改进就是,它会将JSON的每一个元素的长度存在元素的头部,这样你只需要读取到元素长度就能直接seek到指定的点上进行读取了。

2.操作更简易

对JSON来说,数据存储是无类型的,比如你要修改基本一个值,从9到10,由于从一个字符变成了两个,所以可能其后面的所有内容都需要往后移一位才可以。而使用BSON,你可以指定这个列为数字列,那么无论数字从9长到10还是100,我们都只是在存储数字的那一位上进行修改,不会导致数据总长变大。当然,在MongoDB中,如果数字从整形增大到长整型,还是会导致数据总长变大的。

3.增加了额外的数据类型

JSON是一个很方便的数据交换格式,但是其类型比较有限。BSON在其基础上增加了"byte array"数据类型。这使得二进制的存储不再需要先base64转换后再存成JSON。大大减少了计算开销和数据大小。当然,在有的时候,BSON相对JSON来说也并没有空间上的优势,比如对{"field":7},在JSON的存储上7只使用了一个字节,而如果用BSON,那就是至少4个字节(32位)

 

在服务端启用BSON  

public static class WebApiConfig

{

public static void Register(HttpConfiguration config)

{

config.Formatters.Add(new BsonMediaTypeFormatter());

 

// Other Web API configuration not shown...

}

}

如果client的请求是"application/bson"webapi将使用BSON的序列化器。 可以将其它的media type也使用BSON就行序列化,如下:  

static async Task RunAsync()

{

using (HttpClient client = new HttpClient())

{

client.BaseAddress = new Uri("http://localhost");

 

// Set the Accept header for BSON.

client.DefaultRequestHeaders.Accept.Clear();

client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/bson"));

 

// Send GET request.

result = await client.GetAsync("api/books/1");

result.EnsureSuccessStatusCode();

 

// Use BSON formatter to deserialize the result.

MediaTypeFormatter[] formatters = new MediaTypeFormatter[] {

new BsonMediaTypeFormatter()

};

 

var book = await result.Content.ReadAsAsync<Book>(formatters);

}

}

序列化原生的类型

   BSON的文档都是key/value的集合,BSON的规范并没有定义只返回一个原生值的语法,如返回一个intstring类型的值。

为了解决这个问题BsonMediaTypeFormatter将原生的类型特殊对待,在序列化前,将其转为key/value形式,key"Value".如下:

public class ValuesController : ApiController

{

public IHttpActionResult Get()

{

return Ok(42);

}

}

返回值:

{ "Value": 42 }

 

当反序列化时,序列化器将数据转为原始的值。当然如果使用其它的BSON序列化器,如果服务端返回这样类型的数据,BSON解析器需要处理这种情况。 

 

https://visualstudiomagazine.com/articles/2014/05/01/implementing-binary-json-in-aspnet-web-api-2_1.aspx

posted @ 2015-05-16 21:53 张善友 阅读(...) 评论(...) 编辑 收藏