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

程序模型處理 IApplicationModelConvention

在MvcOptions的實例對象上，有一個ApplicationModelConventions屬性（類型是：List<IApplicationModelConvention>），該屬性IApplicationModelConvention類型的接口集合，用於處理應用模型ApplicationModel，該集合是在MVC程序啓動的時候進行調用，因此在調用以前，咱們能夠對其進行修改或更新，好比，咱們能夠針對全部的Controller和Action在數據庫中進行受權定義，在程序啓動的時候讀取數據受權信息，而後對應用模型ApplicationModel進行處理。 示例以下：

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;

                // 根據判斷條件，操做修改actionModel
            });

            // 根據判斷條件，操做修改ControllerModel
        }
    }
}

視圖引擎的管理ViewEngines

在MvcOptions的實例對象中，有一個ViewEngines屬性用於保存系統的視圖引擎集合，以即可以讓咱們實現本身的自定義視圖引擎，好比在《自定義View視圖文件查找邏輯》章節中，咱們就利用了該特性，來實現了本身的自定義視圖引擎，示例以下：

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

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

輸入

Web API和目前的MVC的輸入參數的處理，目前支持JSON和XML格式，具體的處理類分別以下：

JsonInputFormatter
XmlDataContractSerializerInputFormatter

輸出

在Web API中，默認的輸出格式化器有以下四種：

HttpNoContentOutputFormatter
StringOutputFormatter
JsonOutputFormatter
XmlDataContractSerializerOutputFormatter

上述四種在系統中，是根據不一樣的情形自動進行判斷輸出的，具體判斷規則以下：

若是是以下相似的Action，則使用HttpNoContentOutputFormatter返回204，即NoContent。

public Task DoSomethingAsync()
{
    // 返回Task
}

public void DoSomething()
{
    // Void方法
}

public string GetString()
{
    return null; // 返回null
}

public List<Data> GetData()
{
    return null; // 返回null
}

若是是以下方法，一樣是返回字符串，只有返回類型是string的Action，才使用StringOutputFormatter返回字符串；返回類型是object的Action，則使用JsonOutputFormatter返回JSON類型的字符串數據。

public object GetData()
{
    return"The Data";  // 返回JSON
}

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

若是上述兩種類型的Action都不是，則默認使用JsonOutputFormatter返回JSON數據，若是JsonOutputFormatter格式化器經過以下語句被刪除了，那就會使用XmlDataContractSerializerOutputFormatter返回XML數據。

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

固然，你也可使用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<Data> GetMeData()
        {
            return GetDataFromSource();
        }
    }

固然，也能夠在全局範圍內聲明該ProducesAttribute，示例以下：

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

Output Cache 與 Profile

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

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

上述示例表示，將該頁面的內容在客戶端緩存100秒，換句話說，就是在Response響應頭header裏添加一個Cache-Control頭，並設置max-age=100。 該特性支持的屬性列表以下：

屬性名稱	描述
Duration	緩存時間，單位：秒，示例：Cache-Control:max-age=100
NoStore	true則設置Cache-Control:no-store
VaryByHeader	設置Vary header頭
Location	緩存位置，如將Cache-Control設置爲public, private或no-cache。

另外，ResponseCacheAttribute還支持一個CacheProfileName屬性，以即可以讀取全局設置的profile信息配置，進行緩存，示例以下：

[ResponseCache(CacheProfileName = "MyProfile")]
public IActionResult Index()
{
    return Content(DateTime.Now.ToString());
}

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<MvcOptions>(options =>
    {
        options.CacheProfiles.Add("MyProfile",
            new CacheProfile
            {
                Duration = 100
            });
    });
}

經過向MvcOptions的CacheProfiles屬性值添加一個名爲MyProfile的個性設置，能夠在全部的Action上都使用該配置信息。

其它咱們已經很熟悉的內容

如下內容咱們可能都已經很是熟悉了，由於在以前的MVC版本中都已經使用過了，這些內容均做爲MvcOptions的屬性而存在，具體功能列表以下（就不一一敘述了）：

1. Filters
2. ModelBinders
3. ModelValidatorProviders
4. ValidationExcludeFilters
5. ValueProviderFactories

另外兩個：
MaxModelValidationErrors
置模型驗證是顯示的最大錯誤數量。

RespectBrowserAcceptHeader
在使用Web API的內容協定功能時，是否遵照Accept Header的定義，默認狀況下當media type默認是*/*的時候是忽略Accept header的。若是設置爲true，則不忽略。

同步與推薦

本文已同步至目錄索引：解讀ASP.NET 5 & MVC6系列