C# WebAPI 路由配置

背景：在开发项目的过程中，新创建了一个controller，发现vs会给我们直接在controller头添加前缀，比如[Route("api/[controller]")],即在访问接口的时候会变成http://localhost:8000/api/values，但是如果控制器有很多个，或者要进行版本迭代时，我们会发现痛苦的时刻降临了，要一个一个的修改。

如果在这个时候可以进行全局配置前缀那真是福利呀，修改一处即可。为了能达到此目的我们就来运用一下吧。

1、我们需要用到 IApplicationModelConvention 这个接口，它是位于 Microsoft.AspNetCore.Mvc.ApplicationModels 命令空间下

ApiExplorerModel:包括描述信息，群组信息，可见性等。

ControllerModel：主要是 Comtroller 默认约定相关的了，这个里面东西就比较多了，有控制器名称、路由值、Actions等，我们接下去的配置也将会在此展开

扫描二维码关注公众号，回复： 15557261 查看本文章

IFilterMetadata ：空接口，主要起到标记的作用。

2、配置

第一步：先定义一个类，用来实现IApplicationModelConvention 接口。

using Microsoft.AspNetCore.Mvc.ApplicationModels;
using Microsoft.AspNetCore.Mvc.Routing;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace WebAPI.Controllers
{
    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;
                    }
                }
            }
        }
    }
}

第二步：添加上面后，我们就定义一个类来插入我们的路由吧。

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Routing;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace WebAPI.Controllers
{
    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));
        }
    }
}

第三步：在startup.cs 里面ConfigureServices 方法添加配置信息

#region 配置全局路由
            //在各个控制器添加前缀（没有特定的路由前面添加前缀）
            services.AddMvc(opt =>
            {
                opt.UseCentralRoutePrefix(new RouteAttribute("lg/v1/[action]"));
                //opt.UseCentralRoutePrefix(new RouteAttribute("api/[controller]/[action]"));
            });
            #endregion

第四步：运行

猜你喜欢