我正在使用.NET Core 3.0 Web API,在这种情况下,我已经在baseapicontroller中设置了前缀,并且还在派生控制器中设置了路由,从理论上讲,我认为它的工作方式类似于“ baseapicontroller route /派生的控制器路由”,但它不能那样工作,.net核心仅选择派生的类路由,而忽略baseapicontroller路由。
我尝试使用属性“ Route ”和“ RoutePrefix ”,但仍然相同。
[ApiController]
[RoutePrefix("api/v1")]
//[Route("api/v1")]
public class BaseApiController : ControllerBase
{
}
派生的控制器
[Route("testing-route")]
public class TestRouteController : BaseApiController
{
[HttpGet]
public string test()
{
return "";
}
}
我希望该URL为“ api / v1 / testing-route / test ”,我不想在每个控制器中重复 api / v1 。而且我知道人们可能会说我可以使用“ api / v1 / [controller] / [action] ”,但这不是我的要求。我想为控制器使用自定义路由。
期待得到好的答复。
谢谢
答案 0 :(得分:2)
默认情况下,内置RouteAttribute
不适用于控制器继承。但是,要实现您的目标,您可以创建一个自定义IControllerModelConvention
来应用一个在启动时考虑控制器继承的规则。
为了避免与默认的[RouteAttribute]
混淆,我创建了一个自定义MyRoutePrefixAttribute
而不是使用默认的[RouteAttribute]
(如果您认为这样,请随意使用[RouteAttribute]
行为应被覆盖)):
[AttributeUsage(AttributeTargets.Class)]
public class MyRoutePrefixAttribute : Attribute
{
public MyRoutePrefixAttribute(string prefix) { Prefix = prefix; }
public string Prefix { get; }
}
要从继承链中查找此[MyRoutePrefixAttribute]
,我创建了一个RoutePrefixConvention
,它将递归组合前缀:
public class RoutePrefixConvention : IControllerModelConvention
{
public void Apply(ControllerModel controller)
{
foreach (var selector in controller.Selectors)
{
var prefixes = GetPrefixes(controller.ControllerType); // [prefix, parentPrefix, grandpaPrefix,...]
if(prefixes.Count == 0) continue;
// combine these prefixes one by one
var prefixRouteModels = prefixes.Select(p => new AttributeRouteModel(new RouteAttribute(p.Prefix)))
.Aggregate( (acc , prefix)=> AttributeRouteModel.CombineAttributeRouteModel(prefix, acc));
selector.AttributeRouteModel = selector.AttributeRouteModel != null ?
AttributeRouteModel.CombineAttributeRouteModel(prefixRouteModels, selector.AttributeRouteModel):
selector.AttributeRouteModel = prefixRouteModels;
}
}
private IList<MyRoutePrefixAttribute> GetPrefixes(Type controlerType)
{
var list = new List<MyRoutePrefixAttribute>();
FindPrefixesRec(controlerType, ref list);
list = list.Where(r => r!=null).ToList();
return list;
// find [MyRoutePrefixAttribute('...')] recursively
void FindPrefixesRec(Type type, ref List<MyRoutePrefixAttribute> results)
{
var prefix = type.GetCustomAttributes(false).OfType<MyRoutePrefixAttribute>().FirstOrDefault();
results.Add(prefix); // null is valid because it will seek prefix from parent recursively
var parentType = type.BaseType;
if(parentType == null) return;
FindPrefixesRec(parentType, ref results);
}
}
}
此约定将不影响性能:它仅在启动时通过继承链搜索所有[MyRoutePrefixAttribute]
属性。
最后,不要忘记在启动时添加以下约定:
services.AddControllersWithViews(opts =>{
opts.Conventions.Add(new RoutePrefixConvention());
});
让我们创建三个控制器来测试上述RoutePrefixConvention:
RootApiController
-> BaseApiController
-> TestRouteController
[ApiController]
[MyRoutePrefix("root/controllers")]
public class RootApiController : ControllerBase { }
[MyRoutePrefix("api/v1")]
public class BaseApiController : RootApiController { }
[Route("testing-route")]
public class TestRouteController : BaseApiController
{
[HttpGet]
public string test()
{
return "abc";
}
}
现在,访问/root/controllers/api/v1/testing-route
时,我们将得到一个字符串abc
: