ASP.NET Core MVC应用模型的构建[3]: Controller的收集

蒋金楠

发布于 2024-02-29 09:14:12

520

发布于 2024-02-29 09:14:12

从编程的角度来看，一个MVC应用是由一系列Controller类型构建而成的，所以对于一个代表应用模型的ApplicationModel对象来说，它的核心就是Controllers属性返回的一组ControllerModel对象，每个ControllerModel对象是应用模型针对Controller类型的描述。

一、ControllerModel

描述Controller类型的ControllerModel具有如下定义。该类型的Application属性返回作为当前应用模型的ApplicationModel对象。它的Actions属性返回的ActionModel是对所有定义在当前Controller类型中的Action方法的描述。描述Controller类型属性的PropertyModel对象则存放在ControllerProperties属性中，由于PropertyModel和描述Action方法参数的ParameterModel对象承载的都是服务于模型绑定的元数据，所以我们会将这两个类型的介绍放在一起。ControllerModel类型的Selectors属性返回的一组SelectorModel对象是对应用在Controller级别上的Action选择器的描述，我们会在后续内容中对SelectorModel对象进行单独介绍。

public class ControllerModel : ICommonModel, IFilterModel, IApiExplorerModel
{
    public ApplicationModel 			Application { get; set; }

    public IList<ActionModel> 		        Actions { get; }
    public IList<PropertyModel> 		ControllerProperties { get; }
    public IList<SelectorModel> 		Selectors { get; }

    public IDictionary<object, object> 	Properties { get; }
    public IList<IFilterMetadata> 		Filters { get; }
    public ApiExplorerModel 			ApiExplorer { get; set; }

    public TypeInfo 				ControllerType { get; }
    public IReadOnlyList<object> 		Attributes { get; }
    public string 				ControllerName { get; set; }
    public string 				DisplayName { get; }
    public IDictionary<string, string> 	RouteValues { get; }

    MemberInfo ICommonModel.MemberInfo { get; }
    string ICommonModel.Name { get; }
}

ControllerModel类型同时实现了ICommonModel、IFilterModel和IApiExplorerModel接口。默认注册的DefaultApplicationModelProvider会对ControllerModel对象做如下的设置：ControllerType和MemberInfo属性会设置为当前Controller的类型，该类型名称去除“Controller”后缀的字符串会作为Name和ControllerName的属性值。通过标注的特性注册到Controller类型上的过滤器会被提取出来，对应的元数据会添加到Filters属性中。ApiExplorer属性返回的ApiExplorerModel对象由标注在Controller类型上实现了IApiDescriptionGroupNameProvider和IApiDescriptionVisibilityProvider接口的特性构建而成。

DefaultApplicationModelProvider还会将标注到Controller类型上的所有特性提取出来，并将它们添加到Attributes属性中。如果特性类型实现了IRouteTemplateProvider接口，它们将专门用来构建特性路由信息或者路由约束，所以它们会从此列表中移除。DisplayName属性返回的显示名称通过对类型名称作相应格式化生成。DefaultApplicationModelProvider还会提取标注在Controller类型上实现了IRouteValueProvider接口的特性，并利用对应的设置来填充RouteValues属性返回的路由参数。目前唯一实现了该接口的是如下这个用来设置Area名称的AreaAttribute特性，设置的路由参数名称为“area”。

public interface IRouteValueProvider
{
    string RouteKey { get; }
    string RouteValue { get; }
}
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public abstract class RouteValueAttribute : Attribute, IRouteValueProvider
{
    public string RouteKey { get; }
    public string RouteValue { get; }
    protected RouteValueAttribute(string routeKey, string routeValue);
}
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public class AreaAttribute : RouteValueAttribute
{
    public AreaAttribute(string areaName) : base("area", areaName)
    {}
}

二、实例演示：Controller模型的构建

我们照例通过一个简单的实例来演示应用模型中用以描述Controller的元数据采用的默认构建规则。我们在前面演示程序中定义如下这个测试Controller类型FoobarController。如代码片段所示，FoobarController类型上标注了三个特性，分别是用来指定Area的AreaAttribute、过滤器特性FoobarAttribute和设置ApiExplorer的ApiExplorerSettingsAttribute。FoobarController类型中定义了两个属性（A和B）和两个Action方法（Foo和Bar）。

[Area("test")]
[Foobar]
[ApiExplorerSettings(GroupName = "test")]
public class FoobarController
{
    public string A { get; set; }
    public string B { get; set; }

    [HttpGet("foo")]
    public void Foo() => throw new NotImplementedException();
    [HttpGet("bar")]
    public void Bar() => throw new NotImplementedException();
}

为了在页面上呈现描述FoobarController类型的ControllerModel对象的相关信息，我们对定义在HomeControllere中的Action方法Index作了相应的修改。如下面的代码片段所示，我们利用在方法中注入的ApplicationModelProducer对象根据FoobarController类型创建一个ApplicationModel对象，并将包含在该对象中用来描述FoobarController的ControllerModel作为Model呈现成默认的View中。

public class HomeController: Controller
{
    [HttpGet("/")]
    public IActionResult Index([FromServices]ApplicationModelProducer producer)
    {
        var applicationModel = producer.Create(typeof(FoobarController));
        return View(applicationModel.Controllers.Single());
    }
}

我们最后对Action方法Index对应的View文件作相应的修改。如下面的代码片段所示，这是一个Model类型为ControllerModel的强类型View,，它将ControllerModel承载的元数据呈现在一个表格中。

@using  Microsoft.AspNetCore.Mvc.ApplicationModels;
@model ControllerModel
@{
    var commonModel 	= (ICommonModel)Model;
    var actions 	= Model.Actions;
    var filters 	= Model.Filters;
    var properties 	= Model.ControllerProperties;
    var attributes 	= Model.Attributes;
    var routeValues 	= Model.RouteValues.ToArray();
}
<html>
<head>
    <title>Controller</title>
</head>
<body>
    <table border="1" cellpadding="0" cellspacing="0">
        <tr><td>ControllerType </td><td>@Model.ControllerType.Name</td></tr>
        <tr><td>ControllerName </td><td>@Model.ControllerName</td></tr>
        <tr><td>Name </td><td>@commonModel.Name</td></tr>
        <tr><td>DisplayName </td><td>@Model.DisplayName</td></tr>
        <tr><td rowspan="@actions.Count">Actions</td><td>@actions[0].ActionName</td></tr>
        @for (int index = 1; index < actions.Count; index++)
        {
            <tr><td>@actions[index].ActionName</td></tr>
        }
        <tr>
            <td rowspan="@filters.Count">Filters</td><td>@filters[0].GetType().Name</td>
        </tr>
        @for (int index = 1; index < filters.Count; index++)
        {
            <tr><td>@filters[index].GetType().Name</td></tr>
        }
        <tr>
            <td rowspan="@properties.Count">ControllerProperties</td>
            <td>@properties[0].PropertyName</td>
        </tr>
        @for (int index = 1; index < properties.Count; index++)
        {
            <tr><td>@properties[index].PropertyName</td></tr>
        }
        <tr>
            <td rowspan="@attributes.Count">Attributes</td>
            <td>@attributes[0].GetType().Name</td>
        </tr>
        @for (int index = 1; index < attributes.Count; index++)
        {
            <tr><td>@attributes[index].GetType().Name</td></tr>
        }
        <tr>
            <td rowspan="@routeValues.Length">RouteVlues</td>
            <td>@routeValues[0].Key = @routeValues[0].Value</td>
        </tr>
        @for (int index = 1; index < routeValues.Length; index++)
        {
            <tr><td>@routeValues[index].Key = @routeValues[index].Value</td></tr>
        }
        <tr>
            <td rowspan="2">ApiExplorer</td>
            <td>IsVisible = @Model.ApiExplorer.IsVisible </td>
        </tr>
        <tr><td>GroupName = @Model.ApiExplorer.GroupName </td></tr>
    </table>
</body>
</html>

改动后的演示程序启动后，我们利用浏览器访问应用的主页，可以得到如图1所示的输出结果。正如上面我们所说的，去除“Controller”字符后缀的类型名称成为了ControllerModel对象的Name和ControllerName的属性值（“Foobar”）。两个属性（A和B）和Action方法（Foo和Bar）转换成相应的PropertyModel和ActionModel对象并分别添加到ControllerModel对象的ControllerProperties和Actions属性中。通过标注特性注册的过滤器（FoobarAttribute）被添加到ControllerModel对象的Filters属性中。通过标注的AreaAttribute设置的Area名称最终转移到ControllerModel对象对象RouteValues属性中。ControllerModel对象的ApiExplorer属性返回的ApiExplorerModel对象很明显是通过标注在类型上的ApiExplorerSettingsAttribute特性创建的，而它的Attributes属性中包含了我们标注的三个特性。

图1Controller模型默认的构建规则

三、实例演示：定制Controller模型

通过前面介绍的针对应用模型的总体设计，我们知道针对Controller模型的定制可以通过自定义的IControllerModelConvention实现类型来实现，我们接下来利用这种方式来改变Controller默认的命名规则。我们在上面演示的程序中定义了如下这个ControllerNameAttribute特性，该特性类型实现了IControllerModelConvention接口，在实现的Apply方法中，我们将构造函数中设置的Controller名称应用到提供的ControllerModel对象上。我们将该特性标注到FoobarController类型上并将名称设置为“Baz”。

[AttributeUsage(AttributeTargets.Class)]
public class ControllerNameAttribute : Attribute, IControllerModelConvention
{
    public string ControllerName { get; }
    public ControllerNameAttribute(string name) => ControllerName = name;
    public void Apply(ControllerModel controller) => controller.ControllerName = ControllerName;
}

[Area("test")]
[Foobar]
[ApiExplorerSettings(GroupName = "test")]
[ControllerName("Baz")]
public class FoobarController
{
   …
}

改动后的演示程序启动后，我们利用浏览器访问应用的主页，可以得到如图2所示的输出结果。我们从图中可以看出，对于最终生成的用来描述FoobarController类型的ControllerModel对象来说，它的ControllerName属性被设置成我们指定的名称“Baz”，它的Name属性（ControllerModel类型针对ICommonModel接口的实现）返回的就是ControllerName属性值。