什么是AspectCore Project ?

来源:这里教程网 时间:2026-02-21 14:56:38 作者:

什么是aspectcore project ?

aspectcore project 是适用于asp.net core 平台的轻量级 aop(aspect-oriented programming) 解决方案,它更好的遵循asp.net core的模块化开发理念,使用aspectcore可以更容易构建低耦合、易扩展的web应用程序。aspectcore使用emit实现高效的动态代理从而不依赖任何第三方aop库。

开使使用AspectCore

启动 Visual Studio。从 File 菜单, 选择 New > Project。选择 ASP.NET Core Web Application 项目模版,创建新的 ASP.NET Core Web Application 项目。

从 Nuget 安装

AspectCore.Extensions.DependencyInjection
package:

PM>   Install-Package AspectCore.Extensions.DependencyInjection

在一般情况下可以使用抽象的

InterceptorAttribute
自定义特性类,它实现
IInterceptor
接口。AspectCore默认实现了基于
Attribute
的拦截器配置。我们的自定义拦截器看起来像下面这样:

public class CustomInterceptorAttribute : InterceptorAttribute
{
    public async override Task Invoke(IAspectContext context, AspectDelegate next)
    {
        try
        {
            Console.WriteLine("Before service call");
            await next(context);
        }
        catch (Exception)
        {
            Console.WriteLine("Service threw an exception!");
            throw;
        }
        finally
        {
            Console.WriteLine("After service call");
        }
     }
 }

定义

ICustomService
接口和它的实现类
CustomService
:

public interface ICustomService
{
    [CustomInterceptor]
    void Call();
}
public class CustomService : ICustomService
{
    public void Call()
    {
        Console.WriteLine("service calling...");
    }
}

HomeController
中注入
ICustomService
:

public class HomeController : Controller
{
    private readonly ICustomService _service;
    public HomeController(ICustomService service)
    {
        _service = service;
    }
    public IActionResult Index()
    {
        _service.Call();
        return View();
    }
}

注册

ICustomService
,接着,在
ConfigureServices
中配置创建代理类型的容器:

public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.AddTransient<ICustomService, CustomService>();
    services.AddMvc();
    services.AddAspectCore();
    return services.BuildAspectCoreServiceProvider();
}

拦截器配置。首先安装

AspectCore.Extensions.Configuration
package:

PM> Install-Package AspectCore.Extensions.Configuration

全局拦截器。使用

AddAspectCore(Action<aspectcoreoptions>)</aspectcoreoptions>
的重载方法,其中
AspectCoreOptions
提供
InterceptorFactories
注册全局拦截器:

 services.AddAspectCore(config =>
 {
      config.InterceptorFactories.AddTyped<CustomInterceptorAttribute>();
 });

带构造器参数的全局拦截器,在

CustomInterceptorAttribute
中添加带参数的构造器:

public class CustomInterceptorAttribute : InterceptorAttribute
{
    private readonly string _name;
    public CustomInterceptorAttribute(string name)
    {
        _name = name;
    }
    public async override Task Invoke(AspectContext context, AspectDelegate next)
    {
        try
        {
            Console.WriteLine("Before service call");
            await next(context);
        }
        catch (Exception)
        {
            Console.WriteLine("Service threw an exception!");
            throw;
        }
        finally
        {
            Console.WriteLine("After service call");
        }
    }
}

修改全局拦截器注册:

services.AddAspectCore(config =>
{
     config.InterceptorFactories.AddTyped<CustomInterceptorAttribute>(args: new object[] { "custom" });
});

作为服务的全局拦截器。在

ConfigureServices
中添加:

services.AddTransient<CustomInterceptorAttribute>(provider => new CustomInterceptorAttribute("service"));

修改全局拦截器注册:

services.AddAspectCore(config =>
{
    config.InterceptorFactories.AddServiced<CustomInterceptorAttribute>();
});

作用于特定

Service
Method
的全局拦截器,下面的代码演示了作用于带有
Service
后缀的类的全局拦截器:

services.AddAspectCore(config =>
{
    config.InterceptorFactories.AddTyped<CustomInterceptorAttribute>(method => method.DeclaringType.Name.EndsWith("Service"));
});

使用通配符的特定全局拦截器:

services.AddAspectCore(config =>
{
    config.InterceptorFactories.AddTyped<CustomInterceptorAttribute>(PredicateFactory.ForService("*Service"));
});

在AspectCore中提供

NonAspectAttribute
来使得
Service
Method
不被代理:

[NonAspect]
public interface ICustomService
{
    void Call();
}

同时支持全局忽略配置,亦支持通配符:

 services.AddAspectCore(config =>
  {
      //App1命名空间下的Service不会被代理
      config.NonAspectOptions.AddNamespace("App1");
      //最后一级为App1的命名空间下的Service不会被代理
      config.NonAspectOptions.AddNamespace("*.App1");
      //ICustomService接口不会被代理
      config.NonAspectOptions.AddService("ICustomService");
      //后缀为Service的接口和类不会被代理
      config.NonAspectOptions.AddService("*Service");
      //命名为Query的方法不会被代理
      config.NonAspectOptions.AddMethod("Query");
      //后缀为Query的方法不会被代理
      config.NonAspectOptions.AddMethod("*Query");
  });

拦截器中的依赖注入。在拦截器中支持属性注入,构造器注入和服务定位器模式。
属性注入,在拦截器中拥有

public get and set
权限的属性标记
[AspectCore.Abstractions.FromServices]
(区别于
Microsoft.AspNetCore.Mvc.FromServices
)特性,即可自动注入该属性,如:

public class CustomInterceptorAttribute : InterceptorAttribute
{
    [AspectCore.Abstractions.FromServices]
    public ILogger<CustomInterceptorAttribute> Logger { get; set; }

    public override Task Invoke(AspectContext context, AspectDelegate next)
    {
        Logger.LogInformation("call interceptor");
        return next(context);
    }
}

构造器注入需要使拦截器作为

Service
,除全局拦截器外,仍可使用
ServiceInterceptor
使拦截器从DI中激活:

public interface ICustomService
{
    [ServiceInterceptor(typeof(CustomInterceptorAttribute))]
    void Call();
}

服务定位器模式。拦截器上下文

AspectContext
可以获取当前Scoped的
ServiceProvider

public class CustomInterceptorAttribute : InterceptorAttribute
{
    public override Task Invoke(AspectContext context, AspectDelegate next)
    {
        var logger = context.ServiceProvider.GetService<ILogger<CustomInterceptorAttribute>>();
        logger.LogInformation("call interceptor");
        return next(context);
    }
}

使用

Autofac
AspectCore
。AspectCore原生支持集成Autofac,我们需要安装下面两个nuget packages:

PM> Install-Package Autofac.Extensions.DependencyInjection
PM> Install-Package AspectCore.Extensions.Autofac

AspectCore提供

RegisterAspectCore
扩展方法在Autofac的
Container
中注册动态代理需要的服务,并提供
AsInterfacesProxy
AsClassProxy
扩展方法启用interface和class的代理。修改
ConfigureServices
方法为:

public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    var container = new ContainerBuilder();
    container.RegisterAspectCore();
    container.Populate(services);
    container.RegisterType<CustomService>().As<ICustomService>().InstancePerDependency().AsInterfacesProxy();
    return new AutofacServiceProvider(container.Build());
}

有问题反馈

如果您有任何问题,请提交 Issue 给我们。
AspectCore Project 项目地址:

最后。。。

正在找工作,欢迎推荐.NET/.NET Core后端开发职位,坐标上海,可私信或Email。

相关推荐