ASP.NET Boilerplate 中的面向切面编程（AOP）与拦截器实践指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00671/article/details/148393491

ASP.NET Boilerplate 中的面向切面编程（AOP）与拦截器实践指南

aspnetboilerplate aspnetboilerplate: 是一个开源的 ASP.NET Core 应用程序框架，提供了各种开箱即用的功能和模块，方便开发者构建可扩展和可维护的 Web 应用程序。适合开发者使用 ASP.NET Core 构建企业级 Web 应用程序。项目地址: https://gitcode.com/gh_mirrors/as/aspnetboilerplate

什么是面向切面编程（AOP）？

面向切面编程（AOP）是一种编程范式，它通过将横切关注点（如日志记录、授权、验证等）与核心业务逻辑分离来提高代码的模块化程度。在ASP.NET Boilerplate框架中，AOP主要通过方法拦截器（Interceptors）来实现。

传统方式 vs AOP方式

传统实现方式的问题

在没有使用AOP的传统方式中，我们经常会在业务方法中混杂各种非核心逻辑：

public void CreateTask(CreateTaskInput input)
{
    // 日志记录
    _logger.Debug("Running CreateTask method...");
    
    try
    {
        // 参数验证
        if (input == null) throw new ArgumentNullException();
        
        // 权限检查
        if (!_permissionChecker.IsGranted("TaskCreationPermission"))
            throw new Exception("No permission!");
            
        // 核心业务逻辑
        _taskRepository.Insert(new Task(...));
    }
    catch (Exception ex)
    {
        // 异常处理
        _logger.Error(ex.Message, ex);
        throw;
    }
    
    // 更多日志记录
    _logger.Debug("CreateTask completed!");
}

这种方式会导致：

代码重复率高
业务逻辑不清晰
维护困难

AOP方式的优势

使用AOP后，同样的功能可以简化为：

[AbpAuthorize("TaskCreationPermission")]
public void CreateTask(CreateTaskInput input)
{
    // 纯粹的业务逻辑
    _taskRepository.Insert(new Task(...));
}

ASP.NET Boilerplate已经内置了许多常用的AOP功能，如：

自动参数验证
异常处理
审计日志
授权检查

创建自定义拦截器

当我们需要实现特定于应用的横切关注点时，可以创建自定义拦截器。下面是一个测量方法执行时间的拦截器示例：

public class MeasureDurationInterceptor : AbpInterceptorBase, ITransientDependency
{
    public ILogger Logger { get; set; }

    public MeasureDurationInterceptor()
    {
        Logger = NullLogger.Instance;
    }

    public override void InterceptSynchronous(IInvocation invocation)
    {
        var stopwatch = Stopwatch.StartNew();
       
        // 执行实际方法
        invocation.Proceed();
       
        stopwatch.Stop();
        Logger.Info($"方法 {invocation.Method.Name} 执行耗时: {stopwatch.Elapsed.TotalMilliseconds} ms");
    }
}

关键点说明：

继承AbpInterceptorBase基类
实现ITransientDependency表示这是一个瞬态依赖
通过IInvocation可以获取方法信息、参数等
Proceed()方法执行被拦截的实际方法

注册拦截器

创建拦截器后，需要将其注册到目标类上。以下是注册到所有应用服务的最佳实践：

public static class MeasureDurationInterceptorRegistrar
{
    public static void Initialize(IIocManager iocManager)
    {
        iocManager.IocContainer.Kernel.ComponentRegistered += (key, handler) =>
        {
            if (typeof(IApplicationService).IsAssignableFrom(handler.ComponentModel.Implementation))
            {
                handler.ComponentModel.Interceptors.Add(
                    new InterceptorReference(typeof(AbpAsyncDeterminationInterceptor<MeasureDurationInterceptor>)));
            }
        };
    }
}

然后在模块的PreInitialize方法中调用：

public override void PreInitialize()
{
    MeasureDurationInterceptorRegistrar.Initialize(IocManager);
}

异步方法拦截

拦截异步方法需要特殊处理，因为异步方法会立即返回Task。以下是支持异步的拦截器实现：

protected override async Task InternalInterceptAsynchronous(IInvocation invocation)
{
    var proceedInfo = invocation.CaptureProceedInfo();
    var stopwatch = Stopwatch.StartNew();

    proceedInfo.Invoke();
    var task = (Task)invocation.ReturnValue;
    await task;

    stopwatch.Stop();
    Logger.Info($"异步方法 {invocation.Method.Name} 执行耗时: {stopwatch.Elapsed.TotalMilliseconds} ms");
}

protected override async Task<TResult> InternalInterceptAsynchronous<TResult>(IInvocation invocation)
{
    var proceedInfo = invocation.CaptureProceedInfo();
    var stopwatch = Stopwatch.StartNew();

    proceedInfo.Invoke();
    var taskResult = (Task<TResult>)invocation.ReturnValue;
    var result = await taskResult;

    stopwatch.Stop();
    Logger.Info($"异步方法 {invocation.Method.Name} 执行耗时: {stopwatch.Elapsed.TotalMilliseconds} ms");

    return result;
}