如何从HttpController
众多方法里如何选择出有效的Action
方法?主要分一下几个步骤:
首先,获取候选HttpActionDescriptor
列表(ILookup<string, HttpActionDescriptor>
类型)
通过作为参数的HttpControlIerDescriptor
对象获取当前HttpControlIer
的真实类型,然后调用其GetMethods
方法获得描述所有方法成员的MethodInfo
对象列表,并从中筛选出所有“有效”的Action
方法来创建相应ReflectedHttpActionDescriptor
对象。有效的Action
方法要满足以下几个条件:
- 公有实例方法
- 不是从
ApiController
类型中继承的方法 MethodInfo
的IsSpecialName
属性值为False
(表示属性成员Geter
和Seter
的MethodInfo
不会被用于创建HttpActionDescriptor
)- 没有定义
NonActionAttribute
我们知道,ActionNameAttribute
特性让多个Action
方法共享同—个名称,是一个—对多的关系,所以,我们过滤出有效Action
方法后,构建一个ILookup<string,HttpActionDescriptor>
类型的对象作为候选HttpActionDescriptor
列表,Key
为Action
名称,Value
为HttpActionDescriptor
。
其次,根据请求解析出的路由提供的Action
名称进行筛选
从指定的HttpControllerContext
对象中提取用于封装路由数据的HttpRouteData
对象,若包含Action
的名称,就从待选HttpActionDescriptor
列表(ILookup<string,HttpActionDescriptor>
类型),获取Action
名称与它匹配的HttpActionDescriptor
列表,否则,忽略该步骤。
再次,根据请求的Http
方法与待选列表种的每个HttpActionDescriptor
所支持的HttpMethod
匹配
通过候选HttpActionDescriptor
对象的SupportedHttpMethods
属性得到对应Action
方法支持的HTTP
方法列表,如果此列表包含当前请求的HTTP
方法,那么此HttpActionDescriptor
会被筛选出来。
从次,参数的匹配
参数的来源有两种:
- URL的路径一部分,会转换成路由变量,如
api/product/{id}
- URL查询字符串,如
api/product?id=1
针对众多候选Action
方法来说,如果它们的参数值应该由请求URL
的查询字符串或者生成的HttpRouteData
对象来提供,能够被选择用于处理某个请求的Action
必须满足这样的条件和原则:
- 当前请求URL的查询字符串和生成的
HttpRouteData
能够提供这种类型的所有参数 - 如果参数匹配有多个方法满足,选择
Action
方法参数多的
参数匹配有点模糊,举个例子,控制器中有以下几个Action
方法,
//无参数
public string Get()
{
return "DemoController.Get()";
}
[HttpGet]
[ActionName("Get")]
public string Retrieve()
{
return "DemoController Retrieve";
}
//一个参数
public string Get(string x)
{
return "DemoController.Get(string x)"
}
//两个参数
public string Get(string x, string y)
{
return "DemoController.Get(string x, string y)"
}
public string Get(int x, int y)
{
return "DemoController.Get(int x, int y)"
}
如果接收到的是一个URL
为“/api/demo?x=1
” 的GET请求,对于5个GET的Action
来说,只有前面3个ActIon
方法(Get
、Retrieve
和Get(string x)
的参数能够通过URL
的查询字符串来提供,所以它们会被选择。Get
和Retrieve
不需要参数,URL
中提供了一个,所以也选中。
对于其余两个Action
方法,它们的参数y无法从请求中获得,所以会被排除在选择范围之外。
具体实现,会为每个Action
方法建立必须通过URL
提供的参数值的参数名称数组,以上五个方法,对应的数组如下:
[],[],["x"],["x","y"],["x","y"]
再根据请求URL
从两种参数来源,获取不重复的所有参数值(不区分大小写),如/api/demo?x=1&y=2
,URL
提供的参数是["x","y"]
根据“请求必须提供执行目标Action
方法所需参数值”条件,以上5个方法都匹配,又根据“有多个符合条件情况下,选择Action
方法参数多的”原则,只有最后两个Action
方法会选中(Get(string x, string y)
、Get(int x, int y)
)。
最后,匹配结果的异常处理
经过前边四步匹配得到的结果及处理情况如下:
- 一个
Action
方法 ------ 直接执行 - 具有多个符合筛选条件的
Action
方法 ------- 抛出异常InvalidoperationException
的异常 - 不具有符合筛选条件的
Action
方法,但在不考虑请求采用的HTTP方法的情况下,具有—个或者多个Action 方法与请求相匹配 -------- 回复—个状态为“405 ,Method Not Allowed” 的响应,并将候选Action方法支持的HTTP方法列表置于名为“Accept”的响应报头中 - 不论是否考虑请求采用的HTTP方法,都不具有符合筛选条件的Action方法 -----------
直接回复一个状态为“404,Not Found” 的响应
一、涉及的类及源码分析
1、IHttpActionSelector ApiControllerActionSelector
Action的选择通过标准组件HttpActionSelector
完成,提供了一个接口IHttpActionSelector
,以及一个默认实现ApiControllerActionSelector
,其次也是在服务容器里指定的
接口如下:
public interface IHttpActionSelector
{
ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor);
HttpActionDescriptor SelectAction(HttpControllerContext controllerContext);
}
ApiControllerActionSelector
基本代码如下:
回顾下抽象类ApiController
里的ExecuteAsync
方法的代码:
//主要方法,创建控制器对象后,会调用ExecuteAsync方法,进行后续操作,
public virtual Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken)
{
if (_initialized)
{
// 如果已经创建过该实例,就抛出异常,一个控制器实例,多次请求不能重复使用
throw Error.InvalidOperation(SRResources.CannotSupportSingletonInstance, typeof(ApiController).Name, typeof(IHttpControllerActivator).Name);
}
Initialize(controllerContext);
if (Request != null)
{
//先注册到待销毁集合,待请求完成后一起销毁改控制器实例
Request.RegisterForDispose(this);
}
HttpControllerDescriptor controllerDescriptor = controllerContext.ControllerDescriptor;
ServicesContainer controllerServices = controllerDescriptor.Configuration.Services;
//选择Action,通过该语句来触发控制器选择,返回ActionDescriptor
HttpActionDescriptor actionDescriptor = controllerServices.GetActionSelector().SelectAction(controllerContext);
ActionContext.ActionDescriptor = actionDescriptor;
if (Request != null)
{
Request.SetActionDescriptor(actionDescriptor);
}
FilterGrouping filterGrouping = actionDescriptor.GetFilterGrouping();
//ActionFilters
IActionFilter[] actionFilters = filterGrouping.ActionFilters;
//身份认证过滤器
IAuthenticationFilter[] authenticationFilters = filterGrouping.AuthenticationFilters;
//授权过滤器
IAuthorizationFilter[] authorizationFilters = filterGrouping.AuthorizationFilters;
//ExceptionFilters
IExceptionFilter[] exceptionFilters = filterGrouping.ExceptionFilters;
IHttpActionResult result = new ActionFilterResult(actionDescriptor.ActionBinding, ActionContext,
controllerServices, actionFilters);
if (authorizationFilters.Length > 0)
{
result = new AuthorizationFilterResult(ActionContext, authorizationFilters, result);
}
if (authenticationFilters.Length > 0)
{
result = new AuthenticationFilterResult(ActionContext, this, authenticationFilters, result);
}
if (exceptionFilters.Length > 0)
{
IExceptionLogger exceptionLogger = ExceptionServices.GetLogger(controllerServices);
IExceptionHandler exceptionHandler = ExceptionServices.GetHandler(controllerServices);
result = new ExceptionFilterResult(ActionContext, exceptionFilters, exceptionLogger, exceptionHandler,
result);
}
//执行IHttpActionResult的ExecuteAsync
return result.ExecuteAsync(cancellationToken);
}
可以知道主要是在该方法中调用了ApiControllerActionSelector
类的SelectAction
方法来返回HttpActionDescriptor
我们主要看下SelectAction
源代码:
//接口IHttpActionSelector方法
public virtual HttpActionDescriptor SelectAction(HttpControllerContext controllerContext)
{
if (controllerContext == null)
{
throw Error.ArgumentNull("controllerContext");
}
ActionSelectorCacheItem internalSelector = GetInternalSelector(controllerContext.ControllerDescriptor);
return internalSelector.SelectAction(controllerContext);
}
///接口IHttpActionSelector方法
public virtual ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor)
{
if (controllerDescriptor == null)
{
throw Error.ArgumentNull("controllerDescriptor");
}
//从internalSelector中获取ILookup<string, HttpActionDescriptor>
ActionSelectorCacheItem internalSelector = GetInternalSelector(controllerDescriptor);
return internalSelector.GetActionMapping();
}
其中的GetInternalSelector
方法返回一个ActionSelectorCacheItem
,再调用其的SelectAction
方法
GetInternalSelector
方法代码如下:
private ActionSelectorCacheItem GetInternalSelector(HttpControllerDescriptor controllerDescriptor)
{
// 性能敏感的
// 先从本地快速缓存查找,如果没有再从HttpControllerDescriptor的字典属性缓存中找
if (_fastCache == null)
{
ActionSelectorCacheItem selector = new ActionSelectorCacheItem(controllerDescriptor);
//线程安全,比较_fastCache是否为null,如果是,用selector替换_fastCache,不为null,说明_fastCache已经被修改了,不替换
Interlocked.CompareExchange(ref _fastCache, selector, null);
return selector;
}
else if (_fastCache.HttpControllerDescriptor == controllerDescriptor)
{
// If the key matches and we already have the delegate for creating an instance then just execute it
return _fastCache;
}
else
{
// 如果键不匹配,则在HttpControllerDescriptor属性中查找
object cacheValue;
if (controllerDescriptor.Properties.TryGetValue(_cacheKey, out cacheValue))
{
return (ActionSelectorCacheItem)cacheValue;
}
//如果找不到,就创建一个ActionSelectorCacheItem,并放到HttpControllerDescriptor属性中
ActionSelectorCacheItem selector = new ActionSelectorCacheItem(controllerDescriptor);
controllerDescriptor.Properties.TryAdd(_cacheKey, selector);
return selector;
}
}
第一次访问时候,我们会创建一个ActionSelectorCacheItem
,构造函数如下:
public ActionSelectorCacheItem(HttpControllerDescriptor controllerDescriptor)
{
Contract.Assert(controllerDescriptor != null);
// Initialize the cache entirely in the ctor on a single thread.
_controllerDescriptor = controllerDescriptor;
//一、首先,获取候选HttpActionDescriptor列表
//通过反射查找出所有公有的实例方法
MethodInfo[] allMethods = _controllerDescriptor.ControllerType.GetMethods(BindingFlags.Instance | BindingFlags.Public);
//通过委托IsValidActionMethod过滤出有效的方法(非指定名称的方法,不是从IHttpController, ApiController继承的方法,不定义NonActionAttribute)
MethodInfo[] validMethods = Array.FindAll(allMethods, IsValidActionMethod);
_combinedCandidateActions = new CandidateAction[validMethods.Length];
for (int i = 0; i < validMethods.Length; i++)
{
//根据MthodInfo创建ReflectedHttpActionDescriptor对象
MethodInfo method = validMethods[i];
ReflectedHttpActionDescriptor actionDescriptor = new ReflectedHttpActionDescriptor(_controllerDescriptor, method);
_combinedCandidateActions[i] = new CandidateAction
{
ActionDescriptor = actionDescriptor
};
HttpActionBinding actionBinding = actionDescriptor.ActionBinding;
// Building an action parameter name mapping to compare against the URI parameters coming from the request. Here we only take into account required parameters that are simple types and come from URI.
_actionParameterNames.Add(
actionDescriptor,
actionBinding.ParameterBindings
.Where(binding => !binding.Descriptor.IsOptional && TypeHelper.CanConvertFromString(binding.Descriptor.ParameterType) && binding.WillReadUri())
.Select(binding => binding.Descriptor.Prefix ?? binding.Descriptor.ParameterName).ToArray());
}
//
_combinedActionNameMapping =
_combinedCandidateActions
.Select(c => c.ActionDescriptor)
.ToLookup(actionDesc => actionDesc.ActionName, StringComparer.OrdinalIgnoreCase);
}
这里会获取待选的Action
列表,IsValidActionMethod
委托代码如下:
private static bool IsValidActionMethod(MethodInfo methodInfo)
{
//非指定名称的方法,即不能被外部用户直接调用的方法,通过其他方式间接调用,如构造函数
if (methodInfo.IsSpecialName)
{
return false;
}
//不是从IHttpController, ApiController继承的方法
if (methodInfo.GetBaseDefinition().DeclaringType.IsAssignableFrom(TypeHelper.ApiControllerType))
{
return false;
}
//不定义NonActionAttribute
if (methodInfo.GetCustomAttribute<NonActionAttribute>() != null)
{
return false;
}
return true;
}
创建完ActionSelectorCacheItem
后,返回ApiControllerActionSelector
的SelectAction
方法,调用创建的ActionSelectorCacheItem(internalSelector )
的SelectAction
,代码如下:
public HttpActionDescriptor SelectAction(HttpControllerContext controllerContext)
{
//再次,该方法里会进行,httpmethod方法匹配
InitializeStandardActions();
//根据请求的Action名称(其次),参数进行匹配过滤(从次)
List<CandidateActionWithParams> selectedCandidates = FindMatchingActions(controllerContext);
//最后,匹配结果的异常处理
switch (selectedCandidates.Count)
{
//找不到
case 0:
throw new HttpResponseException(CreateSelectionError(controllerContext));
case 1:
//1个结果正常返回
ElevateRouteData(controllerContext, selectedCandidates[0]);
return selectedCandidates[0].ActionDescriptor;
default:
//匹配了多个结果,抛异常
// Throws exception because multiple actionsByVerb match the request
string ambiguityList = CreateAmbiguousMatchList(selectedCandidates);
throw Error.InvalidOperation(SRResources.ApiControllerActionSelector_AmbiguousMatch, ambiguityList);
}
}
该方法执行完,正常结果会返回一个HttpActionDescriptor
,由于代码细节很多,可以弄到源代码仔细研读。到此代码就执行到了Controller
里的ExecuteAsync
方法的
HttpControllerDescriptor controllerDescriptor = controllerContext.ControllerDescriptor;
ServicesContainer controllerServices = controllerDescriptor.Configuration.Services;
//选择Action,通过该语句来触发控制器选择,返回ActionDescriptor
HttpActionDescriptor actionDescriptor = controllerServices.GetActionSelector().SelectAction(controllerContext);
ActionContext.ActionDescriptor = actionDescriptor;
if (Request != null)
{
Request.SetActionDescriptor(actionDescriptor);
}
FilterGrouping filterGrouping = actionDescriptor.GetFilterGrouping();
//ActionFilters
IActionFilter[] actionFilters = filterGrouping.ActionFilters;
//身份认证过滤器
IAuthenticationFilter[] authenticationFilters = filterGrouping.AuthenticationFilters;
//授权过滤器
IAuthorizationFilter[] authorizationFilters = filterGrouping.AuthorizationFilters;
//ExceptionFilters
IExceptionFilter[] exceptionFilters = filterGrouping.ExceptionFilters;
IHttpActionResult result = new ActionFilterResult(actionDescriptor.ActionBinding, ActionContext,
controllerServices, actionFilters);
if (authorizationFilters.Length > 0)
{
result = new AuthorizationFilterResult(ActionContext, authorizationFilters, result);
}
if (authenticationFilters.Length > 0)
{
result = new AuthenticationFilterResult(ActionContext, this, authenticationFilters, result);
}
if (exceptionFilters.Length > 0)
{
IExceptionLogger exceptionLogger = ExceptionServices.GetLogger(controllerServices);
IExceptionHandler exceptionHandler = ExceptionServices.GetHandler(controllerServices);
result = new ExceptionFilterResult(ActionContext, exceptionFilters, exceptionLogger, exceptionHandler,
result);
}
//执行IHttpActionResult的ExecuteAsync
return result.ExecuteAsync(cancellationToken);
获取到了ActionDesciptor
并放到ActionContext
中,也别设置到了Request
中,后边就开始获取过滤器了。