Postsharp基本用法——方法、属性拦截与异常处理

以下Demo代码基于 .NET Core 演示了Postsharp的基本使用方法，稍作修改（反射部分有些许差异）也适用于.NET Framework。

更多高级使用方法详见官方文档。http://samples.postsharp.net/

 

代码（注意，这段代码编译后会有警告，解决方案见文末）：

using System;
using System.Linq;
using PostSharp.Aspects;
using PostSharp.Serialization;

namespace NetCoreConsole
{
  class Program
  {
    static void Main(string[] args)
    {
      var result = Calc(5, 6);
      Console.WriteLine($"计算结果：{result}");
      Console.WriteLine(">>>>>>>>>>>>>>方法拦截测试完毕\r\n");


      PropertyTest = -1;
      Console.WriteLine(">>>>>>>>>>>>>>属性拦截测试(setter)完毕\r\n");


      var x = PropertyTest;
      Console.WriteLine(">>>>>>>>>>>>>>属性拦截测试(getter)完毕\r\n");

      Console.ReadKey();
    }


    /// <summary>
    /// 方法拦截测试 + 异常处理
    /// </summary>
    /// <param name="x"></param>
    /// <param name="y"></param>
    /// <returns></returns>
    [HowToUse, ExceptionHandle]
    private static int Calc(int x, int y)
    {
      int a = 1;
      int b = 0;
      int c = a / b;

      return x + y;
    }

    private static int _propertyTest;

    /// <summary>
    /// 属性拦截测试
    /// 注：可以标记在整个属性上，也可以分别单独标记在 【getter】 或者 【setter】 上
    /// </summary>
    [HowToUse, ExceptionHandle]
    private static int PropertyTest
    {

      get
      {
        return _propertyTest;
      }

      // [HowToUse]
      set
      {
        if (value <= 0)
        {
          throw new ArgumentException($"属性值必须大于0");
        }

        _propertyTest = value;
      }
    }
  }
}

/// <summary>
/// 方法拦截测试
/// </summary>
[PSerializable]
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Property)]
public class HowToUseAttribute : MethodInterceptionAspect
{
  /// <summary>
  /// 方法执行拦截
  /// </summary>
  /// <param name="args"></param>
  public override void OnInvoke(MethodInterceptionArgs args)
  {
    var methodBase = args.Method;

    // 如果是 .NET Framework 这里的System.Reflection.MethodInfo 应该替换为 System.Reflection.RuntimeMethodInfo
    var returnType = ((System.Reflection.MethodInfo)methodBase).ReturnType.FullName;
     
    // 方法形式参数列表字符
    var paramListString = methodBase.GetParameters().Aggregate(string.Empty,
      (current, parameter) => current + $"{parameter.ParameterType.FullName} {parameter.Name}, ").Trim(',', ' ');

    // 方法签名
    // var signatures =  $"{returnType} {methodBase.Name}（{paramListString}）";
    var signatures = methodBase.ToString();

    Console.WriteLine($"被拦截的方法签名：{signatures}");

    // 方法实际参数列表字符
    var argsString = args.Arguments
      .Aggregate(string.Empty, (current, p) => current + $"{p.GetType().FullName} ---> 值：{p}, ").Trim(',', ' ');

    Console.WriteLine($"被拦截的方法输入参数：{argsString}");

    // 处理(执行被拦截的方法)
    args.Proceed();

    // 异步执行
    // args.ProceedAsync();

    var returnValue = args.ReturnValue;

    Console.WriteLine($"方法返回值：{returnValue}");
  }
}

/// <summary>
/// 异常处理
/// </summary>
[PSerializable]
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Property)]
public class ExceptionHandleAttribute : OnExceptionAspect
{
  public override void OnException(MethodExecutionArgs args)
  {
    // 设置流程行为（继续执行，不抛出）
    args.FlowBehavior = FlowBehavior.Continue;

    Console.WriteLine($"发生异常:{args.Exception.GetType().FullName} ----> {args.Exception.Message}");
  }
}

 

这段代码可以正常编译，但会有警告。警告内容类似下图：

 

　　　　　　　　　　　　（图1）

 

大意就是说在我们的 Calc方法上存在冲突的切面。

为什么会产生这样的警告呢，因为我们使用了两个类型的Aspect，一个是异常处理，一个是方法拦截（属性也可以认为是Getter和Setter两个方法的结合）。 

异常处理切面（Aspect）期望包装我们的目标方法，方法拦截切面（Aspect）也是如此，但是这两个切面并不是强排序的，它们的执行顺序并不确定，这就是冲突。解决方法很简单，请对比图2与图3中代码的区别：

　　　　　　　　　　　　　　（图2）

 

　　　　　　　　　　　　　　　（图3）

 

 

没错，解决方法就是使用 [  AspectPriority  ]属性手动指定切面的优先顺序。属性值是Int类型，可以随意设置，值越小优先级越高，只要让引擎能从数字层面区分优先顺序即可。

另外，切面的优先顺序不一样，引擎最终编译出来的代码也是不一样的，具体可以反编译查看。不管谁先执行谁后执行，总的来说结果没什么变化的。我个人更喜欢将异常处理切面优先级提高些，这样更加符合平时手写代码的风格。