一、简单描述

Before:如果返回null,拦截器将主动权转给路由;如果返回Response对象,则路由不起作用。

After : 没有返回值,可以在这里修改或替换当前的Response。

OnError : 返回值与Before相似,引发的错误或异常时的控制代码可以写在这里。

这三兄弟的大致作用,看名字,也可以这样简单的理解:

Before:处理之前要干的事。(返回null,继续处理;返回Response对象,不再做要干的那件事,换做Response对象要干的事)

After : 处理之后要干的事。

OnError : 处理出错了要干的事。

这三兄弟在NancyModule中的定义如下

 public AfterPipeline After { get; set; }
public BeforePipeline Before { get; set; }
public ErrorPipeline OnError { get; set; }

而这三个Pipeline分别继承了

AsyncNamedPipelineBase<TAsyncDelegate, TSyncDelegate>和NamedPipelineBase<TDelegate>

所以与他们有关的就主要包含在5个类中!具体的放在最后来看一下!

二、简单用法

我们可以在Module中直接使用Before/After/OnError这三个

也可以在Bootstrapper中重写RequestStartup或者ApplicationStartup来实现

当然也可以自定义,只要实现IRequestStartup或者IApplicationStartup接口也可以完成相应的工作

下面我们就分别来说明一下

用法一:直接在Module中使用

定义一个BaseModule,具体如下:

     public class BaseModule : NancyModule
{
public BaseModule()
{
//写法一
Before += ctx => {
System.Diagnostics.Debug.WriteLine("BaseModule---Before");
return null;
};
After += ctx => {
System.Diagnostics.Debug.WriteLine("BaseModule---After");
};
OnError += (ctx, ex) => {
System.Diagnostics.Debug.WriteLine("BaseModule---OnError");
System.Diagnostics.Debug.WriteLine(ex.ToString());
return null;
};
//写法二
//Before += MyBefore;
//After += MyAfter;
//OnError += MyOnError;
}
private Response MyBefore(NancyContext ctx)
{
System.Diagnostics.Debug.WriteLine("BaseModule---Before----写法二");
return null;
}
private void MyAfter(NancyContext ctx)
{
System.Diagnostics.Debug.WriteLine("BaseModule---After----写法二");
}
private Response MyOnError(NancyContext ctx, Exception ex)
{
System.Diagnostics.Debug.WriteLine("BaseModule---OnError----写法二");
System.Diagnostics.Debug.WriteLine(ex.ToString());
return null;
}
}

在BaseModule中,用了两种不同的形式来对Before、After、OnError进行处理,

都只是打印出一些简单的信息,看这些输出的信息,可以帮助理解内部执行的顺序!

可以看到,Before和OnError是Response类型的,After是void类型的

在这三兄弟的具体处理中,要根据实际情况来定(当然,你想就打印出一些东西也没问题,毕竟我们还是可以把这些东西写进日记嘛)!

下面定义一个HomeModule,具体如下:

     public class HomeModule : BaseModule
{
public HomeModule()
{
Get["/"] = _ => "Catcher Wong";
Get["/err"] = _ => { throw new Exception("there're some errors"); };
}
}

其中,当我们访问http://localhost:port时,会显示我们的文字,访问http://localhost:port/err时,会抛出我们设定异常!

运行起来,看看我们的Output(输出)窗口

这是访问http://localhost:port时的情况

访问http://localhost:port/err时的情况

出现异常后并没有去执行After!!执行完OnError之后就结束了。

同样的,用写法二也是如此!

基本一致的效果。

用法二:在bootstrapper中重写RequestStartup或者ApplicationStartup

先来看看重写RequestStartup

     public class Bootstrapper : DefaultNancyBootstrapper
{
protected override void RequestStartup(TinyIoCContainer container, IPipelines pipelines, NancyContext context)
{
base.RequestStartup(container, pipelines, context);
pipelines.BeforeRequest += ctx => {
System.Diagnostics.Debug.WriteLine("Boorstrapper---RequestStartup---Before");
return null;
};
pipelines.AfterRequest += ctx => {
System.Diagnostics.Debug.WriteLine("Boorstrapper---RequestStartup---After");
};
pipelines.OnError += (ctx,ex) => {
System.Diagnostics.Debug.WriteLine("Boorstrapper---RequestStartup---OnError");
System.Diagnostics.Debug.WriteLine(ex.ToString());
return null;
};
}
}

我们同样是输出相应的信息,运行前,把我们BaseModule中“三兄弟”的注释掉

再来看看重写ApplicationStartup

      public class Bootstrapper : DefaultNancyBootstrapper
{
protected override void ApplicationStartup(TinyIoCContainer container, IPipelines pipelines)
{
base.ApplicationStartup(container, pipelines);
pipelines.BeforeRequest += MyBeforeRequest;
pipelines.AfterRequest += MyAfterRequest;
pipelines.OnError += MyOnErroe;
}
private Response MyBeforeRequest(NancyContext ctx)
{
System.Diagnostics.Debug.WriteLine("Boorstrapper---ApplicationStartup---Before");
return null;
}
private void MyAfterRequest(NancyContext ctx)
{
System.Diagnostics.Debug.WriteLine("Boorstrapper---ApplicationStartup---After");
}
private Response MyOnErroe(NancyContext ctx, Exception ex)
{
System.Diagnostics.Debug.WriteLine("Boorstrapper---ApplicationStartup---OnError");
System.Diagnostics.Debug.WriteLine(ex.ToString());
return null;
}
}

我们同样是输出相应的信息,运行前,把我们BaseModule和RequestStartup中“三兄弟”的注释掉

用法三:自定义用法(Nancy中有很多东西可以自定义,这个很灵活,很nice!)

下面来看看自定就要怎么使用!

     public class CustomRequest : IApplicationStartup
{
public void Initialize(IPipelines pipelines)
{
pipelines.BeforeRequest.AddItemToEndOfPipeline(ctx =>
{
System.Diagnostics.Debug.WriteLine("CustomRequest---IApplicationStartup---Before");
return null;
});
pipelines.AfterRequest.AddItemToEndOfPipeline(ctx =>
{
System.Diagnostics.Debug.WriteLine("CustomRequest---IApplicationStartup---After");
});
pipelines.OnError.AddItemToEndOfPipeline((ctx, ex) =>
{
System.Diagnostics.Debug.WriteLine("CustomRequest---IApplicationStartup---OnError");
System.Diagnostics.Debug.WriteLine(ex.ToString());
return null;
});
}
}

我们自定义一个CustomRequest让它实现IApplicationStartup接口即可!

剩下的就是实现Before、After、OnError的处理!!

把之前的相关处理注释掉,运行。

效果如下:

 
前面提到的,都是每种用法单独的运行执行效果,那么,每种用法的执行顺序呢?下面来看看,把所有的注释去掉,运行
 
 

现在是否很清晰呢?

Before 的执行顺序  IApplicationStartup > ApplicationStartup > RequestStartup > BaseModule

OnError的执行顺序 BaseModule > IApplicationStartup > ApplicationStartup > RequestStartup
 
再来看看After的执行顺序

与OnError的处理顺序一样!!

三、内部实现的简单分析

前面也提到了,这三兄弟的实现主要有这几个类

BeforePipeline、AfterPipeline、ErrorPipeline以及抽象类NamedPipelineBase、AsyncNamedPipelineBase

NancyModule中也有相应的Before、After、OnError定义!

先来看看BeforePipeline吧

BeforePipeline是实现了AsyncNamedPipelineBase这个抽象类

里面有用到 implicit operator ,不熟悉的可以参考

implicit (C# Reference)

有一个重写的Wrap方法,用于把同步的包装成异步的形式

         protected override PipelineItem<Func<NancyContext, CancellationToken, Task<Response>>> Wrap(PipelineItem<Func<NancyContext, Response>> pipelineItem)
{
var syncDelegate = pipelineItem.Delegate;
Func<NancyContext, CancellationToken, Task<Response>> asyncDelegate = (ctx, ct) =>
{
var tcs = new TaskCompletionSource<Response>();
try
{
var result = syncDelegate.Invoke(ctx);
tcs.SetResult(result);
}
catch (Exception e)
{
tcs.SetException(e);
}
return tcs.Task;
};
return new PipelineItem<Func<NancyContext, CancellationToken, Task<Response>>>(pipelineItem.Name, asyncDelegate);
}

其他的大致都可以总结成下面这句代码:

pipeline.AddItemToEndOfPipeline(xxxx);

把xxxx添加到管道中的末尾去。

同样的,AfterPipeline与ErrorPipeline也是相类似的,

不同的是ErrorPipeline实现的是NamedPipelineBase这个抽象类,

没有那个Wrap方法,多了一个dynamic的Invoke方法

         public dynamic Invoke(NancyContext context, Exception ex)
{
dynamic returnValue = null;
using (var enumerator = this.PipelineDelegates.GetEnumerator())
{
while (returnValue == null && enumerator.MoveNext())
{
returnValue = enumerator.Current.Invoke(context, ex);
}
}
return returnValue;
}

这个Invoke方法的作用是:依次调用每个管道项目,直到有管道项目被返回或者所有管道项目都已经被调用了!

两个NamePipelineBase(同步和异步)都定义了一个pipelineItems(要执行的管道项目集合)

还有众多虚方法!!大部分是插入的,还有一个删除的。

其中插入可分为在Pipeline的开始和结尾插入,以及是否要替换已存在的同名的Pipeline

下面的是比较重要的一个方法InsertItemAtPipelineIndex

同步的

          public virtual void InsertItemAtPipelineIndex(int index, PipelineItem<TDelegate> item, bool replaceInPlace = false)
{
var existingIndex = this.RemoveByName(item.Name);
var newIndex = (replaceInPlace && existingIndex != -) ? existingIndex : index;
this.pipelineItems.Insert(newIndex, item);
}

异步的

         public virtual void InsertItemAtPipelineIndex(int index, PipelineItem<TAsyncDelegate> item, bool replaceInPlace = false)
{
var existingIndex = this.RemoveByName(item.Name);
var newIndex = (replaceInPlace && existingIndex != -) ? existingIndex : index;
this.pipelineItems.Insert(newIndex, item);
}
这个方法的主要作用是将item插入到Pipeline的指定位置!(同步和异步的都有相应的实现!!不同的是item的类型而已!)
 
内部实现,简单点的说法就是:就把我们写的东西添加进Pipline去处理
 

最后来看看我们在Bootstrapper和自定义用到的IPipelines

     public interface IPipelines
{
BeforePipeline BeforeRequest { get; set; }
AfterPipeline AfterRequest { get; set; }
ErrorPipeline OnError { get; set; }
}

十分简单的定义!

Nancy之Pipelines三兄弟(Before After OnError)的更多相关文章

  1. 好用的排名函数~ROW_NUMBER(),RANK(),DENSE_RANK() 三兄弟

    排名函数三兄弟,一看名字就知道,都是为了排名而生!但是各自有各自的特色!以下一个例子说明问题!(以下栗子没有使用Partition By 的关键字,整个结果集进行排序) RANK 每个值一个排名,同样 ...

  2. sql语句中----删除表数据的"三兄弟"

    说到删除表数据的关键字,大家记得最多的可能就是delete了 然而我们做数据库开发,读取数据库数据.对另外的两兄弟用得就比较少了 现在来介绍另外两个兄弟,都是删除表数据的,其实也是很容易理解的 老大- ...

  3. Promise的三兄弟:all(), race()以及allSettled()

    摘要: 玩转Promise. 原文:Promise 中的三兄弟 .all(), .race(), .allSettled() 译者:前端小智 Fundebug经授权转载,版权归原作者所有. 从ES6 ...

  4. 一网打尽 @ExceptionHandler、HandlerExceptionResolver、@controlleradvice 三兄弟!

    把 @ExceptionHandler.HandlerExceptionResolver.@controlleradvice 三兄弟放在一起来写更有比较性.这三个东西都是用来处理异常的,但是它们使用的 ...

  5. 设计模式系列之工厂模式三兄弟(Factory Pattern)

    说明:设计模式系列文章是读刘伟所著<设计模式的艺术之道(软件开发人员内功修炼之道)>一书的阅读笔记.个人感觉这本书讲的不错,有兴趣推荐读一读.详细内容也可以看看此书作者的博客https:/ ...

  6. Mysql 中写操作时保驾护航的三兄弟!

    这期的文章主要是讲述写操作过程中涉及到的三个日志文件,看过前几期的话可能你或多或少已经有些了解了(或者从别的地方也了解过).比如整个写操作过程中用到的两阶段提交,又或者是操作过程中涉及到的日志文件,但 ...

  7. 站长管理服务器必读:Ftp、Ftps与Sftp三兄弟的不同与区别以及部署全指引

    文章标题: 站长管理服务器必读:Ftp.Ftps与Sftp三兄弟的不同与区别以及部署全指引 关键字 : ftp,sftp,freesshd,ftps 文章分类: 教程 创建时间: 2020年3月23日 ...

  8. Nancy总结(三)Nancy资料介绍

    Nancy 是一个轻量级用于构建基于 HTTP 的 Web 服务,可以基于 .NET 和 Mono 平台构建轻量级基于 HTTP 的Web 服务.它更多的是借鉴了Ruby的一些特性和Ruby的MVC ...

  9. .NET Nancy 详解(三) Respone 和 ViewEngine

    我们在ASP.NET MVC中可以返回各种类型的ActionResult(以下图片来自于园友--待补..) 在Nancy 中本着简单粗暴的原则,使用方式略有不同.这期我们使用的版本是Nancy的第一个 ...

随机推荐

  1. 多线程导出大规模excel文件

    文章有点水,和前几篇没有太大区别,但是单线程处理大文件导出会非常耗时间,用到多线程才能更加合理的利用资源.大文件也可能会超出excel工作表范围.这里也有相应处理 参考:用DataGridView导入 ...

  2. Lesson 6 Percy Buttons

    Text I have just moved to a house in Bridge Street. Yesterday a bagger knocked at my door. He asked ...

  3. Linux RAID卡优化

    200 ? "200px" : this.width)!important;} --> 介绍 我们的生产服务器经常会做raid存储,但是单单做了raid就能保证性能高效和数据 ...

  4. Android 两个activity生命周期的关系

    Acitivity的生命周期想必大家都清楚,但是两个activity之间其实不是独立各自进行的. 从第一个activity1启动另外一个activity2时,会先调用本activity1的onPaus ...

  5. Windows Azure Storage (20) 使用Azure File实现共享文件夹

    <Windows Azure Platform 系列文章目录> Update 2016-4-14.在Azure VM配置FTP和IIS,请参考: http://blogs.iis.net/ ...

  6. C语言 · 未名湖边的烦恼

    问题描述 每年冬天,北大未名湖上都是滑冰的好地方.北大体育组准备了许多冰鞋,可是人太多了,每天下午收工后,常常一双冰鞋都不剩. 每天早上,租鞋窗口都会排起长龙,假设有还鞋的m个,有需要租鞋的n个.现在 ...

  7. Linux study

    在centos5.5中编译LNMP环境 一.配置好ip, dns, 网关, 确保使用远程连接工具能够连接服务器 centos设置ip地址,网关, dns教程: http://www.osyumwei. ...

  8. Android RatingBar 自定义样式

    Android RatingBar 自定义样式 1.先定义Style: <style name="RadingStyle" parent="@android:sty ...

  9. 程序中保存状态的方式之Cookies

    程序中保存状态的方式之 Cookies,之前写过一篇关于ViewState的.现在继续总结Cookies方式的 新建的测试页面login <%@ Page Language="C#&q ...

  10. Windows Phone 8弹窗

    新建一个UserControl,添加到相应位置 <Grid x:Name="LayoutRoot" Background="{StaticResource Phon ...