ASP.NET Web API 2.1支援Binary JSON（Bson）

標籤：

ASP.NET Web API 2.1內建支援XML、Json、Bson、form-urlencoded的MiME type，今天重點介紹下Bson。BSON是由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的規範並沒有定義只返回一個原生值的文法，如返回一個int或string類型的值。

為瞭解決這個問題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

ASP.NET Web API 2.1支援Binary JSON（Bson）