\t\tC# 用Attribute实现AOP事务

阅前注意

1. 整篇文章的核心和突破点在于上下文Context的使用，务必注意CallContext在整个程序中起到的作用

2. 本文中看到的SqlHelper使用的是微软SqlHelper.cs。

3. 本文重点在于如何实现，并且已经 测试通过，只贴关键性代码，所以请认真阅读，部分代码直接拷贝下来运行是会出错的!



正文

首先我们来看一段未加事务的代码：

SqlDAL.cs

1. public abstract class SqlDAL
2. {
4. #region ConnectionString
6. private SqlConnectionStringBuilder _ConnectionString = null;
7. ///
8. /// 字符串连接
9. ///
10. public virtual SqlConnectionStringBuilder ConnectionString
11. {
12. get
13. {
14. if (_ConnectionString == null || string.IsNullOrEmpty(_ConnectionString.ConnectionString))
15. {
16. _ConnectionString = new SqlConnectionStringBuilder(Configurations.SQLSERVER_CONNECTION_STRING);
17. }
18. return _ConnectionString;
19. }
20. set { _ConnectionString = value; }
21. }
23. #endregion
25. #region ExecuteNonQuery
27. public int ExecuteNonQuery(string cmdText)
28. {
29. return SqlHelper.ExecuteNonQuery(ConnectionString.ConnectionString, CommandType.Text, cmdText);
30. }
32. public int ExecuteNonQuery(string cmdText, CommandType type)
33. {
34. return SqlHelper.ExecuteNonQuery(ConnectionString.ConnectionString, type, cmdText);
35. }
37. public int ExecuteNonQuery(string cmdText, CommandType type, params SqlParameter[] cmdParameters)
38. {
39. return SqlHelper.ExecuteNonQuery(ConnectionString.ConnectionString, type, cmdText, cmdParameters);
40. }
42. #endregion

复制代码

代码说明：

1. 本类对SqlHelper.cs 进一步封装。

2. Configurations.SQLSERVER_CONNECTION_STRING 替换成自己的连接字符串就行了。

UserInfoAction.cs

1. public class UserInfoAction : SqlDAL
2. {
3. ///
4. /// 添加用户
5. ///
6. public void Add(UserInfo user)
7. {
8. StringBuilder sb = new StringBuilder();
9. sb.Append("UPDATE [UserInfo] SET Password='");
10. sb.Append(user.Password);
11. sb.Append("' WHERE UID=");
12. sb.Append(user.UID);
13. ExecuteNonQuery(sql);
14. }
15. }

复制代码

如果我们要加入事务，通常的办法就是在方法内try、catch然后Commit、Rollback，缺点就不说了，下面我会边贴代码边讲解，力图大家也能掌握这种方法: )

先贴前面两个被我修改的类

SqlDAL.cs

1. public abstract class SqlDAL : ContextBoundObject
2. {
4. private SqlTransaction _SqlTrans;
5. ///
6. /// 仅支持有事务时操作
7. ///
8. public SqlTransaction SqlTrans
9. {
10. get
11. {
12. if (_SqlTrans == null)
13. {
14. //从上下文中试图取得事务
15. object obj = CallContext.GetData(TransactionAop.ContextName);
16. if (obj != null && obj is SqlTransaction)
17. _SqlTrans = obj as SqlTransaction;
18. }
19. return _SqlTrans;
20. }
21. set { _SqlTrans = value; }
22. }
24. #region ConnectionString
26. private SqlConnectionStringBuilder _ConnectionString = null;
27. ///
28. /// 字符串连接
29. ///
30. public virtual SqlConnectionStringBuilder ConnectionString
31. {
32. get
33. {
34. if (_ConnectionString == null || string.IsNullOrEmpty(_ConnectionString.ConnectionString))
35. {
36. _ConnectionString = new SqlConnectionStringBuilder(Configurations.SQLSERVER_CONNECTION_STRING);
37. }
38. return _ConnectionString;
39. }
40. set { _ConnectionString = value; }
41. }
43. #endregion
45. #region ExecuteNonQuery
47. public int ExecuteNonQuery(string cmdText)
48. {
49. if (SqlTrans == null)
50. return SqlHelper.ExecuteNonQuery(ConnectionString.ConnectionString, CommandType.Text, cmdText);
51. else
52. return SqlHelper.ExecuteNonQuery(SqlTrans, CommandType.Text, cmdText);
53. }
55. public int ExecuteNonQuery(string cmdText, CommandType type)
56. {
57. if (SqlTrans == null)
58. return SqlHelper.ExecuteNonQuery(ConnectionString.ConnectionString, type, cmdText);
59. else
60. return SqlHelper.ExecuteNonQuery(SqlTrans, type, cmdText);
61. }
63. public int ExecuteNonQuery(string cmdText, CommandType type, params SqlParameter[] cmdParameters)
64. {
65. if (SqlTrans == null)
66. return SqlHelper.ExecuteNonQuery(ConnectionString.ConnectionString, type, cmdText, cmdParameters);
67. else
68. return SqlHelper.ExecuteNonQuery(SqlTrans, type, cmdText, cmdParameters);
69. }
71. #endregion
73. }

复制代码

代码说明:

1. 加了一个属性(Property)SqlTrans，并且每个ExecuteNonQuery执行前都加了判断是否以事务方式执行。这样做是为后面从上下文中取事务做准备。

2. 类继承了ContextBoundObject，注意，是必须的，MSDN是这样描述的：定义所有上下文绑定类的基类。

3. TransactionAop将在后面给出。

UserInfoAction.cs

1. [Transaction]
2. public class UserInfoAction : SqlDAL
3. {
4. [TransactionMethod]
5. public void Add(UserInfo user)
6. {
7. StringBuilder sb = new StringBuilder();
8. sb.Append("UPDATE [UserInfo] SET Password='");
9. sb.Append(user.Password);
10. sb.Append("' WHERE UID=");
11. sb.Append(user.UID);
12. ExecuteNonQuery(sql);
13. }
14. }

复制代码

代码说明：

1. 很简洁、非侵入式、很少改动、非常方便(想要事务就加2个标记，不想要就去掉)。

2. 两个Attribute后面将给出。

1. ///
2. /// 标注类某方法内所有数据库操作加入事务控制
3. ///
4. [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
5. public sealed class TransactionAttribute : ContextAttribute, IContributeObjectSink
6. {
8. ///
9. /// 标注类某方法内所有数据库操作加入事务控制，请使用TransactionMethodAttribute同时标注
10. ///
11. public TransactionAttribute()
12. : base("Transaction")
13. { }
15. public IMessageSink GetObjectSink(MarshalByRefObject obj, IMessageSink next)
16. {
17. return new TransactionAop(next);
18. }
19. }
21. ///
22. /// 标示方法内所有数据库操作加入事务控制
23. ///
24. [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
25. public sealed class TransactionMethodAttribute : Attribute
26. {
27. ///
28. /// 标示方法内所有数据库操作加入事务控制
29. ///
30. public TransactionMethodAttribute()
31. {
33. }
34. }

复制代码

代码说明：

1. 在上面两篇文章中都是把IContextProperty, IContributeObjectSink单独继承并实现的，其实我们发现ContextAttribute已经继承了IContextProperty，所有这里我仅仅只需要再继承一下IContributeObjectSink就行了。关于这两个 接口的说明，上面文章中都有详细的说明。

2. TransactionAop将在后面给出。

3. 需要注意的是两个Attribute需要一起用，并且我发现Attribute如果标记在类上他会被显示的实例化，但是放在方法上就不会，打断点可以跟踪到这一过程，要不然我也不会费力气弄两个来标注了。

TransactionAop.cs

1. public sealed class TransactionAop : IMessageSink
2. {
3. private IMessageSink nextSink; //保存下一个接收器
5. ///
6. /// 构造函数
7. ///
8. /// 接收器
9. public TransactionAop(IMessageSink nextSink)
10. {
11. this.nextSink = nextSink;
12. }
14. ///
15. /// IMessageSink接口方法，用于异步处理，我们不实现异步处理，所以简单返回null,
16. /// 不管是同步还是异步，这个方法都需要定义
17. ///
18. ///
19. ///
20. ///
21. public IMessageCtrl AsyncProcessMessage(IMessage msg, IMessageSink replySink)
22. {
23. return null;
24. }
26. ///
27. /// 下一个接收器
28. ///
29. public IMessageSink NextSink
30. {
31. get { return nextSink; }
32. }
34. ///
35. ///
36. ///
37. ///
38. ///
39. public IMessage SyncProcessMessage(IMessage msg)
40. {
41. IMessage retMsg = null;
43. IMethodCallMessage call = msg as IMethodCallMessage;
45. if (call == null || (Attribute.GetCustomAttribute(call.MethodBase, typeof(TransactionMethodAttribute))) == null)
46. retMsg = nextSink.SyncProcessMessage(msg);
47. else
48. {
49. //此处换成自己的数据库连接
50. using (SqlConnection Connect = new SqlConnection(Configurations.SQLSERVER_CONNECTION_STRING))
51. {
52. Connect.Open();
53. SqlTransaction SqlTrans = Connect.BeginTransaction();
55. //讲存储存储在上下文
56. CallContext.SetData(TransactionAop.ContextName, SqlTrans);
58. //传递消息给下一个接收器 - > 就是指执行你自己的方法
59. retMsg = nextSink.SyncProcessMessage(msg);
61. if (SqlTrans != null)
62. {
63. IMethodReturnMessage methodReturn = retMsg as IMethodReturnMessage;
64. Exception except = methodReturn.Exception;
66. if (except != null)
67. {
68. SqlTrans.Rollback();
69. //可以做日志及其他处理
70. }
71. else
72. {
73. SqlTrans.Commit();
74. }
75. SqlTrans.Dispose();
76. SqlTrans = null;
77. }
78. }
79. }
81. return retMsg;
82. }
84. ///
85. /// 用于提取、存储SqlTransaction
86. ///
87. public static string ContextName
88. {
89. get { return "TransactionAop"; }
90. }
91. }

复制代码

代码说明：

1. IMessageSink MSDN:定义消息接收器的接口。

2. 主要关注SyncProcessMessage方法内的代码，在这里创建事务，并存储在上下文中间，还记得上面SqlDAL的SqlTrans属性么，里面就是从上下文中取得的。

3. 请注意了，这里能捕捉到错误，但是没有办法处理错误，所以错误会继续往外抛，但是事务的完整性我们实现了。你可以在Global.asax可以做全局处理，也可以手动的try一下，但是我们不需要管理事务了，仅仅当普通的错误来处理了。


结束

大家可以看到，在被标注的方法里面所有的数据库操作都会被事务管理起来