解讀ASP.NET 5 & MVC6系列（15）：MvcOptions配置

2015-06-18 17:04:22

在MvcOptions的實(shí)例對(duì)象上，有一個(gè)ApplicationModelConventions屬性(類型是：List)，該屬性IApplicationModelConvention類型的接口集合，用于處理應(yīng)用模型ApplicationModel

程序模型處理 IApplicationModelConvention

在MvcOptions的實(shí)例對(duì)象上，有一個(gè)ApplicationModelConventions屬性(類型是：List)，該屬性IApplicationModelConvention類型的接口集合，用于處理應(yīng)用模型ApplicationModel，該集合是在MVC程序啟動(dòng)的時(shí)候進(jìn)行調(diào)用，所以在調(diào)用之前，我們可以對(duì)其進(jìn)行修改或更新，比如，我們可以針對(duì)所有的Controller和Action在數(shù)據(jù)庫中進(jìn)行授權(quán)定義，在程序啟動(dòng)的時(shí)候讀取數(shù)據(jù)授權(quán)信息，然后對(duì)應(yīng)用模型ApplicationModel進(jìn)行處理。示例如下：

public class PermissionCheckApplicationModelConvention : IApplicationModelConvention 
{ 
    public void Apply(ApplicationModel application) 
    { 
        foreach (var controllerModel in application.Controllers) 
        { 
            var controllerType = controllerModel.ControllerType; 
            var controllerName = controllerModel.ControllerName; 
 
            controllerModel.Actions.ToList().ForEach(actionModel => 
            { 
                var actionName = actionModel.ActionName; 
                var parameters = actionModel.Parameters; 
 
                // 根據(jù)判斷條件，操作修改actionModel 
            }); 
 
            // 根據(jù)判斷條件，操作修改ControllerModel 
        } 
    } 
}

視圖引擎的管理ViewEngines

在MvcOptions的實(shí)例對(duì)象中，有一個(gè)ViewEngines屬性用于保存系統(tǒng)的視圖引擎集合，以便可以讓我們實(shí)現(xiàn)自己的自定義視圖引擎，比如在《自定義View視圖文件查找邏輯》章節(jié)中，我們就利用了該特性，來實(shí)現(xiàn)了自己的自定義視圖引擎，示例如下：

services.AddMvc().Configure(options => {     options.ViewEngines.Clear();     options.ViewEngines.Add(typeof(ThemeViewEngine)); });

Web API中的輸入(InputFormater)/輸出(OutputFormater)

輸入

Web API和目前的MVC的輸入?yún)?shù)的處理，目前支持JSON和XML格式，具體的處理類分別如下：

JsonInputFormatter 
XmlDataContractSerializerInputFormatter

輸出

在Web API中，默認(rèn)的輸出格式化器有如下四種：

HttpNoContentOutputFormatter 
StringOutputFormatter 
JsonOutputFormatter 
XmlDataContractSerializerOutputFormatter

上述四種在系統(tǒng)中，是根據(jù)不同的情形自動(dòng)進(jìn)行判斷輸出的，具體判斷規(guī)則如下：

如果是如下類似的Action，則使用HttpNoContentOutputFormatter返回204，即NoContent。

public Task DoSomethingAsync() 
{ 
    // 返回Task 
} 
 
public void DoSomething() 
{ 
    // Void方法 
} 
 
public string GetString() 
{ 
    return null; // 返回null 
} 
 
public List GetData() {     return null; // 返回null }

如果是如下方法，同樣是返回字符串，只有返回類型是string的Action，才使用StringOutputFormatter返回字符串;返回類型是object的Action，則使用JsonOutputFormatter返回JSON類型的字符串?dāng)?shù)據(jù)

public object GetData() 
{ 
    return"The Data";  // 返回JSON 
} 
 
public string GetString() 
{ 
    return"The Data";  // 返回字符串 
}

如果上述兩種類型的Action都不是，則默認(rèn)使用JsonOutputFormatter返回JSON數(shù)據(jù)，如果JsonOutputFormatter格式化器通過如下語句被刪除了，那就會(huì)使用XmlDataContractSerializerOutputFormatter返回XML數(shù)據(jù)。

services.Configure(options =>     options.OutputFormatters.RemoveAll(formatter => formatter.Instance is JsonOutputFormatter) )

當(dāng)然，你也可以使用ProducesAttribute顯示聲明使用JsonOutputFormatter格式化器，示例如下。

public class Product2Controller : Controller 
{ 
    [Produces("application/json")] 
    //[Produces("application/xml")] 
    public Product Detail(int id) 
    { 
        return new Product() { ProductId = id, ProductName = "商品名稱" }; 
    } 
}

或者，可以在基類Controller上，也可以使用ProducesAttribute，示例如下：

[Produces("application/json")] 
    public class JsonController : Controller { } 
 
    public class HomeController : JsonController 
    { 
        public List GetMeData()         {             return GetDataFromSource();         }     }

當(dāng)然，也可以在全局范圍內(nèi)聲明該P(yáng)roducesAttribute，示例如下：

services.Configure(options =>         options.Filters.Add(newProducesAttribute("application/json"))     );

Output Cache 與 Profile

在MVC6中，OutputCache的特性由ResponseCacheAttribute類來支持，示例如下：

[ResponseCache(Duration = 100)] 
public IActionResult Index() 
{ 
    return Content(DateTime.Now.ToString()); 
}

上述示例表示，將該頁面的內(nèi)容在客戶端緩存100秒，換句話說，就是在Response響應(yīng)頭header里添加一個(gè)Cache-Control頭，并設(shè)置max-age=100。該特性支持的屬性列表如下：

另外，ResponseCacheAttribute還支持一個(gè)CacheProfileName屬性，以便可以讀取全局設(shè)置的profile信息配置，進(jìn)行緩存，示例如下：

[ResponseCache(CacheProfileName = "MyProfile")] 
public IActionResult Index() 
{ 
    return Content(DateTime.Now.ToString()); 
} 
 
public void ConfigureServices(IServiceCollection services) 
{ 
    services.Configure(options =>     {         options.CacheProfiles.Add("MyProfile",             new CacheProfile             {                 Duration = 100             });     }); }