前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >ASP.NET Core如何在ActionFilterAttribute里做依赖注入

ASP.NET Core如何在ActionFilterAttribute里做依赖注入

作者头像
Edi Wang
发布2019-07-08 19:39:33
1.4K0
发布2019-07-08 19:39:33
举报
文章被收录于专栏:汪宇杰博客

在ASP.NET Core里,我们可以使用构造函数注入很方便地对Controller,ViewComponent等部件做依赖注入。但是如何给过滤器ActionFilterAttribute也用上构造函数注入呢?

问题

我的博客系统里有个用来删除订阅文件缓存的ActionFilter,想要在发生异常的时候记录日志。我的博客用的日志组件是NLog,因此不使用依赖注入的话,就直接使用LogManager.GetCurrentClassLogger()获得一个Logger的实例。整个过滤器的代码如下:

代码语言:javascript
复制
public class DeleteSubscriptionCache : ActionFilterAttribute
{
 private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
    public override void OnActionExecuted(ActionExecutedContext context)
    {
        base.OnActionExecuted(context);
        DeleteSubscriptionFiles();
    }
    private void DeleteSubscriptionFiles()
    {
        try
        {
            // ...
        }
        catch (Exception e)
        {
 Logger.Error(e, "Error Delete Subscription Files");
        }
    }
}

然后在Action上去使用,和经典的ASP.NET MVC一样

代码语言:javascript
复制
[Authorize]
[HttpPost, ValidateAntiForgeryToken, DeleteSubscriptionCache]
[Route("manage/edit")]
public IActionResult Edit(PostEditModel model)

这当然可以没有问题的运行,但写代码最重要的就是逼格,这个代码耦合了NLog,而我的博客系统里其他地方早就在用ASP.NET Core的ILogger接口了。如果哪天日志组件不再用NLog了,那么这个地方的代码就得改,而使用ILogger接口的代码就不需要动。虽然这种情况是绝对不会发生的,但是写代码一定要有追求,尽可能过度设计,才能不被人鄙视,然后才能面试造航母,工作拧螺丝。因此我决定把日志组件用依赖注入的方式安排一下。

改造过滤器

方法和在Controller中使用依赖注入完全一样,我们使用构造函数注入ILogger<DeleteSubscriptionCache>类型。于是代码变成了这样:

代码语言:javascript
复制
public class DeleteSubscriptionCache : ActionFilterAttribute
{
 protected readonly ILogger<DeleteSubscriptionCache> Logger;
    public DeleteSubscriptionCache(ILogger<DeleteSubscriptionCache> logger)
    {
        Logger = logger;
    }
    public override void OnActionExecuted(ActionExecutedContext context)
    {
        base.OnActionExecuted(context);
        DeleteSubscriptionFiles();
    }
    private void DeleteSubscriptionFiles()
    {
        try
        {
            // ...
        }
        catch (Exception e)
        {
            Logger.LogError(e, "Error Delete Subscription Files");
        }
    }
}

但是问题来了,这样的话我们是没法在Action上无脑使用了,因为构造函数要求传参。如果要自己new一个的话,装逼就失败了。我们来看看正确的解决方法~

ServiceFilter

其实ASP.NET Core里,我们可以使用ServiceFilter来完成这个需求。它也是一种Attribute,可以作用在Action上。位于Microsoft.AspNetCore.Mvc.Core程序集里,定义如下:

代码语言:javascript
复制
// A filter that finds another filter in an System.IServiceProvider.
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public class ServiceFilterAttribute : Attribute, IFilterFactory, IFilterMetadata, IOrderedFilter
{
        public ServiceFilterAttribute(Type type);
        public int Order { get; set; }
        public Type ServiceType { get; }
        public bool IsReusable { get; set; }
        public IFilterMetadata CreateInstance(IServiceProvider serviceProvider);
}

ServiceFilter允许我们解析一个已经添加到IoC容器里的服务,因此我们需要把DeleteSubscriptionCache注册一下:

代码语言:javascript
复制
services.AddScoped<DeleteSubscriptionCache>();

然后就能直接使用了:

代码语言:javascript
复制
[Authorize]
[HttpPost, ValidateAntiForgeryToken]
[ServiceFilter(typeof(DeleteSubscriptionCache))]
[Route("manage/edit")]
public IActionResult Edit(PostEditModel model)

运行时发现ILogger已经能被实例化了,完美!

参考资料:

https://stackoverflow.com/questions/36109052/inject-service-into-action-filter/36109690

https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-2.2

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-01-20,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 汪宇杰博客 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
容器服务
腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档