Nancy的基本用法
在前面的文章輕量級的Web框架——Nancy 中簡單的介紹了一下Nancy的特點,今天這裡就介紹下它的基本用法,由於2.0的版本還是預覽狀態,我這裡用的是1.4版本,和最小的版本API還是有些差異的。
模組
Nancy的模組的概念類似於Asp.net中的Controller,一個典型的示例如下:
public class Module : NancyModule { public Module() { Get["/greet"] = x => "hello world"; } }
它定義了一個模組,並且定義了該模組下的一個Get操作。Nacy的模組需要繼承自NancyModule ,伺服器啟動時預設會通過反射載入所有程式集下的NancyModule,包括各個dll中的程式集。
如果要實現動態載入別的程式集下的模組,初始化的時候使用Assembly.LoadFile之類的方法將其程式集載入即可。
Assembly.LoadFile(Path.GetFullPath(@".\WebModules.dll"));
操作
在模組中定義操作的基本用法如下:
Get["/greet"] = x => "hello world";
我們訪問http://xxxx/greet的時候,就可以看到hello world字樣。可以看出,每個模組中,對於Get,Post,Put及Delete等基本操作都定義了一個字典,型別為RouteBuilder,在RouteBuilder中定義了各種操作。
路由
預設情況下,RouteBuilder的key值定義的是絕對路徑,例如
Get["/greet"] = x => "hello world";
定義的路由就是/greet。非常直接,
父路由
如果Module下的操作比較多,我們往往會將其設計為放在統一的父路由底下。如果每一個都定義一個父路由顯得比較繁瑣,此時,可以通過在Module中定義父親路由的方式解決此問題。
public class ResourceModule : NancyModule { public ResourceModule() : base("/products") { //此時的路徑就是 /products/list Get["/list"] = _ => "The list of products"; } }
引數傳遞
我們可以使用類似Asp.net類似的路由方式傳遞引數:
Get["/greet/{name}"] = para => $"Hello {para.name}";
引數是通過一個dynamic物件傳遞給該路由的操作行為的,每個引數都是該物件的一個屬性值。可以通過 /greet/abc類似的路徑檢視訪問結果。
但是,有時我們想要通過QueryString傳遞引數,如 /greet?name=abc, 此時可以通過Request.Query獲取查詢字串。示例如下:
public class Module : NancyModule { public Module() { Get["/greet"] = para => { var name = Request.Query["name"]; return $"Hello {name}"; }; } }
返回值
前面的示例我們的操作都是返回一個字串,但這種方式對於複雜物件來說是不夠用的,此時我們就需要用到Nancy的標準返回值物件Response了。
public class Module : NancyModule { public Module() { Get["/image"] = x => { var data = File.ReadAllBytes(@"r:\123.jpg"); return new Response { ContentType = "image/jpg", Contents = s => s.Write(data, 0, data.Length) }; }; } }