- 1,快速入門
- 1.1 繼承 ActionAttribute 特性
- 1.2 標記代理類型
- 2，如何創建代理類型
- 2.1 通過API直接創建
- 2,創建代理類型
- 通過API
- 通過 Microsoft.Extensions.DependencyInjection
- 通過 Autofac
- 3,深入使用
- 代理類型
- 方法、屬性代理
- 上下文
- 攔截方法或屬性的參數
- 非侵入式代理
Nuget 庫地址：https://www.nuget.org/packages/CZGL.AOP/
Github 庫地址：https://github.com/whuanle/CZGL.AOP
CZGL.AOP 是 基於 EMIT 編寫的 一個簡單輕量的AOP框架，支持非侵入式代理，支持.NET Core/ASP.NET Core，以及支持多種依賴注入框架。
1,快速入門
CZGL.AOP 使用比較簡單，你只需要使用 [Interceptor] 特性標記需要代理的類型，然後使用繼承 ActionAttribute 的特性標記要被代理的方法或屬性。
1.1 繼承 ActionAttribute 特性
ActionAttribute 是用於代理方法或屬性的特性標記，不能直接使用，需要繼承后重寫方法。
示例如下：
public class LogAttribute : ActionAttribute
{
public override void Before(AspectContext context)
{
Console.WriteLine("執行前");
}
public override object After(AspectContext context)
{
Console.WriteLine("執行后");
if (context.IsMethod)
return context.MethodResult;
else if (context.IsProperty)
return context.PropertyValue;
return null;
}
}
Before 會在被代理的方法執行前或被代理的屬性調用時生效，你可以通過 AspectContext 上下文，獲取、修改傳遞的參數。
After 在方法執行后或屬性調用時生效，你可以通過上下文獲取、修改返回值。
1.2 標記代理類型
在被代理的類型中，使用 [Interceptor] 特性來標記，在需要代理的方法中，使用 繼承了 ActionAttribute 的特性來標記。
此方法是侵入式的，需要在編譯前完成。
[Interceptor]
public class Test : ITest
{
[Log] public virtual string A { get; set; }
[Log]
public virtual void MyMethod()
{
Console.WriteLine("運行中");
}
}
注意的是，一個方法或屬性只能設置一個攔截器。
2，如何創建代理類型
CZGL.AOP 有多種生成代理類型的方式，下面介紹簡單的方式。
請預先創建如下代碼：
public class LogAttribute : ActionAttribute
{
public override void Before(AspectContext context)
{
Console.WriteLine("執行前");
}
public override object After(AspectContext context)
{
Console.WriteLine("執行后");
if (context.IsMethod)
return context.MethodResult;
else if (context.IsProperty)
return context.PropertyValue;
return null;
}
}
public interface ITest
{
void MyMethod();
}
[Interceptor]
public class Test : ITest
{
[Log] public virtual string A { get; set; }
public Test()
{
Console.WriteLine("構造函數沒問題");
}
[Log]
public virtual void MyMethod()
{
Console.WriteLine("運行中");
}
}
2.1 通過API直接創建
通過 CZGL.AOP 中的 AopInterceptor 類，你可以生成代理類型。
示例如下：
ITest test1 = AopInterceptor.CreateProxyOfInterface<ITest, Test>();
Test test2 = AopInterceptor.CreateProxyOfClass<Test>();
test1.MyMethod();
test2.MyMethod();
CreateProxyOfInterface 通過接口創建代理類型；CreateProxyOfClass 通過類創建代理類型；
默認調用的是無參構造函數。
2,創建代理類型
通過API
你可以參考源碼解決方案
中的 ExampleConsole 項目。
如果要直接使用 AopInterceptor.CreateProxyOfInterface 和 AopInterceptor.CreateProxyOfClass 方法，通過接口或類來創建代理類型。
ITest test1 = AopInterceptor.CreateProxyOfInterface<ITest, Test>();
Test test2 = AopInterceptor.CreateProxyOfClass<Test>();
如果要指定實例化的構造函數，可以這樣：
// 指定構造函數
test2 = AopInterceptor.CreateProxyOfClass<Test>("aaa", "bbb");
test2.MyMethod();
通過 Microsoft.Extensions.DependencyInjection
Microsoft.Extensions.DependencyInjection 是 .NET Core/ASP.NET Core 默認的依賴注入容器。
如果需要支持 ASP.NET Core 中使用 AOP，你可以在 Nuget 包中安裝 CZGL.AOP.MEDI。
如果你在控制台下使用 Microsoft.Extensions.DependencyInjection，你可以使用名為 BuildAopProxy 的 IServiceCollection 拓展方法來為容器中的類型，生成代理類型。
示例如下：
IServiceCollection _services = new ServiceCollection();
_services.AddTransient<ITest, Test>();
var serviceProvider = _services.BuildAopProxy().BuildServiceProvider();
serviceProvider.GetService<ITest>();
return serviceProvider;
你可以參考源碼解決方案中的 ExampleMEDI 項目。
如果你要在 ASP.NET Core 中使用，你可以在 Startup 中，ConfigureServices 方法的最後一行代碼使用 services.BuildAopProxy(); 。
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.BuildAopProxy();
}
還可以在 Program 的 IHostBuilder 中使用 .UseServiceProviderFactory(new AOPServiceProxviderFactory()) 來配置使用 CZGL.AOP。
示例：
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.UseServiceProviderFactory(new AOPServiceProxviderFactory())
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});
可以參考解決方案中的 ExampleConsole 和 ExampleWebMEDI 兩個項目。
你不必擔心引入 CZGL.AOP 后，使用依賴注入會使程序變慢或者破壞容器中的原有屬性。CZGL.AOP 只會在創建容器時處理需要被代理的類型，不會影響容器中的服務，也不會幹擾到依賴注入的執行。
通過 Autofac
如果需要在 Autofac 中使用 AOP，則需要引用 CZGL.AOP.Autofac 包。
如果你在控制台程序中使用 Autofac，則可以在 Build() 後面使用 BuildAopProxy()。
ContainerBuilder builder = new ContainerBuilder();
builder.RegisterType<Test>().As<ITest>();
var container = builder.Build().BuildAopProxy();
using (ILifetimeScope scope = container.BeginLifetimeScope())
{
// 獲取實例
ITest myService = scope.Resolve<ITest>();
myService.MyMethod();
}
Console.ReadKey();
}
要注意的是，在已經完成的組件註冊創建一個新的容器后，才能調用 BuildAopProxy() 方法，
這樣針對一個新的容器你可以考慮是否需要對容器中的組件進行代理。
如果在 ASP.NET Core 中使用 Autofac，你需要在 Program 類的 IHostBuilder 中使用：
.UseServiceProviderFactory(new AutofacServiceProviderFactory())
如果需要代理已經註冊的組件，則將其替換為：
.UseServiceProviderFactory(new CZGL.AOP.Autofac.AOPServiceProxviderFactory())
請參考 源碼解決方案中的 ExampleAutofac 和 ExampleWebAutofac 兩個項目。
3,深入使用
代理類型
要被代理的類型，需要使用 [Interceptor]來標記，例如：
[Interceptor]
public class Test : ITest
{
}
支持泛型類型。
被代理的類型必須是可被繼承的。
類型的構造函數沒有限制，你可以隨意編寫。
在使用 API 創建代理類型並且實例化時，你可以指定使用哪個構造函數。
例如：
string a="",b="",c="";
ITest test1 = AopInterceptor.CreateProxyOfInterface<ITest, Test>(a,b,c);
API 會根據參數的多少以及參數的類型自動尋找合適的構造函數。
方法、屬性代理
為了代理方法或屬性，你需要繼承 ActionAttribute 特性，然後為方法或屬性標記此特性，並且將方法或屬性設置為 virtual
一個類型中的不同方法，可以使用不同的攔截器。
[Log1]
public virtual void MyMethod1(){}
[Log2]
public virtual void MyMethod2(){}
對於屬性，可以在屬性上直接使用特性，或者只在 get 或 set 構造器使用。
[Log] public virtual string A { get; set; }
// 或
public virtual string A { [Log] get; set; }
// 或
public virtual string A { get; [Log] set; }
如果在屬性上使用特性，相當於 [Log] get; [Log] set;。
上下文
一個簡單的方法或屬性攔截標記是這樣的：
public class LogAttribute : ActionAttribute
{
public override void Before(AspectContext context)
{
Console.WriteLine("執行前");
}
public override object After(AspectContext context)
{
Console.WriteLine("執行后");
if (context.IsMethod)
return context.MethodResult;
else if (context.IsProperty)
return context.PropertyValue;
return null;
}
}
AspectContext 的屬性說明如下：
| 字段 | 說明 |
|---|---|
| Type | 當前被代理類型生成的代理類型 |
| ConstructorParamters | 類型被實例化時使用的構造函數的參數，如果構造函數沒有參數，則 MethodValues.Length = 0，而不是 MethodValues 為 null。 |
| IsProperty | 當前攔截的是屬性 |
| PropertyInfo | 當前被執行的屬性的信息，可為 null。 |
| PropertyValue | 但調用的是屬性時，返回 get 的結果或 set 的 value 值。 |
| IsMethod | 當前攔截的是方法 |
| MethodInfo | 當前方法的信息 |
| MethodValues | 方法被調用時傳遞的參數，如果此方法沒有參數，則 MethodValues.Length = 0，而不是 MethodValues 為 null |
| MethodResult | 方法執行返回的結果(如果有) |
攔截方法或屬性的參數
通過上下文，你可以修改方法或屬性的參數以及攔截返回結果：
public class LogAttribute : ActionAttribute
{
public override void Before(AspectContext context)
{
// 攔截並修改方法的參數
for (int i = 0; i < context.MethodValues.Length; i++)
{
context.MethodValues[i] = (int)context.MethodValues[i] + 1;
}
Console.WriteLine("執行前");
}
public override object After(AspectContext context)
{
Console.WriteLine("執行后");
// 攔截方法的執行結果
context.MethodResult = (int)context.MethodResult + 664;
if (context.IsMethod)
return context.MethodResult;
else if (context.IsProperty)
return context.PropertyValue;
return null;
}
}
[Interceptor]
public class Test
{
[Log]
public virtual int Sum(int a, int b)
{
Console.WriteLine("運行中");
return a + b;
}
}
Test test = AopInterceptor.CreateProxyOfClass<Test>();
Console.WriteLine(test.Sum(1, 1));
方法的參數支持 in、ref、out；支持泛型方法泛型屬性；支持異步方法；
非侵入式代理
此種方式不需要改動被代理的類型，你也可以代理程序集中的類型。
public class LogAttribute : ActionAttribute
{
public override void Before(AspectContext context)
{
Console.WriteLine("執行前");
}
public override object After(AspectContext context)
{
Console.WriteLine("執行后");
if (context.IsMethod)
return context.MethodResult;
else if (context.IsProperty)
return context.PropertyValue;
return null;
}
}
public class TestNo
{
public virtual string A { get; set; }
public virtual void MyMethod()
{
Console.WriteLine("運行中");
}
}
TestNo test3 = AopInterceptor.CreateProxyOfType<TestNo>(new ProxyTypeBuilder()
.AddProxyMethod(typeof(LogAttribute), typeof(TestNo).GetMethod(nameof(TestNo.MyMethod)))
.AddProxyMethod(typeof(LogAttribute), typeof(TestNo).GetProperty(nameof(TestNo.A)).GetSetMethod()));
通過 ProxyTypeBuilder 來構建代理類型。
代理方法或屬性都是使用 AddProxyMethod，第一個參數是要使用的攔截器，第二個參數是要攔截的方法。
如果要攔截屬性，請分開設置屬性的 get、set 構造。
如果多個方法或屬性使用同一個攔截器，則可以這樣：
TestNo test3 = AopInterceptor.CreateProxyOfType<TestNo>(
new ProxyTypeBuilder(new Type[] { typeof(LogAttribute) })
.AddProxyMethod("LogAttribute", typeof(TestNo).GetMethod(nameof(TestNo.MyMethod)))
.AddProxyMethod("LogAttribute", typeof(TestNo).GetProperty(nameof(TestNo.A)).GetSetMethod()));
TestNo test3 = AopInterceptor.CreateProxyOfType<TestNo>(
new ProxyTypeBuilder(new Type[] { typeof(LogAttribute) })
.AddProxyMethod("LogAttribute", typeof(TestNo).GetMethod(nameof(TestNo.MyMethod)))
.AddProxyMethod(typeof(LogAttribute2), typeof(TestNo).GetProperty(nameof(TestNo.A)).GetSetMethod()));
在構造函數中傳遞過去所需要的攔截器，然後在攔截時使用。
本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理【其他文章推薦】
※為什麼 USB CONNECTOR 是電子產業重要的元件?
※網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!
※台北網頁設計公司全省服務真心推薦
※想知道最厲害的網頁設計公司"嚨底家"!
※推薦評價好的iphone維修中心
Orignal From: 菜渣開源一個基於 EMIT 的 AOP 庫(.NET Core)
留言
張貼留言