我目前正致力于ASP.NET MVC 4 Web应用程序项目，该项目必须遵循以下设计决策：
所有区域中的所有普通控制器（包括root）都按预期工作。但是，我的一些Web API控制器出现意外行为。例如，具有两个名称相同但位于不同区域的Web API控制器会产生以下异常：
发现多个类型与名为“clients”的控制器匹配。 如果为此请求提供服务的路由，则会发生这种情况 （'api / {controller} / {id}'）发现了多个控制器 同名但不同的命名空间，不受支持。
对'clients'的请求找到了以下匹配的控制器： MvcApplication.Areas.Administration.Controllers.Api.ClientsController MvcApplication.Controllers.Api.ClientsController
这看起来很奇怪，因为我有不同的路线，应该将两者分开。这是我的管理部门的区域注册：
public class AdministrationAreaRegistration : AreaRegistration
{
public override string AreaName
{
get
{
return "Administration";
}
}
public override void RegisterArea(AreaRegistrationContext context)
{
context.Routes.MapHttpRoute(
name: "Administration_DefaultApi",
routeTemplate: "Administration/api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
context.MapRoute(
"Administration_default",
"Administration/{controller}/{action}/{id}",
new { action = "Index", id = UrlParameter.Optional }
);
}
}
此外，我注意到我可以访问区域特定的Web API，同时省略了呼叫区域的名称。
这里发生了什么？ 如何让我的Web API控制器像普通的ASP.NET MVC控制器一样运行？
答案 0 :(得分：19)
ASP.NET MVC 4不支持跨区域划分Web API控制器。
您可以将WebApi控制器放在不同区域的不同Api文件夹中，但ASP.NET MVC会将它们视为全部位于同一位置。
幸运的是，您可以通过覆盖ASP.NET MVC基础结构的一部分来克服此限制。有关限制和解决方案的更多信息，请阅读我的博文“ASP.NET MVC 4 RC: Getting WebApi and Areas to play nicely”。如果您只对该解决方案感兴趣，请继续阅读：
步骤1.让您的路线区域识别
将以下扩展方法添加到ASP.NET MVC应用程序中，并确保可以从AreaRegistration类访问它们：
public static class AreaRegistrationContextExtensions
{
public static Route MapHttpRoute(this AreaRegistrationContext context, string name, string routeTemplate)
{
return context.MapHttpRoute(name, routeTemplate, null, null);
}
public static Route MapHttpRoute(this AreaRegistrationContext context, string name, string routeTemplate, object defaults)
{
return context.MapHttpRoute(name, routeTemplate, defaults, null);
}
public static Route MapHttpRoute(this AreaRegistrationContext context, string name, string routeTemplate, object defaults, object constraints)
{
var route = context.Routes.MapHttpRoute(name, routeTemplate, defaults, constraints);
if (route.DataTokens == null)
{
route.DataTokens = new RouteValueDictionary();
}
route.DataTokens.Add("area", context.AreaName);
return route;
}
}
要使用新的扩展方法，请从调用链中删除Routes属性：
context.MapHttpRoute( /* <-- .Routes removed */
name: "Administration_DefaultApi",
routeTemplate: "Administration/api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
步骤2.使Web API控制器选择器区域识别
将以下类添加到ASP.NET MVC应用程序中，并确保可以从Global.asax
访问它namespace MvcApplication.Infrastructure.Dispatcher
{
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Net.Http;
using System.Web.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Dispatcher;
public class AreaHttpControllerSelector : DefaultHttpControllerSelector
{
private const string AreaRouteVariableName = "area";
private readonly HttpConfiguration _configuration;
private readonly Lazy<ConcurrentDictionary<string, Type>> _apiControllerTypes;
public AreaHttpControllerSelector(HttpConfiguration configuration)
: base(configuration)
{
_configuration = configuration;
_apiControllerTypes = new Lazy<ConcurrentDictionary<string, Type>>(GetControllerTypes);
}
public override HttpControllerDescriptor SelectController(HttpRequestMessage request)
{
return this.GetApiController(request);
}
private static string GetAreaName(HttpRequestMessage request)
{
var data = request.GetRouteData();
if (data.Route.DataTokens == null)
{
return null;
}
else
{
object areaName;
return data.Route.DataTokens.TryGetValue(AreaRouteVariableName, out areaName) ? areaName.ToString() : null;
}
}
private static ConcurrentDictionary<string, Type> GetControllerTypes()
{
var assemblies = AppDomain.CurrentDomain.GetAssemblies();
var types = assemblies
.SelectMany(a => a
.GetTypes().Where(t =>
!t.IsAbstract &&
t.Name.EndsWith(ControllerSuffix, StringComparison.OrdinalIgnoreCase) &&
typeof(IHttpController).IsAssignableFrom(t)))
.ToDictionary(t => t.FullName, t => t);
return new ConcurrentDictionary<string, Type>(types);
}
private HttpControllerDescriptor GetApiController(HttpRequestMessage request)
{
var areaName = GetAreaName(request);
var controllerName = GetControllerName(request);
var type = GetControllerType(areaName, controllerName);
return new HttpControllerDescriptor(_configuration, controllerName, type);
}
private Type GetControllerType(string areaName, string controllerName)
{
var query = _apiControllerTypes.Value.AsEnumerable();
if (string.IsNullOrEmpty(areaName))
{
query = query.WithoutAreaName();
}
else
{
query = query.ByAreaName(areaName);
}
return query
.ByControllerName(controllerName)
.Select(x => x.Value)
.Single();
}
}
public static class ControllerTypeSpecifications
{
public static IEnumerable<KeyValuePair<string, Type>> ByAreaName(this IEnumerable<KeyValuePair<string, Type>> query, string areaName)
{
var areaNameToFind = string.Format(CultureInfo.InvariantCulture, ".{0}.", areaName);
return query.Where(x => x.Key.IndexOf(areaNameToFind, StringComparison.OrdinalIgnoreCase) != -1);
}
public static IEnumerable<KeyValuePair<string, Type>> WithoutAreaName(this IEnumerable<KeyValuePair<string, Type>> query)
{
return query.Where(x => x.Key.IndexOf(".areas.", StringComparison.OrdinalIgnoreCase) == -1);
}
public static IEnumerable<KeyValuePair<string, Type>> ByControllerName(this IEnumerable<KeyValuePair<string, Type>> query, string controllerName)
{
var controllerNameToFind = string.Format(CultureInfo.InvariantCulture, ".{0}{1}", controllerName, AreaHttpControllerSelector.ControllerSuffix);
return query.Where(x => x.Key.EndsWith(controllerNameToFind, StringComparison.OrdinalIgnoreCase));
}
}
}
通过将以下行添加到Global.asax中的DefaultHttpControllerSelector方法来覆盖Application_Start。
GlobalConfiguration.Configuration.Services.Replace(typeof(IHttpControllerSelector), new AreaHttpControllerSelector(GlobalConfiguration.Configuration));
恭喜，您的Web API控制器现在将像您的普通MVC控制器一样尊重您所在区域的规则！
更新：2012年9月6日
一些开发人员与我联系过他们遇到的路由变量的DataTokens属性为null的情况。我的实现假定DataTokens属性始终初始化，如果此属性为null，则无法正常运行。这种行为很可能是由ASP.NET MVC框架中的最近更改引起的，实际上可能是框架中的错误。我已经更新了我的代码来处理这种情况。