如何使用构造函数参数测试是否存在动作过滤器？

Question

我正在尝试测试我的基本控制器是否装饰有某个动作过滤器。因为这个过滤器的构造函数看起来是web.config，所以我第一次尝试测试失败了，因为测试项目没有有效的配置文件。继续前进，我使用了一个TestConfigProvider，将其注入到过滤器构造函数中，但以下测试失败，因为配置提供程序没有传递给构造函数。如果应用了此过滤器，我还能如何测试？

[TestMethod]
public void Base_controller_must_have_MaxLengthFilter_attribute()
{
    var att = typeof(BaseController).GetCustomAttribute<MaxLengthFilter>();
    Assert.IsNotNull(att);
}

Answer 1

也许您可以通过“将文件添加为链接”将有效的配置文件添加到您的测试项目中

Answer 2

最近我在这里有越来越多关于配置“问题”的问题。它们都有一个共同的基础——你有几个项目、服务器、服务需要使用相同的配置。我给你的建议 - 停止使用 Web.config。

将所有配置放入数据库！ 添加一个包含所有配置键和值的表（或多个表），并在应用程序启动时读取它们（global.asax）。

这样您就不必担心将配置应用于每个项目或将其注入不同的构造函数。

Answer 3

好吧，您已经迈出了良好的第一步，认识到 Web.config 只是另一个依赖项并将其包装到 ConfigProvider 中进行注入是一个很好的解决方案。

但是，您遇到了 MVC 的设计问题之一 - 即，要对 DI 友好，属性应该只提供元数据，但 never actually define behavior。这不是您的测试方法的问题，而是过滤器设计方法的问题。

正如帖子中所指出的，您可以通过将操作过滤器属性分成两部分来解决此问题。

1. 一个不包含任何行为来标记您的控制器和操作方法的属性。
2. 实现IActionFilter 并包含所需行为的DI 友好类。

方法是使用 IActionFilter 来测试属性是否存在，然后执行所需的行为。动作过滤器可以提供所有依赖项，然后在组合应用程序时注入。

IConfigProvider provider = new WebConfigProvider();
IActionFilter filter = new MaxLengthActionFilter(provider);
GlobalFilters.Filters.Add(filter);

注意：如果您需要过滤器的任何依赖项的生命周期短于单例，您将需要使用GlobalFilterProvider，如this answer。

MaxLengthActionFilter 的实现如下所示：

public class MaxLengthActionFilter : IActionFilter
{
    public readonly IConfigProvider configProvider;

    public MaxLengthActionFilter(IConfigProvider configProvider)
    {
        if (configProvider == null)
            throw new ArgumentNullException("configProvider");
        this.configProvider = configProvider;
    }

    public void OnActionExecuted(ActionExecutedContext filterContext)
    {
        var attribute = this.GetMaxLengthAttribute(filterContext.ActionDescriptor);
        if (attribute != null)
        {
            var maxLength = attribute.MaxLength;

            // Execute your behavior here, and use the configProvider as needed
        }
    }

    public void OnActionExecuting(ActionExecutingContext filterContext)
    {
        var attribute = this.GetMaxLengthAttribute(filterContext.ActionDescriptor);
        if (attribute != null)
        {
            var maxLength = attribute.MaxLength;

            // Execute your behavior here, and use the configProvider as needed
        }
    }

    public MaxLengthAttribute GetMaxLengthAttribute(ActionDescriptor actionDescriptor)
    {
        MaxLengthAttribute result = null;

        // Check if the attribute exists on the controller
        result = (MaxLengthAttribute)actionDescriptor
            .ControllerDescriptor
            .GetCustomAttributes(typeof(MaxLengthAttribute), false)
            .SingleOrDefault();

        if (result != null)
        {
            return result;
        }

        // NOTE: You might need some additional logic to determine 
        // which attribute applies (or both apply)

        // Check if the attribute exists on the action method
        result = (MaxLengthAttribute)actionDescriptor
            .GetCustomAttributes(typeof(MaxLengthAttribute), false)
            .SingleOrDefault();

        return result;
    }
}

而且，您的属性不应包含任何行为应该如下所示：

// This attribute should contain no behavior. No behavior, nothing needs to be injected.
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false)]
public class MaxLengthAttribute : Attribute
{
    public MaxLengthAttribute(int maxLength)
    {
        this.MaxLength = maxLength;
    }

    public int MaxLength { get; private set; }
}

采用更松散耦合的设计，测试属性是否存在更加直接。

[TestMethod]
public void Base_controller_must_have_MaxLengthFilter_attribute()
{
    var att = typeof(BaseController).GetCustomAttribute<MaxLengthAttribute>();
    Assert.IsNotNull(att);
}