解读ASP.NET 5 & MVC6系列教程(15):MvcOptions配置
程序模型处理IApplicationModelConvention
在MvcOptions的实例对象上,有一个ApplicationModelConventions属性(类型是:List<IApplicationModelConvention>),该属性IApplicationModelConvention类型的接口集合,用于处理应用模型ApplicationModel,该集合是在MVC程序启动的时候进行调用,所以在调用之前,我们可以对其进行修改或更新,比如,我们可以针对所有的Controller和Action在数据库中进行授权定义,在程序启动的时候读取数据授权信息,然后对应用模型ApplicationModel进行处理。示例如下:
publicclassPermissionCheckApplicationModelConvention:IApplicationModelConvention { publicvoidApply(ApplicationModelapplication) { foreach(varcontrollerModelinapplication.Controllers) { varcontrollerType=controllerModel.ControllerType; varcontrollerName=controllerModel.ControllerName; controllerModel.Actions.ToList().ForEach(actionModel=> { varactionName=actionModel.ActionName; varparameters=actionModel.Parameters; //根据判断条件,操作修改actionModel }); //根据判断条件,操作修改ControllerModel } } }
视图引擎的管理ViewEngines
在MvcOptions的实例对象中,有一个ViewEngines属性用于保存系统的视图引擎集合,以便可以让我们实现自己的自定义视图引擎,比如在《自定义View视图文件查找逻辑》章节中,我们就利用了该特性,来实现了自己的自定义视图引擎,示例如下:
services.AddMvc().Configure<MvcOptions>(options=> { options.ViewEngines.Clear(); options.ViewEngines.Add(typeof(ThemeViewEngine)); });
WebAPI中的输入(InputFormater)/输出(OutputFormater)
输入
WebAPI和目前的MVC的输入参数的处理,目前支持JSON和XML格式,具体的处理类分别如下:
JsonInputFormatter XmlDataContractSerializerInputFormatter
输出
在WebAPI中,默认的输出格式化器有如下四种:
HttpNoContentOutputFormatter StringOutputFormatter JsonOutputFormatter XmlDataContractSerializerOutputFormatter
上述四种在系统中,是根据不同的情形自动进行判断输出的,具体判断规则如下:
如果是如下类似的Action,则使用HttpNoContentOutputFormatter返回204,即NoContent。
publicTaskDoSomethingAsync() { //返回Task } publicvoidDoSomething() { //Void方法 } publicstringGetString() { returnnull;//返回null } publicList<Data>GetData() { returnnull;//返回null }
如果是如下方法,同样是返回字符串,只有返回类型是string的Action,才使用StringOutputFormatter返回字符串;返回类型是object的Action,则使用JsonOutputFormatter返回JSON类型的字符串数据。
publicobjectGetData() { return"TheData";//返回JSON } publicstringGetString() { return"TheData";//返回字符串 }
如果上述两种类型的Action都不是,则默认使用JsonOutputFormatter返回JSON数据,如果JsonOutputFormatter格式化器通过如下语句被删除了,那就会使用XmlDataContractSerializerOutputFormatter返回XML数据。
services.Configure<MvcOptions>(options=> options.OutputFormatters.RemoveAll(formatter=>formatter.InstanceisJsonOutputFormatter) );
当然,你也可以使用ProducesAttribute显示声明使用JsonOutputFormatter格式化器,示例如下。
publicclassProduct2Controller:Controller { [Produces("application/json")] //[Produces("application/xml")] publicProductDetail(intid) { returnnewProduct(){ProductId=id,ProductName="商品名称"}; } }
或者,可以在基类Controller上,也可以使用ProducesAttribute,示例如下:
[Produces("application/json")] publicclassJsonController:Controller{} publicclassHomeController:JsonController { publicList<Data>GetMeData() { returnGetDataFromSource(); } }
当然,也可以在全局范围内声明该ProducesAttribute,示例如下:
services.Configure<MvcOptions>(options=> options.Filters.Add(newProducesAttribute("application/json")) );
OutputCache与Profile
在MVC6中,OutputCache的特性由ResponseCacheAttribute类来支持,示例如下:
[ResponseCache(Duration=100)] publicIActionResultIndex() { returnContent(DateTime.Now.ToString()); }
上述示例表示,将该页面的内容在客户端缓存100秒,换句话说,就是在Response响应头header里添加一个Cache-Control头,并设置max-age=100。该特性支持的属性列表如下:
另外,ResponseCacheAttribute还支持一个CacheProfileName属性,以便可以读取全局设置的profile信息配置,进行缓存,示例如下:
[ResponseCache(CacheProfileName="MyProfile")] publicIActionResultIndex() { returnContent(DateTime.Now.ToString()); } publicvoidConfigureServices(IServiceCollectionservices) { services.Configure<MvcOptions>(options=> { options.CacheProfiles.Add("MyProfile", newCacheProfile { Duration=100 }); }); }
通过向MvcOptions的CacheProfiles属性值添加一个名为MyProfile的个性设置,可以在所有的Action上都使用该配置信息。
其它我们已经很熟悉的内容
以下内容我们可能都已经非常熟悉了,因为在之前的MVC版本中都已经使用过了,这些内容均作为MvcOptions的属性而存在,具体功能列表如下(就不一一叙述了):
FiltersModelBindersModelValidatorProvidersValidationExcludeFiltersValueProviderFactories
另外两个:
MaxModelValidationErrors
置模型验证是显示的最大错误数量。
RespectBrowserAcceptHeader
在使用WebAPI的内容协定功能时,是否遵守AcceptHeader的定义,默认情况下当mediatype默认是*/*的时候是忽略Acceptheader的。如果设置为true,则不忽略。