请注意,本站并不支持低于IE8的浏览器,为了获得最佳效果,请下载最新的浏览器,推荐下载 Chrome浏览器
欢迎光临。交流群:166852192

Orchard源码分析(3):Orchard.WarmupStarter程序集




概述
Orchard.WarmupStarter程序集包含三个类:WarmupUtility、WarmupHttpModule和Starter<T>。该程序集主要为Orchard应用启动初始化服务。

一、WarmupUtility类
该类是一个静态工具类,包含一个静态只读字段WarmupFilesPath,以及三个方法EncodeUrl、ToUrlString和DoBeginRequest。
1、WarmupFilesPath其值为~/App_Data/Warmup/。
2、EncodeUrl方法与HttpServerUtility.UrlEncode或HttpUtility.UrlEncode等方法执行结果是不相同的,它将一个url字符串转换成另一个只包含数字、字母和下滑线的字符串,使之能够作为友好文件名。比如调用Encodeurl(http://localhost:30320/OrchardLocal/.Trim('/'))将返回字符串http_3A_2F_2Flocalhost_3A30320_2Forchardlocal。
3、ToUrlString方法一般情况下等效于Request.Url.AbsoluteUri属性的值,源码注释说如果使用了代理请求、负载平衡等可能获取不了真实的绝对Url地址,关于这方面我不太熟悉。
4、DoBeginRequest方法接收一个HttpApplication型参数,返回一个bool值表示是否已经在该方法内处理了BeginRequest事件。
首先它通过上面提到的两个方法根据当前请求的绝对url地址生成一个文件名,然后与WarmupFilesPath字段组合成一个物理文件系统路径。比如对于请求http://localhost:30320/OrchardLocal/,生成的物理文件系统路径可能是@E:\Orchard.Source.1.4.1.0\src\Orchard.Web\App_Data\Warmup\http_3A_2F_2Flocalhost_3A30320_2Forchardlocal。方法会检查http_3A_2F_2Flocalhost_3A30320_2Forchardlocal文件是否存在。如果存在,则直接Response.WriteFile输出并返回true。如果不存在,则继续检测请求URL对应的物理文件系统路径下是否存在文件。比如对于请求http://localhost:30320/OrchardLocal/Default.aspx,将会检测网站目录下是否存在Default.aspx。如果存在,将不会进入ASP.NET MVC管道处理(当然,MVC也可以在物理文件存在的情况下继续处理,但Orchard等一般MVC应用都不会这样做),直接返回true。这两种情况之外,方法将返回false。该方法会在WarmupHttpModule类中被使用,如果返回值是false将会把请求放入一个请求队列中&mdash;&mdash;后面将详述。

二、WarmupHttpModule类和Starter<T>类
这两个类是本文将重点分析的类,这里放在一起来分析。WarmupHttpModule类是一个HttpModule,处理异步BeginRequest事件。WarmupHttpModule已经在~/Web.config进行过注册。Starter<T>类则处理初始化相关事宜。
首先我们来重现两类异常,然后看Orchard中是如何利用这两个类来解决的。

1、模拟初始化异常
通过项目模板新建立一个ASP.NET MVC的项目,在Global.asax.cs文件Application_Start方法开头throw一个异常出来:
    throw new Exception();
然后启动调试。在第一次请求发生时,抛出初始化异常:

但第二次(刷新页面)及以后的请求将可能导致请求如果找不到合适的路由,将会显示404错误页:


这种情况下,就不得不重新启动站点了。这对于调试、用户使用上来说非常不友好。当然ASP.NET WebForm程序初始化的时候也存在着类似的问题。你可能会想,在初始化有异常的时候可以继续初始化&mdash;&mdash;如果初始化一直报错就可能导致一个死循环(可通过初始化计数避免)。如果初始化太耗时,则可能会导致将要模拟的第二种异常。
2、模拟服务器太忙异常

通过项目模板新建立一个ASP.NET MVC的项目,在Global.asax.cs文件Application_Start方法中Sleep 10分钟模拟耗时初始化操作:
    Thread .Sleep(1000 * 60 * 10);
然后再创建一个控制台程序对网站进行10000次并发请求,核心代码:
    static void Main(string[] args)
    {
         //网址根据实际请求调整
         String url = http://localhost:10670 ;  
         for (int i = 0; i < 10000; i++)
         {
              WebRequest request = WebRequest.Create(url);
              request.BeginGetResponse(ar=>
              {
                  using (WebResponse response = request.EndGetResponse(ar))
                  {
                      Console.WriteLine( Length:{0} {1},response.ContentLength,DateTime.Now.ToString())
                  }
               },
               null);
         }
         Console.ReadKey();
    }
在VS中运行网站,打开任务管理器,WebDev.WebServer40.EXE的线程数为17(可能会有差异)


然后启动控制台应用程序,运行一段时间后再看任务管理器,WebDev.WebServer40.EXE的线程数达到129个。在我的电脑上,这时候控制台程序已经报异常远程服务器返回错误: (503) 服务器不可用。

退出控制台程序,马上在浏览器打开:http://localhost:10670/,出现错误:

注意,要确保运行控制台测试程序的时候网站没有初始化过,否则看不到效果。
WebDev.WebServer或IIS等Web服务器的线程池中能创建的线程数毕竟是有限的,能并发处理的请求任务也是有限的。当Web服务器发现有太多的请求任务来不及处理的时候,将会导致该错误。像Orchard这类网站,在启动并初始化的时候会进行大量耗时的操作,如果这时候有大量的请求进入,如果不采用合适的处理方式,很快线程将被耗光导致未处理的请求任务过多。

总结问题:ASP.NET初始化操作时,初始化异常不能方便的重现,并且不能继续尝试初始化操作,除非重启应用程序;由于Web服务器线程池线程数的限制,有可能导致&ldquo;服务器太忙&rdquo;的错误。

Orchard.WarmupStarter程序集正是为了解决这些问题。Orchard的初始化步骤如下:

1、在第1次请求发生时,Application_Start方法得以执行,创建Orchard.WarmupStarter.Starter<T>实例,并调用其OnApplicationStart方法。OnApplicationStart方法又调用LaunchStartupThread方法。
    public void OnApplicationStart(HttpApplication application)
    {
        LaunchStartupThread(application);
    }
2、LaunchStartupThread方法会通过线程池启动一个新的线程进行异步初始化操作
     public void LaunchStartupThread(HttpApplication application)
    {
        // Make sure incoming requests are queued
        WarmupHttpModule.SignalWarmupStart();


        ThreadPool.QueueUserWorkItem(
            state =>
            {
                try
                {
                    var result = _initialization(application);
                    _initializationResult = result;
                }
                catch (Exception e)
                {
                    lock (_synLock)
                    {
                        _error = e;
                        _previousError = null;
                    }
                }
                finally
                {
                    // Execute pending requests as the initialization is over
                    WarmupHttpModule.SignalWarmupDone();
                }
            });
    }
3、由于是新开线程进行初始化操作,在初始化过程中,第一次请求会在管道中继续进行,这时候也有可能会有新的请求进入。如果在初始化操作完成之前,任由这些请求进行下去,很可能得不到要想的结果。所以Orchard提供了一个异步HttpMoudle,即Orchard.WarmupStarter.WarmupHttpModule。在初始化正在进行时,将请求的异步BeginRequest处理暂停在那儿,等初始化完成后(不管失败与否),让异步BeginRequest处理完成。在初始化的过程中如果有异常发生,则会将异常记录下来。
LaunchStartupThread方法首先调用WarmupHttpModule的静态方法SignalWarmupStart,用于初始化一个静态List<Action>列表,该列表保存异步结果WarmupAsyncResult类的Completed方法。在初始化完成后,不管成功与否,Completed方法都将会得到调用以保证暂停在那的异步BeginRequest处理完成,即WarmupHttpModule的静态方法SignalWarmupDone。

4、在异步BeginRequest事件处理完成后,将处理同步BeginRequest事件。事件处理程序将检查上一次初始化请求是否有异常发生;如果检查到有异常发生,则会再次执行LaunchStartupThread方法尝试新的初始化操作;如果新的初始化没有异常发生,就忘记上次初始化出现过异常,否则将本次异常进行记录,抛出上次初始化异常。
注意:在再次执行LaunchStartupThread方法时,如果有新的请求进入,也会将请求的异步BeginRequest处理暂停在那里,直到初始化完成。请查看
Starter<T>的OnBeginRequest方法的代码:

    public void OnBeginRequest(HttpApplication application)
    {
        // Initialization resulted in an error
        if (_error != null )
        {
            // Save error for next requests and restart async initialization.
            // Note: The reason we have to retry the initialization is that the
            //       application environment may change between requests,
            //       e.g. App_Data is made read-write for the AppPool.
            bool restartInitialization = false ;


            lock (_synLock)
            {
                if (_error != null )
                {
                    _previousError = _error;
                    _error = null;
                    restartInitialization = true;
                }
            }


            if (restartInitialization)
            {
                LaunchStartupThread(application);
            }
        }


        // Previous initialization resulted in an error (and another initialization is running)
        if (_previousError != null )
        {
            throw new ApplicationException( "Error during application initialization" , _previousError);
        }


        // Only notify if the initialization has successfully completed
        if (_initializationResult != null )
        {
            _beginRequest(application, _initializationResult);
        }
    }

可以放心,如果上次初始化出现异常,不会导致多个同步BeginRequest事件处理程序尝试都去执行LaunchStartupThread方法,Orchard加了个lock以保证线程安全。
下面看看Orchard是不是解决了上述提到的两个问题。
首先,修改LaunchStartupThread方法,使初始化线程总是抛出异常:

    public void LaunchStartupThread(HttpApplication application)
    {
        // ...
                try
                {
                    throw new Exception( DateTime.Now.ToString());
                    var result = _initialization(application);
                    _initializationResult = result;
                }
        // ...
    }
启动站点,隔几秒刷新一次页面,根据输出的时间可以看到总是抛出上一次初始化的异常。
最后,我们来模拟一次在初始化时大量请求涌入的情况。修改LaunchStartupThread方法,让初始化看起来更耗时:
     public void LaunchStartupThread(HttpApplication application)
    {
        // ...
                try
                {
                    Thread.Sleep(1000 * 60 * 2);
                    var result = _initialization(application);
                    _initializationResult = result;
                }
        // ...
    }

启动Orchard,接着启动控制台测试程序(请求URL要修改成Orchard站点的),查看任务管理器,可以看到WebDev.WebServer40.EXE的线程始终保持在比较低的范围:

初始化完毕后,WebDev.WebServer40.EXE的线程数有所下降,但是CPU却消耗很多,这是因为它现在正在处理10000个等待的请求,所以是正常的:


别忘记了最初我们分析的WarmupUtility类,为了在初始化的同时能够响应用户请求,我们在"~/App_Data/Warmup/"对应目录下 手工新建一个名为"http_3A_2F_2Flocalhost_3A30320_2Forchardlocal"的文件,当然具体文件名要根据实际情 况来定。再次初始化网站并运行控制台测试程序:

可以看到,浏览器(发送第一个请求)、控制台程序(模拟初始化过程中的若干请求)能得到及时响应,而Web服务器的的性能保持在一个比较稳定的水平。
这里我们只是手工制作了个首页的WarmUp文件,但是在初始化过程中用户可能访问任何一个可以访问的页面。Orchard提供了一个Orchare.WarmUp模块,可以用来生成对应的静态文件。
另外,虽然我们上面只考虑了初始化的情况,实际上Orchare.WarmUp模块对于运行时提高服务器吞吐能力也是大有好处的。
相关类型:
Orchard.WarmupStarter.WarmupUtility
Orchard.WarmupStarter.WarmupHttpModule: IHttpModule
Orchard.WarmupStarter.Starter<T>
Orchard.Environment.OrchardStarter
Orchard.Environment.DefaultOrchardHost : IOrchartHost
Orchard.Web.MvcApplication
参考资料:
通过 ASP.NET 异步编程实现可扩展的应用程序 
HTTP 处理程序和 HTTP 模块概述
演练:创建和注册自定义 HTTP 模块



作者原创内容不容易,如果觉得内容不错,请点击右侧“打赏”,赏俩给作者花花,也算是对作者付出的肯定,也可以鼓励作者原创更多更好内容。
更多详情欢迎到QQ群 166852192 交流。