学步园

AOP已经不是一个什么新名词了，在博客园使用关键字搜索可以查出n多条关于AOP的介绍，这里就不再赘述了。 </p> <p>在Bruce Zhang's Blog里面有很多关于AOP介绍及其在.net下实现研究，总觉得如果什么都从头来写难免有自造轮子的嫌疑，但是目前也没有很成熟的AOP框架让我们能轻松完成基于AOP架构，不过一直以来都在关注的PostSharp开源项目日趋成熟，目前已发布了PostSharp 1.0 (Beta release 3)。即使如此，也还没能到应用到产品上的时候。 </p> <p>前段时间一直在封装一个权限系统，时常为如何给调用方提供一个良好的编程接口烦恼，加之前前段时间考虑的日志、异常接管、事务、缓存等等一些横向组件的架构分析，自然就想用AOP技术实现，但是由于实现难度实在不小作罢；这两天又重新学习研究了PostSharp的架构与实现思想，觉得还是尝试一下，将其融入现有框架； </p> <p>早在年初就有不少前辈大师就如何使用这个东西撰写过文章，如Q.yuhen的PostSharp - Lightweight Aspect-Oriented System该仁兄下面见解很到位： </p> <p>和以往基于 Dynamic Proxy 方式与 AOP 解决方案做个比较。 </p> <p>由于采用 MSIL Injection，因此静态代码注入的执行效率要高于使用 Reflection Emit。<br /> 使用 MSBuild Task，使得开发人员可以像使用编译器内置 Attribute 那样使用 AOP。<br /> 可以拦截任意方法，而 Dynamic Proxy 方式的 AOP 往往采取继承方式来拦截 Virtual 方法。<br /> 拥有更多的控制权。包括中断执行流程，修改参数和返回值等等。<br /> 还可以拦截 Field Access、Exception 等操作。<br /> 无需将对象创建代码改成 "new proxy()"，更加透明。<br /> 可以使用通配符进行多重拦截匹配。<br /> 静态注入带来的问题更多的是注入代码的质量和调试复杂度。<br /> 另外有一老外的Using AOP and PostSharp to Enhance Your CodeAB两部分，相当精彩，本文就是在参考这两篇好文的基础上做的。 </p> <p>我们假设有这么个场景，其实这也是实际业务中很常见的处理方式：有一定单管理模块，具备新增、删除两功能，我们在新增删除的时候必须校验权限，在删除的时候还必须记录日志，出现异常了还必须捕捉并记录异常； </p> <p>按以前的写法我们可能很麻烦,我们要如此这般的写： </p> <p>public class XOrders<br /> {<br /> public bool Add(string id, string orderName)<br /> {<br /> try<br /> {<br /> if (User.AddEnable)<br /> {<br /> //TODO：新增订单的实现<br /> Console.WriteLine("正在执行新增订单方法的操作，回车继续……");<br /> Console.ReadLine();<br /> Console.WriteLine("您添加订单成功：编号：{0}，名称：{1}", id, orderName);<br /> return true;<br /> }<br /> else<br /> {<br /> //<br /> }<br /> }<br /> catch (Exception)<br /> {<br /> //TODO:记录异常的实现<br /> throw;<br /> } </p> <p> return true; </p> <p> } </p> <p> public bool Delete(string id)<br /> {<br /> try<br /> {<br /> if (User.DeleteEnable)<br /> {<br /> //TODO：删除订单的实现<br /> Console.WriteLine("您删除订单成功：编号：{0}", id);<br /> }<br /> else<br /> {<br /> //<br /> } </p> <p> }<br /> catch (Exception)<br /> {<br /> //TODO:记录异常的实现<br /> throw;<br /> } </p> <p> return true;<br /> } </p> <p>这种写的弊端我就不多说了，有很多先驱都阐述过…… </p> <p>我要演示的是采用AOP技术的框架原型实现： </p> <p>首先我们应该安装PostSharp（一定要安装要不能没办法注入处理代码） </p> <p>然后我们实现Orders对象 </p> <p>using System; </p> <p>namespace PostSharp.Demo<br /> {<br /> public class Orders<br /> {<br /> [Permission]<br /> [Exception]<br /> public bool Add(string id, string orderName)<br /> {<br /> Console.WriteLine("正在执行新增订单方法的操作，回车继续……");<br /> Console.ReadLine();<br /> Console.WriteLine("您添加订单成功：编号：{0}，名称：{1}", id, orderName);<br /> return true;<br /> } </p> <p> [Logger]<br /> [Permission]<br /> [Exception]<br /> public bool Delete(string id)<br /> {<br /> Console.WriteLine("您删除订单成功：编号：{0}", id); </p> <p> return true;<br /> }<br /> }<br /> } </p> <p>当然还要模拟一个用户资格认证 </p> <p>namespace PostSharp.Demo<br /> {<br /> /// <summary><br /> /// 静态的用户对象，用于存放当前登录用户，成员资格<br /> /// </summary><br /> public static class User<br /> {<br /> private static string _userId; </p> <p> public static string UserId<br /> {<br /> get { return _userId; }<br /> set { _userId = value; }<br /> } </p> <p> public static bool AddEnable<br /> {<br /> get<br /> {<br /> return (_userId.ToLower() == "admin");<br /> }<br /> } </p> <p> public static bool DeleteEnable<br /> {<br /> get<br /> {<br /> return (_userId.ToLower() == "admin");<br /> }<br /> }<br /> }<br /> } </p> <p>再然后我们实现权限控制方面PermissionAttribute，日志方面LoggerAttribute，异常处理方面ExceptionAttribute…… </p> <p>PermissionAttribute </p> <p>using System;<br /> using PostSharp.Laos; </p> <p>namespace PostSharp.Demo<br /> {<br /> [Serializable]<br /> [global::System.AttributeUsage(AttributeTargets.All, Inherited = true, AllowMultiple = false)]<br /> public class PermissionAttribute : OnMethodBoundaryAspect<br /> {<br /> public override void OnEntry(MethodExecutionEventArgs eventArgs)<br /> {<br /> if (!User.AddEnable)<br /> {<br /> Console.WriteLine("用户：【{0}】没有权限：【{1}】", User.UserId, eventArgs.Method);<br /> eventArgs.FlowBehavior = FlowBehavior.Return;<br /> } </p> <p> }<br /> }<br /> } </p> <p>LoggerAttribute </p> <p>using System;<br /> using PostSharp.Laos; </p> <p>namespace PostSharp.Demo<br /> {<br /> [Serializable]<br /> [global::System.AttributeUsage(AttributeTargets.All, Inherited = true, AllowMultiple = false)]<br /> public sealed class LoggerAttribute : OnMethodInvocationAspect<br /> {<br /> public override void OnInvocation(MethodInvocationEventArgs eventArgs)<br /> {<br /> DateTime time = DateTime.Now;<br /> string log = "时间:{0},操作人员:{1},操作:{2}!"; </p> <p> object[] arg = eventArgs.GetArguments(); </p> <p> log = String.Format(log, time, User.UserId, "删除Id为" + arg[0].ToString() + "的订单！"); </p> <p> System.IO.File.WriteAllText("C://Log.Txt", log);<br /> }<br /> }<br /> } </p> <p>ExceptionAttribute </p> <p>using System;<br /> using PostSharp.Laos; </p> <p>namespace PostSharp.Demo<br /> {<br /> [Serializable]<br /> [global::System.AttributeUsage(AttributeTargets.All, Inherited = true, AllowMultiple = false)]<br /> public class ExceptionAttribute : OnExceptionAspect<br /> {<br /> public override void OnException(MethodExecutionEventArgs eventArgs)<br /> {<br /> Console.WriteLine("程序出现异常：{0}", eventArgs.Exception.Message);<br /> eventArgs.FlowBehavior = FlowBehavior.Return;<br /> }<br /> }<br /> } </p> <p>然后再用控制台程序测试下能不能成功 </p> <p>Orders order = new Orders();<br /> Console.WriteLine("请输入用户名：");<br /> User.UserId = Console.ReadLine();<br /> Console.WriteLine("请输入密码：");<br /> Console.ReadLine();<br /> string id; </p> <p> LRedo:<br /> Console.WriteLine("请输入您要执行的操作：新增（A），删除（D），退出（X）"); </p> <p> string opt = Console.ReadLine(); </p> <p> if (opt.ToLower() == "a")<br /> {<br /> Console.WriteLine("请输入订单编号：");<br /> id = Console.ReadLine(); </p> <p> Console.WriteLine("请输入订单名称：");<br /> string name = Console.ReadLine();<br /> order.Add(id, name);<br /> }<br /> else if (opt.ToLower() == "d")<br /> {<br /> Console.WriteLine("请输入订单编号：");<br /> id = Console.ReadLine();<br /> order.Delete(id);<br /> }<br /> else if (opt.ToLower() == "x")<br /> {<br /> }<br /> else<br /> {<br /> Console.WriteLine("您的输入不正确，请重新输入！");<br /> goto LRedo;<br /> } </p> <p> Console.WriteLine("按任意键退出……");<br /> Console.ReadLine(); </p> <p>写完这些我们再反编译一下生成的exe文件，发现里面的Orders成了这模样了,神奇了？ </p> <p>public class Orders<br /> {<br /> // Methods<br /> static Orders()<br /> {<br /> if (!~PostSharp~Laos~Implementation.initialized)<br /> {<br /> LaosNotInitializedException.Throw();<br /> }<br /> ~PostSharp~Laos~Implementation.~targetMethod~1 = methodof(Orders.Add);<br /> ~PostSharp~Laos~Implementation.~aspect~1.RuntimeInitialize(~PostSharp~Laos~Implementation.~targetMethod~1);<br /> ~PostSharp~Laos~Implementation.~targetMethod~5 = methodof(Orders.Delete);<br /> ~PostSharp~Laos~Implementation.~aspect~5.RuntimeInitialize(~PostSharp~Laos~Implementation.~targetMethod~5);<br /> ~PostSharp~Laos~Implementation.~targetMethod~4 = methodof(Orders.Delete);<br /> ~PostSharp~Laos~Implementation.~aspect~4.RuntimeInitialize(~PostSharp~Laos~Implementation.~targetMethod~4);<br /> ~PostSharp~Laos~Implementation.~targetMethod~3 = methodof(Orders.Add);<br /> ~PostSharp~Laos~Implementation.~aspect~3.RuntimeInitialize(~PostSharp~Laos~Implementation.~targetMethod~3);<br /> ~PostSharp~Laos~Implementation.~targetMethod~2 = methodof(Orders.Delete);<br /> ~PostSharp~Laos~Implementation.~aspect~2.RuntimeInitialize(~PostSharp~Laos~Implementation.~targetMethod~2);<br /> } </p> <p> private bool ~Delete(string id)<br /> {<br /> Console.WriteLine("您删除订单成功：编号：{0}", id);<br /> return true;<br /> } </p> <p> public bool Add(string id, string orderName)<br /> {<br /> bool ~returnValue~1;<br /> MethodExecutionEventArgs ~laosEventArgs~7;<br /> try<br /> {<br /> object[] ~arguments~6 = new object[] { id, orderName };<br /> ~laosEventArgs~7 = new MethodExecutionEventArgs(methodof(Orders.Add, Orders), this, ~arguments~6);<br /> ~PostSharp~Laos~Implementation.~aspect~1.OnEntry(~laosEventArgs~7);<br /> if (~laosEventArgs~7.FlowBehavior == FlowBehavior.Return)<br /> {<br /> return (bool) ~laosEventArgs~7.ReturnValue;<br /> }<br /> try<br /> {<br /> Console.WriteLine("正在执行新增订单方法的操作，回车继续……");<br /> Console.ReadLine();<br /> Console.WriteLine("您添加订单成功：编号：{0}，名称：{1}", id, orderName);<br /> ~returnValue~1 = true;<br /> }<br /> catch (Exception ~exception~2)<br /> {<br /> object[] ~arguments~3 = new object[] { id, orderName };<br /> MethodExecutionEventArgs ~laosEventArgs~4 = new MethodExecutionEventArgs(methodof(Orders.Add, Orders), this, ~arguments~3);<br /> ~laosEventArgs~4.Exception = ~exception~2;<br /> ~PostSharp~Laos~Implementation.~aspect~3.OnException(~laosEventArgs~4);<br /> switch (~laosEventArgs~4.FlowBehavior)<br /> {<br /> case FlowBehavior.Continue:<br /> goto Label_0145; </p> <p> case FlowBehavior.Return:<br /> ~returnValue~1 = (bool) ~laosEventArgs~4.ReturnValue;<br /> goto Label_0145;<br /> }<br /> throw;<br /> }<br /> Label_0145:<br /> ~laosEventArgs~7.ReturnValue = ~returnValue~1;<br /> ~PostSharp~Laos~Implementation.~aspect~1.OnSuccess(~laosEventArgs~7);<br /> ~returnValue~1 = (bool) ~laosEventArgs~7.ReturnValue;<br /> }<br /> catch (Exception ~exception~5)<br /> {<br /> ~laosEventArgs~7.Exception = ~exception~5;<br /> ~PostSharp~Laos~Implementation.~aspect~1.OnException(~laosEventArgs~7);<br /> switch (~laosEventArgs~7.FlowBehavior)<br /> {<br /> case FlowBehavior.Continue:<br /> return ~returnValue~1; </p> <p> case FlowBehavior.Return:<br /> return (bool) ~laosEventArgs~7.ReturnValue;<br /> }<br /> throw;<br /> }<br /> finally<br /> {<br /> ~laosEventArgs~7.ReturnValue = ~returnValue~1;<br /> ~PostSharp~Laos~Implementation.~aspect~1.OnExit(~laosEventArgs~7);<br /> ~returnValue~1 = (bool) ~laosEventArgs~7.ReturnValue;<br /> }<br /> return ~returnValue~1;<br /> } </p> <p> [DebuggerNonUserCode]<br /> public bool Delete(string id)<br /> {<br /> bool ~returnValue~2;<br /> MethodExecutionEventArgs ~laosEventArgs~8;<br /> try<br /> {<br /> object[] ~arguments~7 = new object[] { id };<br /> ~laosEventArgs~8 = new MethodExecutionEventArgs(methodof(Orders.Delete, Orders), this, ~arguments~7);<br /> ~PostSharp~Laos~Implementation.~aspect~2.OnEntry(~laosEventArgs~8);<br /> if (~laosEventArgs~8.FlowBehavior == FlowBehavior.Return)<br /> {<br /> return (bool) ~laosEventArgs~8.ReturnValue;<br /> }<br /> try<br /> {<br /> Delegate delegateInstance = new ~PostSharp~Laos~Implementation.~delegate~0(this.~Delete);<br /> object[] arguments = new object[] { id };<br /> MethodInvocationEventArgs eventArgs = new MethodInvocationEventArgs(delegateInstance, arguments);<br /> ~PostSharp~Laos~Implementation.~aspect~5.OnInvocation(eventArgs);<br /> ~returnValue~2 = (bool) eventArgs.ReturnValue;<br /> }<br /> catch (Exception ~exception~3)<br /> {<br /> object[] ~arguments~4 = new object[] { id };<br /> MethodExecutionEventArgs ~laosEventArgs~5 = new MethodExecutionEventArgs(methodof(Orders.Delete, Orders), this, ~arguments~4);<br /> ~laosEventArgs~5.Exception = ~exception~3;<br /> ~PostSharp~Laos~Implementation.~aspect~4.OnException(~laosEventArgs~5);<br /> switch (~laosEventArgs~5.FlowBehavior)<br /> {<br /> case FlowBehavior.Continue:<br /> goto Label_0160; </p> <p> case FlowBehavior.Return:<br /> ~returnValue~2 = (bool) ~laosEventArgs~5.ReturnValue;<br /> goto Label_0160;<br /> }<br /> throw;<br /> }<br /> Label_0160:<br /> ~laosEventArgs~8.ReturnValue = ~returnValue~2;<br /> ~PostSharp~Laos~Implementation.~aspect~2.OnSuccess(~laosEventArgs~8);<br /> ~returnValue~2 = (bool) ~laosEventArgs~8.ReturnValue;<br /> }<br /> catch (Exception ~exception~6)<br /> {<br /> ~laosEventArgs~8.Exception = ~exception~6;<br /> ~PostSharp~Laos~Implementation.~aspect~2.OnException(~laosEventArgs~8);<br /> switch (~laosEventArgs~8.FlowBehavior)<br /> {<br /> case FlowBehavior.Continue:<br /> return ~returnValue~2; </p> <p> case FlowBehavior.Return:<br /> return (bool) ~laosEventArgs~8.ReturnValue;<br /> }<br /> throw;<br /> }<br /> finally<br /> {<br /> ~laosEventArgs~8.ReturnValue = ~returnValue~2;<br /> ~PostSharp~Laos~Implementation.~aspect~2.OnExit(~laosEventArgs~8);<br /> ~returnValue~2 = (bool) ~laosEventArgs~8.ReturnValue;<br /> }<br /> return ~returnValue~2;<br /> }<br /> }