构造函数依赖注入 WebApi 属性

Question

我一直在寻找 WebApi 属性的非参数注入选项。

我的问题很简单，这是否真的可以使用 Structuremap？

我一直在谷歌搜索，但一直想出属性注入（我不喜欢使用）或迄今为止我无法复制的构造函数注入的假定实现。

我选择的容器是 Structuremap，但是任何这样的例子都足够了，因为我能够转换它。

有人成功过吗？

Answer 1

是的，这是可能的。您（像大多数人一样）被 Microsoft 的 Action Filter Attributes 营销所迷惑，这些属性很方便地放在一个 class 中，但对 DI 一点都不友好。

解决方案是将 Action Filter Attribute 分成两部分 as demonstrated in this post:

一个不包含用于标记控制器和操作方法的行为的属性。
实现 IActionFilter 并包含所需行为的 DI 友好 class。

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

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

NOTE: If you need any of the filter's dependencies to have a lifetime shorter than singleton, you will need to use a GlobalFilterProvider as in .

要将其与 StructureMap 连接起来，您需要 return 来自 DI 配置模块的容器实例。 Application_Start 方法仍然是组合根的一部分，因此您可以在该方法内的任何地方使用容器，它仍然不被视为服务定位器模式。请注意，我没有在此处显示完整的 WebApi 设置，因为我假设您已经使用 WebApi 进行了有效的 DI 配置。如果你需要一个，那是另一个问题。

public class DIConfig()
{
    public static IContainer Register()
    {
        // Create the DI container
        var container = new Container();

        // Setup configuration of DI
        container.Configure(r => r.AddRegistry<SomeRegistry>());
        // Add additional registries here...

        #if DEBUG
            container.AssertConfigurationIsValid();
        #endif

        // Return our DI container instance to the composition root
        return container;
    }
}

public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        // Hang on to the container instance so you can resolve
        // instances while still in the composition root
        IContainer container = DIConfig.Register();

        AreaRegistration.RegisterAllAreas();

        // Pass the container so we can resolve our IActionFilter
        WebApiConfig.Register(GlobalConfiguration.Configuration, container);
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
        AuthConfig.RegisterAuth();
    }
}

public static class WebApiConfig
{
    // Add a parameter for IContainer
    public static void Register(HttpConfiguration config, IContainer container)
    {
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        // Uncomment the following line of code to enable query support for actions with an IQueryable or IQueryable<T> return type.
        // To avoid processing unexpected or malicious queries, use the validation settings on QueryableAttribute to validate incoming queries.
        // For more information, visit http://go.microsoft.com/fwlink/?LinkId=279712.
        //config.EnableQuerySupport();

        // Add our action filter
        config.Filters.Add(container.GetInstance<IMaxLengthActionFilter>());
        // Add additional filters here that look for other attributes...
    }
}

MaxLengthActionFilter 的实现看起来像这样：

// Used to uniquely identify the filter in StructureMap
public interface IMaxLengthActionFilter : System.Web.Http.Filters.IActionFilter
{
}

public class MaxLengthActionFitler : IMaxLengthActionFilter
{
    public readonly IConfigProvider configProvider;

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

    public Task<HttpResponseMessage> ExecuteActionFilterAsync(
        HttpActionContext actionContext,
        CancellationToken cancellationToken,
        Func<Task<HttpResponseMessage>> continuation)
    {
        var attribute = this.GetMaxLengthAttribute(filterContext.ActionDescriptor);
        if (attribute != null)
        {
            var maxLength = attribute.MaxLength;
            // Execute your behavior here (before the continuation), 
            // and use the configProvider as needed

            return continuation().ContinueWith(t =>
            {
                // Execute your behavior here (after the continuation), 
                // and use the configProvider as needed

                return t.Result;
            });
        }
        return continuation();
    }

    public bool AllowMultiple
    {
        get { return true; }
    }

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

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

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

        // Check if the attribute exists on the controller
        result = (MaxLengthAttribute)actionDescriptor
            .ControllerDescriptor
            .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; }
}

Answer 2

我在使用自定义操作过滤器提供程序时遇到了困难，但没有让它为我的身份验证属性工作。我还尝试了构造函数和属性注入的各种方法，但没有找到感觉不错的解决方案。

我终于将函数注入到我的属性中。这样，单元测试可以注入一个 returns 伪造或模拟的函数，而应用程序可以注入一个函数来解析与 IoC 容器的依赖关系。

我刚刚在这里写了这个方法：http://danielsaidi.com/blog/2015/09/11/asp-net-and-webapi-attributes-with-structuremap

它在我的项目中非常有效，解决了我在使用其他方法时遇到的所有问题。

构造函数依赖注入 WebApi 属性

Constructor Dependency Injection WebApi Attributes

structuremap

dependency-injection

custom-attributes

asp.net-web-api

structuremap3