ASP.NET MVC 4 檢視頁去哪裡兒

武沛齊發表於2014-03-13

這裡特別感謝 swagon 提到了Displaymodeprovider,所以才有了本篇部落格,也使我對【View的呈現】中尋找檢視頁的過程有了清晰的認識!

前戲

在MVC中,執行完Action之後,會返回一個ActionResult物件,之後再執行該物件的ExecuteResult方法,這也就是【View的呈現】的入口!

【View的呈現】包括了:根據模版去尋找請求的檢視頁、編譯檢視頁、再執行檢視頁的內容。本篇就來介紹尋找檢視頁的詳細過程,其中涉及到了MVC 4的一個新特性--“手機檢視頁”

public abstract class ViewResultBase : ActionResult
{
    public override void ExecuteResult(ControllerContext context)
    {
        if (context == null)
        {
            throw new ArgumentNullException("context");
        }
        if (String.IsNullOrEmpty(ViewName))
        {
            ViewName = context.RouteData.GetRequiredString("action");
        }
      ViewEngineResult result = null;
        if (View == null)
        {
            //通過檢視引擎去建立檢視物件,並將檢視物件和該檢視相關的資訊封裝在ViewEngineResult物件中。
            result = FindView(context);
            View = result.View;
        }

        TextWriter writer = context.HttpContext.Response.Output;
        ViewContext viewContext = new ViewContext(context, View, ViewData, TempData, writer);
        View.Render(viewContext, writer);

        if (result != null)
        {
            result.ViewEngine.ReleaseView(context, View);
        }
    }
}

public class ViewResult : ViewResultBase
{
    protected override ViewEngineResult FindView(ControllerContext context)
    {
		//尋找當前請求的檢視頁,如果能找到則建立檢視物件。
        //遍歷每個檢視引擎(預設有兩個WebFormEngine、RazorViewEngine),並執行每一個檢視引擎的FindView方法。
        ViewEngineResult result = ViewEngineCollection.FindView(context, ViewName, MasterName);
        //如果建立了檢視物件,即:指定路徑中存在相匹配的檢視頁(.cshtml檔案)。
        if (result.View != null)
        {
            return result;
        }
        //沒有建立檢視物件,即:指定路徑中不存在相匹配的檢視頁(.cshtml檔案)。
        StringBuilder locationsText = new StringBuilder();
        foreach (string location in result.SearchedLocations)
        {
            locationsText.AppendLine();
            locationsText.Append(location);
        }
        throw new InvalidOperationException(String.Format(CultureInfo.CurrentCulture,
                                                          MvcResources.Common_ViewNotFound, ViewName, locationsText));
    }
}

  ViewEngineResult result = ViewEngineCollection.FindView(context, ViewName, MasterName);則是遍歷每個檢視引擎(預設有兩個WebFormEngine、RazorViewEngine),並執行每一個檢視引擎的FindView方法。
注:在執行檢視引擎的FindView方法時,先按照從快取表中找是否存在請求的檢視頁,如果沒有的話,再進行一次尋找!

 下面以RazorViewEngine為例:

public abstract class VirtualPathProviderViewEngine : IViewEngine
{
	//useCache先是true,該方法返回的是null。則讓useCache=false,再執行一遍。即:先通過快取去找,如果沒有找到的話,就正經的去找。
	public virtual ViewEngineResult FindView(ControllerContext controllerContext, string viewName, string masterName, bool useCache)
	{
		if (controllerContext == null)
		{
			throw new ArgumentNullException("controllerContext");
		}
		if (String.IsNullOrEmpty(viewName))
		{
			throw new ArgumentException(MvcResources.Common_NullOrEmpty, "viewName");
		}

		string[] viewLocationsSearched;
		string[] masterLocationsSearched;

		string controllerName = controllerContext.RouteData.GetRequiredString("controller");
		//獲取檢視的路徑,這裡就是我們們本篇博文的內容的入口點!!!!!!!!!!!!!!!!!!!
		//ViewLocationFormats、AreaViewLocationFormats定義在派生類RazorViewEngine類中。
		//ViewLocationFormats:"~/Views/{1}/{0}.cshtml","~/Views/{1}/{0}.vbhtml", "~/Views/Shared/{0}.cshtml","~/Views/Shared/{0}.vbhtml"
		//AreaViewLocationFormats:"~/Areas/{2}/Views/{1}/{0}.cshtml", "~/Areas/{2}/Views/{1}/{0}.vbhtml", "~/Areas/{2}/Views/Shared/{0}.cshtml","~/Areas/{2}/Views/Shared/{0}.vbhtml"
		string viewPath = GetPath(controllerContext, ViewLocationFormats, AreaViewLocationFormats, "ViewLocationFormats", viewName, controllerName, CacheKeyPrefixView, useCache, out viewLocationsSearched);
		
		
		string masterPath = GetPath(controllerContext, MasterLocationFormats, AreaMasterLocationFormats, "MasterLocationFormats", masterName, controllerName, CacheKeyPrefixMaster, useCache, out masterLocationsSearched);

		if (String.IsNullOrEmpty(viewPath) || (String.IsNullOrEmpty(masterPath) && !String.IsNullOrEmpty(masterName)))
		{
			return new ViewEngineResult(viewLocationsSearched.Union(masterLocationsSearched));
		}

		return new ViewEngineResult(CreateView(controllerContext, viewPath, masterPath), this);
	}
}

啪啪啪

  GetPath方法在尋找【檢視頁】時,首先將當前請求的Controller和Action的名稱新增到地址格式化器中,這樣就有了要尋找的地址(們),之後就來檢查格式化後的地址是否真的存在指定的【檢視頁】。如果是通過手機端來請求,則會對格式化之後的地址進行再進行處理(如:Index.cshtml修改為Index.Mobile.cshtml),之後再檢查新地址下是否存在【檢視頁】。

注:預設情況下會先檢查是否為手機端訪問!

口說無憑,上原始碼吧:

// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
using System.Web.Hosting;
using System.Web.Mvc.Properties;
using System.Web.WebPages;

namespace System.Web.Mvc
{
    public abstract class VirtualPathProviderViewEngine : IViewEngine
    {
        // format is ":ViewCacheEntry:{cacheType}:{prefix}:{name}:{controllerName}:{areaName}:"
        private const string CacheKeyFormat = ":ViewCacheEntry:{0}:{1}:{2}:{3}:{4}:";
        private const string CacheKeyPrefixMaster = "Master";
        private const string CacheKeyPrefixPartial = "Partial";
        private const string CacheKeyPrefixView = "View";
        private static readonly string[] _emptyLocations = new string[0];
        private DisplayModeProvider _displayModeProvider;

        private Func<VirtualPathProvider> _vppFunc = () => HostingEnvironment.VirtualPathProvider;
        internal Func<string, string> GetExtensionThunk = VirtualPathUtility.GetExtension;
        private IViewLocationCache _viewLocationCache;

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] AreaMasterLocationFormats { get; set; }

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] AreaPartialViewLocationFormats { get; set; }

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] AreaViewLocationFormats { get; set; }

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] FileExtensions { get; set; }

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] MasterLocationFormats { get; set; }

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] PartialViewLocationFormats { get; set; }

        // Neither DefaultViewLocationCache.Null nor a DefaultViewLocationCache instance maintain internal state. Fine
        // if multiple threads race to initialize _viewLocationCache.
        public IViewLocationCache ViewLocationCache
        {
            get
            {
                if (_viewLocationCache == null)
                {
                    if (HttpContext.Current == null || HttpContext.Current.IsDebuggingEnabled)
                    {
                        _viewLocationCache = DefaultViewLocationCache.Null;
                    }
                    else
                    {
                        _viewLocationCache = new DefaultViewLocationCache();
                    }
                }

                return _viewLocationCache;
            }
            set
            {
                if (value == null)
                {
                    throw Error.ArgumentNull("value");
                }

                _viewLocationCache = value;
            }
        }

        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This is a shipped API")]
        public string[] ViewLocationFormats { get; set; }

        // Likely exists for testing only
        protected VirtualPathProvider VirtualPathProvider
        {
            get { return _vppFunc(); }
            set
            {
                if (value == null)
                {
                    throw Error.ArgumentNull("value");
                }

                _vppFunc = () => value;
            }
        }

        // Provided for testing only; setter used in BuildManagerViewEngine but only for test scenarios
        internal Func<VirtualPathProvider> VirtualPathProviderFunc
        {
            get { return _vppFunc; }
            set
            {
                if (value == null)
                {
                    throw Error.ArgumentNull("value");
                }

                _vppFunc = value;
            }
        }

        protected internal DisplayModeProvider DisplayModeProvider
        {
            get { return _displayModeProvider ?? DisplayModeProvider.Instance; }
            set { _displayModeProvider = value; }
        }

        internal virtual string CreateCacheKey(string prefix, string name, string controllerName, string areaName)
        {
            return String.Format(CultureInfo.InvariantCulture, CacheKeyFormat,
                                 GetType().AssemblyQualifiedName, prefix, name, controllerName, areaName);
        }

        internal static string AppendDisplayModeToCacheKey(string cacheKey, string displayMode)
        {
            // key format is ":ViewCacheEntry:{cacheType}:{prefix}:{name}:{controllerName}:{areaName}:"
            // so append "{displayMode}:" to the key
            return cacheKey + displayMode + ":";
        }

        protected abstract IView CreatePartialView(ControllerContext controllerContext, string partialPath);

        protected abstract IView CreateView(ControllerContext controllerContext, string viewPath, string masterPath);

        protected virtual bool FileExists(ControllerContext controllerContext, string virtualPath)
        {
            return VirtualPathProvider.FileExists(virtualPath);
        }

        public virtual ViewEngineResult FindPartialView(ControllerContext controllerContext, string partialViewName, bool useCache)
        {
            if (controllerContext == null)
            {
                throw new ArgumentNullException("controllerContext");
            }
            if (String.IsNullOrEmpty(partialViewName))
            {
                throw new ArgumentException(MvcResources.Common_NullOrEmpty, "partialViewName");
            }

            string[] searched;
            string controllerName = controllerContext.RouteData.GetRequiredString("controller");
            string partialPath = GetPath(controllerContext, PartialViewLocationFormats, AreaPartialViewLocationFormats, "PartialViewLocationFormats", partialViewName, controllerName, CacheKeyPrefixPartial, useCache, out searched);

            if (String.IsNullOrEmpty(partialPath))
            {
                return new ViewEngineResult(searched);
            }

            return new ViewEngineResult(CreatePartialView(controllerContext, partialPath), this);
        }

        //開始開始開始開始開始開始開始開始開始開始開始開始開始開始開始開始開始開始開始開始
        //useCache先是true,該方法返回的是null。則讓useCache=false,再執行一遍。即:先通過快取去找,如果沒有找到的話,就正經的去找。
        public virtual ViewEngineResult FindView(ControllerContext controllerContext, string viewName, string masterName, bool useCache)
        {
            if (controllerContext == null)
            {
                throw new ArgumentNullException("controllerContext");
            }
            if (String.IsNullOrEmpty(viewName))
            {
                throw new ArgumentException(MvcResources.Common_NullOrEmpty, "viewName");
            }

            string[] viewLocationsSearched;
            string[] masterLocationsSearched;

            string controllerName = controllerContext.RouteData.GetRequiredString("controller");
            //獲取檢視的路徑
            //ViewLocationFormats、AreaViewLocationFormats定義在派生類RazorViewEngine類中。
            //ViewLocationFormats:"~/Views/{1}/{0}.cshtml","~/Views/{1}/{0}.vbhtml", "~/Views/Shared/{0}.cshtml","~/Views/Shared/{0}.vbhtml"
            //AreaViewLocationFormats:"~/Areas/{2}/Views/{1}/{0}.cshtml", "~/Areas/{2}/Views/{1}/{0}.vbhtml", "~/Areas/{2}/Views/Shared/{0}.cshtml","~/Areas/{2}/Views/Shared/{0}.vbhtml"
            string viewPath = GetPath(controllerContext, ViewLocationFormats, AreaViewLocationFormats, "ViewLocationFormats", viewName, controllerName, CacheKeyPrefixView, useCache, out viewLocationsSearched);
            
            
            string masterPath = GetPath(controllerContext, MasterLocationFormats, AreaMasterLocationFormats, "MasterLocationFormats", masterName, controllerName, CacheKeyPrefixMaster, useCache, out masterLocationsSearched);

            if (String.IsNullOrEmpty(viewPath) || (String.IsNullOrEmpty(masterPath) && !String.IsNullOrEmpty(masterName)))
            {
                return new ViewEngineResult(viewLocationsSearched.Union(masterLocationsSearched));
            }

            return new ViewEngineResult(CreateView(controllerContext, viewPath, masterPath), this);
        }
        //獲取檢視路徑方法
        private string GetPath(ControllerContext controllerContext, string[] locations, string[] areaLocations, string locationsPropertyName, string name, string controllerName, string cacheKeyPrefix, bool useCache, out string[] searchedLocations)
        {
            searchedLocations = _emptyLocations;

            if (String.IsNullOrEmpty(name))
            {
                return String.Empty;
            }
            //從RouteData的DataTokens中獲取key為‘area’的值
            string areaName = AreaHelpers.GetAreaName(controllerContext.RouteData);
            bool usingAreas = !String.IsNullOrEmpty(areaName);
            //
            List<ViewLocation> viewLocations = GetViewLocations(locations, (usingAreas) ? areaLocations : null);

            if (viewLocations.Count == 0)
            {
                throw new InvalidOperationException(String.Format(CultureInfo.CurrentCulture,
                                                                  MvcResources.Common_PropertyCannotBeNullOrEmpty, locationsPropertyName));
            }
            bool nameRepresentsPath = IsSpecificPath(name);
            string cacheKey = CreateCacheKey(cacheKeyPrefix, name, (nameRepresentsPath) ? String.Empty : controllerName, areaName);
            //是否使用快取,其實就將一個已知的路徑儲存在快取表中,如果是第一次請求,快取表中什麼也麼有啊,所以暫且不看它。
            if (useCache)
            {
                //根據請求上下文獲取可用的DisplayModelProvider
                IEnumerable<IDisplayMode> possibleDisplayModes = DisplayModeProvider.GetAvailableDisplayModesForContext(controllerContext.HttpContext, controllerContext.DisplayMode);
                foreach (IDisplayMode displayMode in possibleDisplayModes)
                {
                    //displayMode.DisplayModeId就是“Mobile”,即:執行DefaultDisplayMode有引數的建構函式
                    string cachedLocation = ViewLocationCache.GetViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, displayMode.DisplayModeId));

                    if (cachedLocation == null)
                    {
                        // If any matching display mode location is not in the cache, fall back to the uncached behavior, which will repopulate all of our caches.
                        return null;
                    }
                    // A non-empty cachedLocation indicates that we have a matching file on disk. Return that result.
                    if (cachedLocation.Length > 0)
                    {
                        if (controllerContext.DisplayMode == null)
                        {
                            controllerContext.DisplayMode = displayMode;
                        }

                        return cachedLocation;
                    }
                    // An empty cachedLocation value indicates that we don't have a matching file on disk. Keep going down the list of possible display modes.
                }
                // GetPath is called again without using the cache.
                return null;
            }
            else
            {
                //如果ViewResult的引數的第一個字元是:~ 或 /,則執行第一個方法,否則執行第二個方法!
                //第一個方法:直接指定了路徑去尋找
                //第二個方法:只通過試圖名稱再拼接路徑去尋找(用到了DisplayModeProvider)
                //第二個方法的viewLocations引數是含有8條資料的集合。
                return nameRepresentsPath
                    ? GetPathFromSpecificName(controllerContext, name, cacheKey, ref searchedLocations)
                    : GetPathFromGeneralName(controllerContext, viewLocations, name, controllerName, areaName, cacheKey, ref searchedLocations);
            }
        }

        private string GetPathFromGeneralName(ControllerContext controllerContext, List<ViewLocation> locations, string name, string controllerName, string areaName, string cacheKey, ref string[] searchedLocations)
        {
            string result = String.Empty;
            searchedLocations = new string[locations.Count];

            for (int i = 0; i < locations.Count; i++)
            {
                ViewLocation location = locations[i];
                //根據8種格式器建立路徑
                string virtualPath = location.Format(name, controllerName, areaName);
                //這裡的controllerContext.DisplayMode屬性執行DisplayModeProvider的GetDisplayMode、SetDisplayMode方法!
                DisplayInfo virtualPathDisplayInfo = DisplayModeProvider.GetDisplayInfoForVirtualPath(virtualPath, controllerContext.HttpContext, path => FileExists(controllerContext, path), controllerContext.DisplayMode);

                if (virtualPathDisplayInfo != null)
                {
                    string resolvedVirtualPath = virtualPathDisplayInfo.FilePath;

                    searchedLocations = _emptyLocations;
                    result = resolvedVirtualPath;
                    ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, virtualPathDisplayInfo.DisplayMode.DisplayModeId), result);

                    if (controllerContext.DisplayMode == null)
                    {
                        controllerContext.DisplayMode = virtualPathDisplayInfo.DisplayMode;
                    }

                    // Populate the cache for all other display modes. We want to cache both file system hits and misses so that we can distinguish
                    // in future requests whether a file's status was evicted from the cache (null value) or if the file doesn't exist (empty string).
                    
                    //再執行迴圈執行除了適合的那個DefaultDisplayMode之外的所有DefaultDisplayMode物件,將所有存在的路徑封裝到DisplayInfo物件中,並新增到快取表中,以便之後請求時直接去快取中獲取。
                    //例如:當前是手機的請求,則會通過執行DisplayModeId=‘Mobile’的那個DefaultDisplayMode來獲取【檢視頁】的路徑(Index.Mobile.cshtml),
                    //        但是在執行完成之後,還會執行DisplayModeId!=‘Mobile’所有其他的DefaultDisplayMode物件,也就是pc端請求時的路徑(Index.cshtml),將其加入快取表中,以便下次請求時直接去快取表中獲取。
                    IEnumerable<IDisplayMode> allDisplayModes = DisplayModeProvider.Modes;
                    foreach (IDisplayMode displayMode in allDisplayModes)
                    {
                        if (displayMode.DisplayModeId != virtualPathDisplayInfo.DisplayMode.DisplayModeId)
                        {
                            DisplayInfo displayInfoToCache = displayMode.GetDisplayInfo(controllerContext.HttpContext, virtualPath, virtualPathExists: path => FileExists(controllerContext, path));

                            string cacheValue = String.Empty;
                            if (displayInfoToCache != null && displayInfoToCache.FilePath != null)
                            {
                                cacheValue = displayInfoToCache.FilePath;
                            }
                            ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, displayMode.DisplayModeId), cacheValue);
                        }
                    }
                    break;
                }

                searchedLocations[i] = virtualPath;
            }

            return result;
        }

        private string GetPathFromSpecificName(ControllerContext controllerContext, string name, string cacheKey, ref string[] searchedLocations)
        {
            string result = name;

            if (!(FilePathIsSupported(name) && FileExists(controllerContext, name)))
            {
                result = String.Empty;
                searchedLocations = new[] { name };
            }

            ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, cacheKey, result);
            return result;
        }

        private bool FilePathIsSupported(string virtualPath)
        {
            if (FileExtensions == null)
            {
                // legacy behavior for custom ViewEngine that might not set the FileExtensions property
                return true;
            }
            else
            {
                // get rid of the '.' because the FileExtensions property expects extensions withouth a dot.
                string extension = GetExtensionThunk(virtualPath).TrimStart('.');
                return FileExtensions.Contains(extension, StringComparer.OrdinalIgnoreCase);
            }
        }

        private static List<ViewLocation> GetViewLocations(string[] viewLocationFormats, string[] areaViewLocationFormats)
        {
            //將四個AreaAwareViewLocation和四個ViewLocation新增到 allLocations集合中!並返回
            //AreaAwareViewLocation繼承自ViewLocation
            List<ViewLocation> allLocations = new List<ViewLocation>();

            if (areaViewLocationFormats != null)
            {
                foreach (string areaViewLocationFormat in areaViewLocationFormats)
                {
                    allLocations.Add(new AreaAwareViewLocation(areaViewLocationFormat));
                }
            }

            if (viewLocationFormats != null)
            {
                foreach (string viewLocationFormat in viewLocationFormats)
                {
                    allLocations.Add(new ViewLocation(viewLocationFormat));
                }
            }

            return allLocations;
        }

        private static bool IsSpecificPath(string name)
        {
            char c = name[0];
            return (c == '~' || c == '/');
        }

        public virtual void ReleaseView(ControllerContext controllerContext, IView view)
        {
            IDisposable disposable = view as IDisposable;
            if (disposable != null)
            {
                disposable.Dispose();
            }
        }

        private class AreaAwareViewLocation : ViewLocation
        {
            public AreaAwareViewLocation(string virtualPathFormatString)
                : base(virtualPathFormatString)
            {
            }

            public override string Format(string viewName, string controllerName, string areaName)
            {
                return String.Format(CultureInfo.InvariantCulture, _virtualPathFormatString, viewName, controllerName, areaName);
            }
        }

        private class ViewLocation
        {
            protected string _virtualPathFormatString;

            public ViewLocation(string virtualPathFormatString)
            {
                _virtualPathFormatString = virtualPathFormatString;
            }

            public virtual string Format(string viewName, string controllerName, string areaName)
            {
                return String.Format(CultureInfo.InvariantCulture, _virtualPathFormatString, viewName, controllerName);
            }
        }
    }
}
VirtualPathProviderViewEngine
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Linq;

namespace System.Web.WebPages
{
    public sealed class DisplayModeProvider
    {
        public static readonly string MobileDisplayModeId = "Mobile";
        public static readonly string DefaultDisplayModeId = String.Empty;
        private static readonly object _displayModeKey = new object();
        private static readonly DisplayModeProvider _instance = new DisplayModeProvider();

        //預設情況下只有兩個DefaultDisplayMode,可以自定義並新增到該集合中!
        private readonly List<IDisplayMode> _displayModes = new List<IDisplayMode>
        {
            new DefaultDisplayMode(MobileDisplayModeId)
            {
                ContextCondition = context => context.GetOverriddenBrowser().IsMobileDevice
            },
            new DefaultDisplayMode()
        };
        
        internal DisplayModeProvider()
        {
            // The type is a psuedo-singleton. A user would gain nothing from constructing it since we won't use anything but DisplayModeProvider.Instance internally.
        }

        /// <summary>
        /// Restricts the search for Display Info to Display Modes either equal to or following the current
        /// Display Mode in Modes. For example, a page being rendered in the Default Display Mode will not
        /// display Mobile partial views in order to achieve a consistent look and feel.
        /// </summary>
        public bool RequireConsistentDisplayMode { get; set; }

        public static DisplayModeProvider Instance
        {
            get { return _instance; }
        }

        /// <summary>
        /// All Display Modes that are available to handle a request.
        /// </summary>
        public IList<IDisplayMode> Modes
        {
            get { return _displayModes; }
        }
        //這個方法的功能:如果指定集合中的某個DefaultDisplayMode來處理請求的話,則直接從它開始。可以在HomeController中通過this.ControllerContext.DisplayMode來設定。
        private int FindFirstAvailableDisplayMode(IDisplayMode currentDisplayMode, bool requireConsistentDisplayMode)
        {
            if (requireConsistentDisplayMode && currentDisplayMode != null)
            {
                //如果集合中麼有和當前currentDisplayMode匹配的話,first值為 -1
                int first = _displayModes.IndexOf(currentDisplayMode);
                return (first >= 0) ? first : _displayModes.Count;
            }
            return 0;
        }

        /// <summary>
        /// Returns any IDisplayMode that can handle the given request.
        /// </summary>
        public IEnumerable<IDisplayMode> GetAvailableDisplayModesForContext(HttpContextBase httpContext, IDisplayMode currentDisplayMode)
        {
            return GetAvailableDisplayModesForContext(httpContext, currentDisplayMode, RequireConsistentDisplayMode);
        }

        internal IEnumerable<IDisplayMode> GetAvailableDisplayModesForContext(HttpContextBase httpContext, IDisplayMode currentDisplayMode, bool requireConsistentDisplayMode)
        {
            int first = FindFirstAvailableDisplayMode(currentDisplayMode, requireConsistentDisplayMode);
            for (int i = first; i < _displayModes.Count; i++)
            {
                IDisplayMode mode = _displayModes[i];
                if (mode.CanHandleContext(httpContext))
                {
                    yield return mode;
                }
            }
        }

        /// <summary>
        /// Returns DisplayInfo from the first IDisplayMode in Modes that can handle the given request and locate the virtual path.
        /// If currentDisplayMode is not null and RequireConsistentDisplayMode is set to true the search for DisplayInfo will only
        /// start with the currentDisplayMode.
        /// </summary>
        public DisplayInfo GetDisplayInfoForVirtualPath(string virtualPath, HttpContextBase httpContext, Func<string, bool> virtualPathExists, IDisplayMode currentDisplayMode)
        {
            //預設RequireConsistentDisplayMode為false
            return GetDisplayInfoForVirtualPath(virtualPath, httpContext, virtualPathExists, currentDisplayMode, RequireConsistentDisplayMode);
        }

        internal DisplayInfo GetDisplayInfoForVirtualPath(string virtualPath, HttpContextBase httpContext, Func<string, bool> virtualPathExists, IDisplayMode currentDisplayMode,
                                                          bool requireConsistentDisplayMode)
        {
            // Performance sensitive
            int first = FindFirstAvailableDisplayMode(currentDisplayMode, requireConsistentDisplayMode);
            for (int i = first; i < _displayModes.Count; i++)
            {
                IDisplayMode mode = _displayModes[i];
                if (mode.CanHandleContext(httpContext))
                {
                    DisplayInfo info = mode.GetDisplayInfo(httpContext, virtualPath, virtualPathExists);
                    if (info != null)
                    {
                        return info;
                    }
                }
            }
            return null;
        }

        internal static IDisplayMode GetDisplayMode(HttpContextBase context)
        {
            return context != null ? context.Items[_displayModeKey] as IDisplayMode : null;
        }

        internal static void SetDisplayMode(HttpContextBase context, IDisplayMode displayMode)
        {
            if (context != null)
            {
                context.Items[_displayModeKey] = displayMode;
            }
        }
    }
}
DisplayModeProvider
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.

using System.IO;

namespace System.Web.WebPages
{
    public class DefaultDisplayMode : IDisplayMode
    {
        //通過建構函式賦值,MVC會建立兩個DefaultDisplayMode物件,將其中一個物件的該欄位值設定為“Mobile”
        private readonly string _suffix;

        public DefaultDisplayMode()
            : this(DisplayModeProvider.DefaultDisplayModeId)
        {
        }

        public DefaultDisplayMode(string suffix)
        {
            _suffix = suffix ?? String.Empty;
        }

        public Func<HttpContextBase, bool> ContextCondition { get; set; }

        public virtual string DisplayModeId
        {
            get { return _suffix; }
        }

        public bool CanHandleContext(HttpContextBase httpContext)
        {
            return ContextCondition == null || ContextCondition(httpContext);
        }

        
        public virtual DisplayInfo GetDisplayInfo(HttpContextBase httpContext, string virtualPath, Func<string, bool> virtualPathExists)
        {
            //呼叫TransformPath方法,將尋找【View檢視頁】路徑設定為 xxx.Mobile.cshtml
            string transformedFilename = TransformPath(virtualPath, _suffix);
            if (transformedFilename != null && virtualPathExists(transformedFilename))
            {
                return new DisplayInfo(transformedFilename, this);
            }
            return null;
        }

        protected virtual string TransformPath(string virtualPath, string suffix)
        {
            if (String.IsNullOrEmpty(suffix))
            {
                return virtualPath;
            }
            string extension = Path.GetExtension(virtualPath);
            return Path.ChangeExtension(virtualPath, suffix + extension);
        }
    }
}
DefaultDisplayMode

由以上原始碼可知,預設情況下,ASP.NET MVC4在DisplayModeProvider中定義了一個含有兩個DefaultDisplayMode物件(用於對地址再處理)的集合:

		public static readonly string MobileDisplayModeId = "Mobile";
        private readonly List<IDisplayMode> _displayModes = new List<IDisplayMode>
        {
            new DefaultDisplayMode(MobileDisplayModeId)
            {
                ContextCondition = context => context.GetOverriddenBrowser().IsMobileDevice
            },
            new DefaultDisplayMode()
        };

由於處理時,是按照遍歷執行_displayModes集合中DefaultDisplayMode物件的GetDisplayInfo方法(索引值從0開始),所以無論是 PC 還是 Phone傳送的請求,都會先執集合中的第一個DefaultDisplayMode物件(判斷是否為手機的請求)。如果Phone端傳送請求,會去尋找xxx.Mobile.cshtml,如果沒有的話,就繼續執行第二個DefaultDisplayMode物件,去尋找xxx.cshtml。如果是PC端傳送請求,也是首先執行第一個DefaultDisplayMode物件,但是由於不滿足 context => context.GetOverriddenBrowser().IsMobileDevice 條件,所以還是需要去執行第二個DefaultDisplayMode物件,去尋找xxx.cshtml。

 擴充套件:
1、指定DisplayMode

模擬需求:對Phone端使用者的某個Action請求,返回電腦版網頁。

        public ActionResult Index()
        {
            //一些判斷條件
            this.ControllerContext.DisplayMode = DisplayModeProvider.Instance.Modes[1];
            DisplayModeProvider.Instance.RequireConsistentDisplayMode = true;
            return View();
        }

  根據上述設定,即使是Phone端的請求並且還存在Index.Mobile.cshtml檔案,也會去執行Index.cshtml,即:實現Phone使用者訪問電腦版網頁。

2、自定義DisplayMode

模擬需求:為Android 2.3使用者設定特定的頁面

先建立一個類似於Index.Android23.cshtml 的頁面,然後在Global.asax中做如下設定即可:

    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();

            WebApiConfig.Register(GlobalConfiguration.Configuration);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
            AuthConfig.RegisterAuth();

            DisplayModeProvider.Instance.Modes.Insert(0, new DefaultDisplayMode("Android23")
            {
                ContextCondition = (context => context.GetOverriddenUserAgent().IndexOf
                ("Android 2.3", StringComparison.OrdinalIgnoreCase) >= 0)
            });
        }
    }

 

以上就是所有內容,如有不適之處,請指正!!!

 

 

 

相關文章