解读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
还支持一个CacheProfileNam
e属性,以便可以读取全局设置的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的属性而存在,具体功能列表如下(就不一一叙述了):
FiltersModelBindersModelValidatorProvidersValidationExcludeFiltersValueProviderFactories
另外两个:
MaxModelValidationErrors
置模型验证是显示的最大错误数量。
RespectBrowserAcceptHeader
在使用Web API的内容协定功能时,是否遵守Accept Header的定义,默认情况下当media type默认是*/*
的时候是忽略Accept header的。如果设置为true,则不忽略。
相关文章
解读ASP.NET 5 & MVC6系列教程(11):Routing路由
这篇文章主要介绍了ASP.NET 5 Routing路由的用法,虽然ASP.NET 5 和MVC6的路由使用方式很简单,但是相关的使用规则却很复杂,大家使用的时候需要多加注意。...2021-09-22解读ASP.NET 5 & MVC6系列教程(10):Controller与Action
这篇文章主要介绍了ASP.NET 5 Controller与Action的定义和使用,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(9):日志框架
这篇文章主要介绍了ASP.NET 5 日志框架,通过基于接口的编程机制和DI依赖注入机制,我们可以很容易实现第三方日志provider的扩展,从而将日志记录到我们想记录的任意地方,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(16):自定义View视图文件查找逻辑
这篇文章主要介绍了ASP.NET 5 MVC6中自定义View视图文件查找逻辑,需要的朋友可以参考下...2021-09-22- 这篇文章主要介绍了ASP.NET 5升级后如何删除旧版本的DNX,其实就是简单的四步走,就能轻松删除旧版本的DNX,感兴趣的小伙伴们可以参考一下...2021-09-22
解读ASP.NET 5 & MVC6系列教程(12):基于Lamda表达式的强类型Routing实现
这篇文章主要介绍了基于ASP.NET 5 Lamda表达式的强类型Routing实现,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(5):Configuration配置信息管理
这篇文章主要介绍了ASP.NET 5中Configuration配置信息管理,需要的朋友可以参考下。...2021-09-22解读ASP.NET 5 & MVC6系列教程(8):Session与Caching
这篇文章主要介绍了ASP.NET 5 中的Session与Caching配置和使用,需要的朋友可以参考下...2021-09-22Mac中体验ASP.NET 5 beta2的K gen代码生成
这篇文章主要介绍了Mac中体验ASP.NET 5 beta2的K gen代码生成,需要的朋友可以参考一下。...2021-09-22解读ASP.NET 5 & MVC6系列教程(15):MvcOptions配置
这篇文章主要介绍了ASP.NET 5 MVC6中MvcOptions配置方法,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(14):View Component
这篇文章主要介绍了ASP.NET 5 MVC6 中View Component创建和视图的使用,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(17):MVC中的其他新特性
这篇文章主要介绍了ASP.NET 5中全局导入、获取IP相关信息、文件上传等其他新特性,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(7):依赖注入
这篇文章主要介绍了ASP.NET 5 依赖注入,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(13):TagHelper
这篇文章主要介绍了新版MVC6中强大的TagHelper功能,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(4):核心技术与环境配置
这篇文章主要介绍了ASP.NET 5 核心技术与环境配置,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(3):项目发布与部署
这篇文章主要介绍了ASP.NET 5 项目发布与部署的设置和流程,并介绍IIS和web.cmd模式两种发布模式的区别,需要的朋友可以参考一下。...2021-09-22解读ASP.NET 5 & MVC6系列教程(6):Middleware详解
这篇文章主要介绍了Middleware详解,需要的朋友可以参考下...2021-09-22解读ASP.NET 5 & MVC6系列教程(1):ASP.NET 5简介
这篇文章主要介绍ASP.NET 5简介以及对各个版本号进行解释,ASP.NET 5中新的变化,需要的朋友可以参考下。...2021-09-22解读ASP.NET 5 & MVC6系列教程(2):初识项目
这篇文章主要介绍ASP.NET 5中新建项目的结构和之前的差异,介绍的比较细致,需要的朋友可以参考下。...2021-09-22