asp.net core webapi项目配置全局路由
2018-09-20 14:47
1646 查看
0、目录
整体架构目录:ASP.NET Core分布式项目实战-目录一、前言
在开发项目的过程中,我新创建了一个controller,发现vs会给我们直接在controller头添加前缀,比如[Route("api/[controller]")],即在访问接口的时候会变成http://localhost:8000/api/values,但是如果控制器有很多个,或者要进行版本迭代时,我们会发现痛苦的时刻降临了,要一个一个的修改。如果在这个时候可以进行全局配置前缀那真是福利呀,修改一处即可。为了能达到此目的我们就来运用一下吧。
二、配置
0、在配置前我们先来看看接口的前缀吧。立图为证用swagger打开
1、我们需要用到 IApplicationModelConvention 这个接口,它是位于 Microsoft.AspNetCore.Mvc.ApplicationModels 命令空间下面。
MVC框架有一些约定俗成的东西,这个接口主就是用来定义一些MVC约定的东西。我们就可以通过 Apply方法中的 ApplicationModel 来修改或者添加一些约定,而且MV框架本身在启动的时候会把此接口注入,以便于我们使用。
不过我们还是要来看一下这个ApplicationModel 对象里面有什么我们可以用到的地方,我们继续深入:
看到这是不是很爽,我们可以看一下 每个属性的给出的解释
ApiExplorerModel:包括描述信息,群组信息,可见性等。
ControllerModel:主要是 Comtroller 默认约定相关的了,这个里面东西就比较多了,有 控制器名称、路由值、Actions等,我们接下去的配置也将会在此展开
IFilterMetadata :空接口,主要起到标记的作用。
2、配置
第一步:先定义一个类,用来实现IApplicationModelConvention 接口。
/// <summary> /// 全局路由前缀配置 /// </summary> public class RouteConvention : IApplicationModelConvention { /// <summary> /// 定义一个路由前缀变量 /// </summary> private readonly AttributeRouteModel _centralPrefix; /// <summary> /// 调用时传入指定的路由前缀 /// </summary> /// <param name="routeTemplateProvider"></param> public RouteConvention(IRouteTemplateProvider routeTemplateProvider) { _centralPrefix = new AttributeRouteModel(routeTemplateProvider); } //接口的Apply方法 public void Apply(ApplicationModel application) { //遍历所有的 Controller foreach (var controller in application.Controllers) { // 1、已经标记了 RouteAttribute 的 Controller //这一块需要注意,如果在控制器中已经标注有路由了,则会在路由的前面再添加指定的路由内容。 var matchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel != null).ToList(); if (matchedSelectors.Any()) { foreach (var selectorModel in matchedSelectors) { // 在 当前路由上 再 添加一个 路由前缀 selectorModel.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix, selectorModel.AttributeRouteModel); } } //2、 没有标记 RouteAttribute 的 Controller var unmatchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel == null).ToList(); if (unmatchedSelectors.Any()) { foreach (var selectorModel in unmatchedSelectors) { // 添加一个 路由前缀 selectorModel.AttributeRouteModel = _centralPrefix; } } } } }
此处代码需要注意下,上面代码分为两部分,一部分是控制器有路由配置,一部分是没有路由配置。因此需要根据具体的情况来选择使用。
第二步:添加上面后,我们就定义一个类来插入我们的路由吧。
定义MvcOptionsExtensions.cs,此方法主要是扩展了MVCoptions类
public static class MvcOptionsExtensions { /// <summary> /// 扩展方法 /// </summary> /// <param name="opts"></param> /// <param name="routeAttribute"></param> public static void UseCentralRoutePrefix(this MvcOptions opts, IRouteTemplateProvider routeAttribute) { // 添加我们自定义 实现IApplicationModelConvention的RouteConvention opts.Conventions.Insert(0, new RouteConvention(routeAttribute)); } }
说明:routeAttribute 为我们自定的前缀内容。
第三步:在startup.cs 里面ConfigureServices 方法添加配置信息
#region 配置全局路由 //在各个控制器添加前缀(没有特定的路由前面添加前缀) services.AddMvc(opt => { opt.UseCentralRoutePrefix(new RouteAttribute("lg/v1/[action]")); //opt.UseCentralRoutePrefix(new RouteAttribute("api/[controller]/[action]")); }); #endregion
说明:上面的方括号在这边是有效的。其中内容可以自定义。
第四步:运行
1、原先控制器路由前缀保留
2、把原先的路由前缀去除
三、总结
至此,已很好的实现全局路由配置前缀啦。可以开心的玩耍啦。github代码地址:github
asp.net Core 交流群:787464275 欢迎加群交流
如果您认为这篇文章还不错或者有所收获,您可以点击右下角的【推荐】按钮精神支持,因为这种支持是我继续写作,分享的最大动力!
作者:LouieGuo
微信公众号:欢迎关注 QQ技术交流群: [b]欢迎加群[/b]
相关文章推荐
- asp.net core webapi项目配置全局路由的方法示例
- ASP.NET Core的身份认证框架IdentityServer4--(2)API跟WEB端配置
- C#实现多级子目录Zip压缩解压实例 NET4.6下的UTC时间转换 [译]ASP.NET Core Web API 中使用Oracle数据库和Dapper看这篇就够了 asp.Net Core免费开源分布式异常日志收集框架Exceptionless安装配置以及简单使用图文教程 asp.net core异步进行新增操作并且需要判断某些字段是否重复的三种解决方案 .NET Core开发日志
- Asp.net Core WebApi 全局异常类
- ASP.NET Core Web API 最小化项目
- ASP.NET Core WebAPI 开发-新建WebAPI项目 转
- ASP.NET Core WebAPI 开发-新建WebAPI项目
- ASP.NET Core Web API 最小化项目
- IT咨询顾问:一次吐血的项目救火 java或判断优化小技巧 asp.net core Session的测试使用心得 【.NET架构】BIM软件架构02:Web管控平台后台架构 NetCore入门篇:(十一)NetCore项目读取配置文件appsettings.json 使用LINQ生成Where的SQL语句 js_jquery_创建cookie有效期问题_时区问题
- ASP.NET Core WebApi 跨域配置 Cors
- 在ASP.NET Core Web API 项目里无法访问(wwwroot)下的文件
- asp.net core webapi 似乎未安装在 IIS 中承载 .NET Core 项目所需的 AspNetCoreModule。请尝试修复 Visual Studio 以纠正该问题。
- ASP.NET Core中使用默认MVC路由的配置
- asp.net项目中通过Web.config配置文件及文件夹的访问权限!
- asp.net项目中通过Web.config配置文件及文件夹的访问权限!
- ASP.Net Core WebApi几种版本控制对比
- 使用Swagger来生成asp.net core Web API 文档
- asp.net开发web项目-vss集成环境配置
- 在ASP.NET Core Web API中为RESTful服务增加对HAL的支持
- Docker容器环境下ASP.NET Core Web API应用程序的调试