在前面的文章轻量级的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) }; }; } }