ASP.NET Core API 配置全局路由

ASP.NET Core 中的路由 
在 ASP.NET Core 中路由到控制器操作
ASP.NET Web API 2 中的属性路由 
文档目录  
.NET 文档  
ASP.NET 文档  

ASP.NET Core默认使用的是属性路由，如下图

在Controller上标记形式为[Route("api")]，在Controller的action上标记形式为[Route("v1/[controller]")]，代码如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using CoreLibrary;

namespace WebApplication1.Controllers
{
    [ApiController]
    [Route("api/")]
    public class WeatherForecastController : ControllerBase
    {
        private static readonly string[] Summaries = new[]
        {
            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        };

        private readonly ILogger<WeatherForecastController> _logger;

        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        {
            _logger = logger;
        }

        [Route("v1/[controller]")]
        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            LogUtils.GetLogUtilsService().Info("123");

            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }

        [Route("v2/[controller]")]
        [HttpGet]
        public IEnumerable<WeatherForecast> GetV2()
        {
            LogUtils.GetLogUtilsService().Info("123");

            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }

        [Route("v1/[controller]")]
        [HttpPost]
        public void post(string a,string b)
        { }
    }
}

接下来定义全局路由

1、先定义一个类，用来实现IApplicationModelConvention  接口。

using Microsoft.AspNetCore.Mvc.ApplicationModels;
using Microsoft.AspNetCore.Mvc.Routing;
using System.Linq;

namespace Web.Api.Intercept
{
    /// <summary>
    /// api 路由拦截器（第一步）
    /// </summary>
    public class RouteConvention : IApplicationModelConvention
    {
        private readonly AttributeRouteModel _centralPrefix;

        public RouteConvention(IRouteTemplateProvider routeTemplateProvider)
        {
            _centralPrefix = new AttributeRouteModel(routeTemplateProvider);
        }

        //接口的Apply方法
        public void Apply(ApplicationModel application)
        {
            //遍历所有的 Controller
            foreach (var controller in application.Controllers)
            {
                // 已经标记了 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);

                        // 在 当前路由上 不再 添加任何路由前缀
                        //selectorModel.AttributeRouteModel = selectorModel.AttributeRouteModel;
                    }
                }

                // 没有标记 RouteAttribute 的 Controller
                var unmatchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel == null).ToList();
                if (unmatchedSelectors.Any())
                {
                    foreach (var selectorModel in unmatchedSelectors)
                    {
                        // 添加一个 路由前缀
                        //selectorModel.AttributeRouteModel = _centralPrefix;

                        // 不添加前缀(说明：不使用全局路由，重构action，实现自定义、特殊的action路由地址)
                        selectorModel.AttributeRouteModel = selectorModel.AttributeRouteModel;
                    }
                }
            }
        }
    }
}

2、定义一个类，插入路由

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Routing;

namespace Web.Api.Intercept
{
    /// <summary>
    /// api 路由拦截器（第二步）
    /// 扩展了MVCoptions
    /// </summary>
    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));
        }

    }
}

3、在startup.cs 里面ConfigureServices 方法添加配置信息

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Web.Api.Intercept;

namespace Web.Api
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvcCore()
               .AddAuthorization()
               .AddJsonFormatters();

            //默认
            //services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

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

            }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }

            app.UseAuthentication();
            app.UseHttpsRedirection();

            app.UseMvc();
        }
    }
}

4、运行

原先控制器路由“前缀”保留，如下方式：

[Route("api/[controller]")] //https://localhost:44390/lg/v1/get/api/default
[ApiController]
public class DefaultController : ControllerBase
{
    // GET: api/Default
    [HttpGet]
    public IEnumerable<string> Get()
    {
        return new string[] { "value3", "value4" };
    }
}

把原先的路由“前缀”去除，如下方式：

[Route("")]                   //https://localhost:44390/lg/v1/get
[ApiController]
public class DefaultController : ControllerBase
{
    // GET: api/Default
    [HttpGet]
    public IEnumerable<string> Get()
    {
        return new string[] { "value3", "value4" };
    }
}

*、约束
[HttpPost("{id:int}")]
[HttpPost("{id:guid}")]

[Route("users/{id:int}")]
[Route("users/{id:int:min(1)}")]
*
*
*
*
*
*
*
*
*
*
*
*
*