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類型，可以隨意設置，值越小優先級越高，只要讓引擎能從數字層面區分優先順序即可。

另外，切面的優先順序不一樣，引擎最終編譯出來的代碼也是不一樣的，具體可以反編譯查看。不管誰先執行誰后執行，總的來說結果沒什么變化的。我個人更喜歡將異常處理切面優先級提高些，這樣更加符合平時手寫代碼的風格。