ASP.NET MVC ParameterDescriptor 对象详细

作者：袖梨 2022-06-25

Model绑定是为作为目标Action的方法准备参数列表的过程，所以针对参数的描述才是Model绑定的核心。在ASP.NET MVC应用编程接口中，服务于Model绑定的参数元数据通过ParameterDescriptor类型来表示，而ActionDescriptor的GetParameters方法返回的就是一个ParameterDescriptor数组。

如下面的代码片断所示，ParameterDescriptor同样实现了ICustomAttributeProvider接口提供应用在相应参数上的特性。ParameterDescriptor的只读属性ActionDescriptor表示描述所在Action方法的ActionDescriptor对象。属性ParameterName、ParameterType和DefaultValue分别表示参数的名称、类型和默认值。

代码如下

复制代码

    public abstract class ParameterDescriptor : ICustomAttributeProvider
    {
        public virtual object[] GetCustomAttributes(bool inherit);
        public virtual object[] GetCustomAttributes(Type attributeType, bool inherit);
       public virtual bool IsDefined(Type attributeType, bool inherit);

        public abstract ActionDescriptor ActionDescriptor { get; }
        public abstract string ParameterName { get; }
       public abstract Type ParameterType { get; }
      public virtual object DefaultValue { get; }

       public virtual ParameterBindingInfo BindingInfo { get; }
   }

ParameterDescriptor的只读属性BindingInfo表示的System.Web.Mvc.ParameterBindingInfo对象封装一些信息用于控制请求数据与参数的绑定行为。如下面的代码片断所示，抽象类ParameterBindingInfo具有四个属性，其中类型为IModelBinder的Binder属性返回的ModelBinder对象是整个Model绑定的核心，我们将在本章后续部分进行单独介绍。

代码如下	复制代码
public abstract class ParameterBindingInfo { public virtual IModelBinder Binder { get; } public virtual ICollection Include { get; } public virtual ICollection Exclude { get; } public virtual string Prefix { get; } }

如果参数类型是一个复杂类型，默认情况下会绑定其所有公共可读写属性，而两个ICollection类型的属性Include和Exclude表示显示设置的参与/不参与绑定的属性名称列表。在默认情况下，请求数据与参数之间严格按照名称进行绑定，但是有时候请求数据名称具有相应的前缀，这个前缀体现在ParameterBindingInfo的Prefix属性上。

ReflectedParameterDescriptor
原生的ParameterBindingInfo是通过针对表示参数的ParameterInfo进行反射获得，这样的ParameterBindingInfo通过ReflectedParameterDescriptor类型表示。如下面的代码片断所示，这个ParameterInfo对象通过只读属性ParameterInfo表示，并在构造函数中被初始化。

代码如下

复制代码

    public class ReflectedParameterDescriptor : ParameterDescriptor
    {
       public ReflectedParameterDescriptor(ParameterInfo parameterInfo, ActionDescriptor actionDescriptor);
        public override object[] GetCustomAttributes(bool inherit);
        public override object[] GetCustomAttributes(Type attributeType, bool inherit);
       public override bool IsDefined(Type attributeType, bool inherit);

        public override ActionDescriptor ActionDescriptor { get; }
        public override ParameterBindingInfo BindingInfo { get; }
       public override object DefaultValue { get; }
     public override string ParameterName { get; }
       public override Type ParameterType { get; }

       public ParameterInfo ParameterInfo { get; }
   }

ReflectedParameterDescriptor的BindingInfo属性返回的是一个ReflectedParameterBindingInfo对象，这是一个内部类型。该BindingInfo的Include、Exclude和Prefix属性来源于对应用在参数上的BindAttribute特性的解析。如下面的代码片断所示，BindAttribute中同样定义了这三个属性，其中Include和Exclude为通过逗号作为分隔符的属性名称列表。

代码如下	复制代码
[AttributeUsage(AttributeTargets.Parameter \| AttributeTargets.Class, AllowMultiple=false, Inherited=true)] public sealed class BindAttribute : Attribute { public bool IsPropertyAllowed(string propertyName); public string Include { get; set; } public string Exclude { get; set; } public string Prefix { get; set;} }