反射在.NET中的简单应用(二)

Attribute，特性（之所以不称作属性，是为了跟Property相区分），就是我们在程序中经常碰到的用[]括起来的那个东西，没错，他就是Attributes。

Attributes在.NET中的应用非常广泛，例如我们序列化的时候，需要用到Serializable，定义枚举的时候可能会用到FlagAttribute，定义自定义控件的时候用到的BrowsableAttribute等等，这些都是对Attribute的应用，有关Attribute的更多信息请参考MSDN（http://msdn.microsoft.com/en-us/library/system.attribute.aspx）

在这篇文章中，我们用下面的例子来说明如何在.NET中应用自定义的Attribute

我们在做任何系统的时候，数据库中都会有些Master表，这些表的操作基本都比较简单，只是单表的增删改查

在这个例子中的做法，是给每个表都创建一个Entity的对象，表中的字段就是相应的Filed，然后给每个Entity以及Filed定义好相应的Attribute，这样就可以根据定义的属性自动生成SQL文以简化操作。

好了，下面就开始我们的准备工作。

首先我们需要建两个Attribute：

一个是定义表名的Attribute

1. [AttributeUsage(AttributeTargets.Class)]
2. internal class DBTableAttribute : Attribute
3. {
4.     private string tableName = String.Empty;
6.     public DBTableAttribute(string tableName)
7.     {
8.         this.tableName = tableName;
9.     }
11.     public string TableName
12.     {
13.         get { return tableName; }
14.         set { tableName = value; }
15.     }
16. }

这里需要注意一下AttributeTargets，它表示当前的Attribute的使用权限，有关AttributeTargets的更多信息，请参考MSDN（http://msdn.microsoft.com/zh-cn/library/system.attributetargets.aspx）

还有一个定义字段的Attribute

1. [AttributeUsage(AttributeTargets.Field)]
2. internal class DBColumnAttribute : Attribute
3. {
4.     private string columnName;//对应数据库的字段名
5.     private bool isPK;//是否主键
6.     private bool isSequence;;//是否自增列
7.     private bool isDelFlag;;//是否删除标记
9.     public DBColumnAttribute(string columnName)
10.             : this(columnName, false, false, false)
11.     {
12.     }
14.     public DBColumnAttribute(string columnName, bool isPK, bool isSequence, bool isDelFlag)
15.     {
16.         this.columnName = columnName;
17.         this.isPK = isPK;
18.         this.isSequence = isSequence;
19.         this.isDelFlag = isDelFlag;
20.     }
22.     public string ColumnName
23.     {
24.         get { return columnName; }
25.         set { columnName = value; }
26.     }
27.     public bool IsPK
28.     {
29.         get { return isPK; }
30.         set { isPK = value; }
31.     }
32.     public bool IsSequence
33.     {
34.         get { return isSequence; }
35.         set { isSequence = value; }
36.     }
37.     public bool IsDelFlag
38.     {
39.         get { return isDelFlag; }
40.         set { isDelFlag = value; }
41.     }
42. }

这里的删除标记的意思是，在操作表的时候我们有时候并不是彻底删除数据，而是修改一个标志位来决定此条记录是否有效。

 

接下来我们定义两个辅助类，以便在程序中把Attribute的信息读到这两个类中

1. internal class EntityAttributeInfo
2. {
3.     private string tableName = String.Empty;
4.     private Dictionary<string, EntityColumnInfo> columnInfo = new Dictionary<string, EntityColumnInfo>();
6.     public string TableName
7.     {
8.         get { return tableName; }
9.         set { tableName = value; }
10.     }
11.     public Dictionary<string, EntityColumnInfo> ColumnInfo
12.     {
13.         get { return columnInfo; }
14.         set { columnInfo = value; }
15.     }
16. }
18. internal class EntityColumnInfo
19. {
20.     private string dbColumnName = String.Empty;
21.     private string dalColumnName = String.Empty;//数据库的字段对应程序中的Filed的名称，以便使用反射来赋值
22.     private bool isPK;
23.     private bool isSequence;
24.     private bool isDelFlag;
26.     public string DbColumnName
27.     {
28.         get { return dbColumnName; }
29.         set { dbColumnName = value; }
30.     }
31.     public string DALColumnName
32.     {
33.         get { return dalColumnName; }
34.         set { dalColumnName = value; }
35.     }
36.     public bool IsPK
37.     {
38.         get { return isPK; }
39.         set { isPK = value; }
40.     }
41.     public bool IsSequence
42.     {
43.         get { return isSequence; }
44.         set { isSequence = value; }
45.     }
46.     public bool IsDelFlag
47.     {
48.         get { return isDelFlag; }
49.         set { isDelFlag = value; }
50.     }
51. }

然后我们建一个接口，供其他的Entity来继承

1. //目前只是空的接口，如果有需要可以增加自己的业务逻辑
2. public interface IEntity
3. {
4. }

好了，准备工作已经完毕，现在来看看我们的表吧

假设我们有表名为tbTest，有如下字段

ColumnName    ColumnType    IsPK    IsSequence    IsNullable

Column1           int                     true       true               false

Column2           string                false      false               false

Column3           string                false       false              true

Column4           int                    false       false               false

 

那么我们的Entity应该有如下定义

1. [DBTableAttribute("tbTest")]
2. public class TestEntity : IEntity
3. {
4.     [DBColumn("Column1", IsPK = true, IsSequence = true, IsDelFlag = false)]
5.     private int column1;
7.     public int Column1
8.     {
9.         get { return column1; }
10.         set { column1 = value; }
11.     }
13.     [DBColumn("Column2", IsPK = false, IsSequence = false, IsDelFlag = false)]
14.     private string column2;
16.     public string Column2
17.     {
18.         get { return column2; }
19.         set { column2 = value; }
20.     }
22.     [DBColumn("Column3", IsPK = false, IsSequence = false, IsDelFlag = false)]
23.     private string? column3;
25.     public string? Column3
26.     {
27.         get { return column3; }
28.         set { column3 = value; }
29.     }
31.     [DBColumn("Column4", IsPK = true, IsSequence = false, IsDelFlag = true)]
32.     private int column4;
34.     public int Column4
35.     {
36.         get { return column4; }
37.         set { column4 = value; }
38.     }
39. }

然后我们建一个AttributeReader来读取自定义的Attribute的信息

1. internal class AttributeReader
2. {
3.     public static EntityAttributeInfo GetAttributeInfo(IEntity etity)
4.     {
5.         Type type = etity.GetType();
6.         return GetAttributeInfo(type);
7.     }
9.     public static EntityAttributeInfo GetAttributeInfo(Type type)
10.     {
11.         EntityAttributeInfo info = new EntityAttributeInfo();
12.         info.TableName = GetTableName(type);
14.         foreach (FieldInfo field in
15.                 type.GetFields(BindingFlags.NonPublic | BindingFlags.Instance))
16.         {
17.             EntityColumnInfo item = GetColumnInfo(field);
18.             if (item != null)
19.             {
20.                 info.ColumnInfo.Add(item.DbColumnName, item);
21.             }
22.         }
24.         return info;
25.     }
27.     public static string GetTableName(Type type)
28.     {
29.         object[] oo = type.GetCustomAttributes(typeof(DBTableAttribute), false);
30.         if (oo.Length > 0)
31.         {
32.             return (oo[0] as DBTableAttribute).TableName;
33.         }
34.         return null;
35.     }
37.     private static EntityColumnInfo GetColumnInfo(FieldInfo field)
38.     {
39.         EntityColumnInfo info = null;
40.         object[] oo = field.GetCustomAttributes(typeof(DBColumnAttribute), false);
41.         if (oo.Length > 0)
42.         {
43.             DBColumnAttribute columnAttr = oo[0] as DBColumnAttribute;
44.             info = new EntityColumnInfo();
45.             info.DbColumnName = columnAttr.ColumnName;
46.             info.DALColumnName = field.Name;
47.             info.IsPK = columnAttr.IsPK;
48.             info.IsSequence = columnAttr.IsSequence;
49.             info.IsDelFlag = columnAttr.IsDelFlag;
50.         }
51.         return info;
52.     }
53. }

最后我们创建一个EntityManager来实现最终的增删改查的SQL文

1. public class EntityManager
2. {
3.     public void Insert(IEntity entity)
4.     {
5.         try
6.         {
7.             EntityAttributeInfo attInfo = AttributeReader.GetAttributeInfo(entity);
8.             if (String.IsNullOrEmpty(attInfo.TableName))
9.             {
10.                 throw new Exception(entity.GetType().Name + " cannot be insert to DB,because tablename is null.");
11.             }
13.             StringBuilder sb = new StringBuilder();
14.             StringBuilder sbColumn = new StringBuilder();
15.             StringBuilder sbValue = new StringBuilder();
16.             List<SqlParameter> parameters = new List<SqlParameter>();
18.             Dictionary<string, EntityColumnInfo> columnInfos = attInfo.ColumnInfo;
19.             string sequenceField = String.Empty;
21.             foreach (EntityColumnInfo item in columnInfos.Values)
22.             {
23.                 if (item.IsDelFlag)
24.                 {
25.                     SetObjectMemberValue(entity, item.DALColumnName, "1");
26.                 }
28.                 if (!item.IsSequence)
29.                 {
30.                     sbColumn.AppendFormat("{0},", item.DbColumnName);
31.                     string parameterName = "@" + item.DbColumnName;
32.                     sbValue.AppendFormat("{0},", parameterName);
33.                     object parameterValue = GetObjectMemberValue(entity, item.DALColumnName);
34.                     parameters.Add(new SqlParameter(parameterName, GetDBValue(parameterValue)));                  
35.                 }
36.                 else
37.                 {
38.                     sequenceField = item.DALColumnName;
39.                 }
40.             }
42.             sb.AppendFormat("INSERT INTO {0} ", attInfo.TableName);
43.             sb.Append("(");
44.             sb.Append(sbColumn.ToString().TrimEnd(','));
45.             sb.Append(")");
46.             sb.Append(" VALUES ");
47.             sb.Append("(");
48.             sb.Append(sbValue.ToString().TrimEnd(','));
49.             sb.Append(")");
50.             if (!String.IsNullOrEmpty(sequenceField))
51.             {
52.                 sb.Append(";SELECT @@identity");
53.                 object sequenceValue = DBService.Instance.ExecuteScalar(sb.ToString(), parameters);
54.                 SetObjectMemberValue(entity, sequenceField, Convert.ToInt32(sequenceValue));
55.             }
56.             else
57.             {
58.                 DBService.Instance.ExecuteNonQuery(sb.ToString(), parameters);
59.             }
60.         }
61.         catch (Exception ex)
62.         {
63.             throw ex;
64.         }
65.     }
67.     public void Update(IEntity entity)
68.     {
69.         try
70.         {
71.             EntityAttributeInfo attInfo = AttributeReader.GetAttributeInfo(entity);
72.             if (String.IsNullOrEmpty(attInfo.TableName))
73.             {
74.                 throw new Exception(entity.GetType().Name + " cannot be update to DB,because tablename is null.");
75.             }
77.             StringBuilder sbUpdate = new StringBuilder();
78.             StringBuilder sbWhere = new StringBuilder();
79.             List<SqlParameter> parameters = new List<SqlParameter>();
81.             Dictionary<string, EntityColumnInfo> columnInfos = attInfo.ColumnInfo;
83.             foreach (EntityColumnInfo item in columnInfos.Values)
84.             {
85.                 if (item.IsPK)
86.                 {
87.                     object parameterValue = GetObjectMemberValue(entity, item.DALColumnName);
88.                     string parameterName = "@" + item.DbColumnName;
89.                     parameters.Add(new SqlParameter(parameterName, GetDBValue(parameterValue)));
90.                     sbWhere.AppendFormat("AND {0} = @{0} ", item.DbColumnName);
91.                 }
92.                 else
93.                 {
94.                     sbUpdate.AppendFormat("{0} = @{0},", item.DbColumnName);
95.                 }
96.             }
97.             string sql = String.Format("UPDATE {0} SET {1} WHERE 1=1 {2}",
98.                     attInfo.TableName, sbUpdate.ToString().TrimEnd(','), sbWhere.ToString());
99.             DBService.Instance.ExecuteNonQuery(sql, parameters);
100.         }
101.         catch (Exception ex)
102.         {
103.             throw ex;
104.         }
105.     }
107.     public void Delete(IEntity entity)
108.     {
109.         try
110.         {
111.             EntityAttributeInfo attInfo = AttributeReader.GetAttributeInfo(entity);
112.             if (String.IsNullOrEmpty(attInfo.TableName))
113.             {
114.                 throw new Exception(entity.GetType().Name + " cannot be delete to DB,because tablename is null.");
115.             }
117.             string sql = String.Empty;
118.             StringBuilder sbWhere = new StringBuilder();
119.             List<SqlParameter> parameters = new List<SqlParameter>();
121.             Dictionary<string, EntityColumnInfo> columnInfos = attInfo.ColumnInfo;
123.             string delFlagColumn = String.Empty;
124.             foreach (EntityColumnInfo item in columnInfos.Values)
125.             {
126.                 if (item.IsDelFlag)
127.                 {
128.                     delFlagColumn = item.DbColumnName;
129.                 }
131.                 if (item.IsPK)
132.                 {
133.                     object parameterValue = GetObjectMemberValue(entity, item.DALColumnName);
134.                     string parameterName = "@" + item.DbColumnName;
135.                     parameters.Add(new SqlParameter(parameterName, GetDBValue(parameterValue)));
136.                     sbWhere.AppendFormat("AND {0} = @{0} ", item.DbColumnName);
137.                 }
138.             }
140.             if (String.IsNullOrEmpty(delFlagColumn))
141.             {
142.                 sql = String.Format("DELETE FROM {0} WHERE 1=1 {1}", attInfo.TableName, sbWhere.ToString());
143.             }
144.             else
145.             {
146.                 sql = String.Format("UPDATE {0} SET {1} = 0 WHERE 1=1 {2} ", 
147.                         attInfo.TableName, delFlagColumn, sbWhere.ToString());
148.             }
149.             DBService.Instance.ExecuteNonQuery(sql, parameters);
150.         }
151.         catch (Exception ex)
152.         {
153.             throw ex;
154.         }
155.     }
157.     public List<IEntity> GetEntities(Type type)
158.     {
159.         return GetEntities(type, null, null);
160.     }
162.     public List<IEntity> GetEntities(Type type, string where, List<SqlParameter> parameters)
163.     {
164.         List<IEntity> entities = new List<IEntity>();
165.         StringBuilder sb = new StringBuilder();
166.         string tableName = AttributeReader.GetTableName(type);
167.         if (!String.IsNullOrEmpty(tableName))
168.         {
169.             sb.AppendFormat("SELECT * FROM {0} ", tableName);
170.             if (!String.IsNullOrEmpty(where) && parameters != null && parameters.Count > 0)
171.             {
172.                 sb.AppendFormat("WHERE {0}", where);
173.             }
174.             DataTable table = DBService.Instance.ExecuteDataTable(sb.ToString(), tableName, parameters);
175.             if (table != null)
176.             {
177.                 foreach (DataRow row in table.Rows)
178.                 {
179.                     IEntity entity = RowMapping2Entity(type, row);
180.                     entities.Add(entity);
181.                 }
182.             }
183.         }
184.         return entities;
185.     }
187.     public IEntity GetEntity(Type type, string where, List<SqlParameter> parameters)
188.     {
189.         StringBuilder sb = new StringBuilder();
190.         string tableName = AttributeReader.GetTableName(type);
191.         IEntity entity = null;
192.         if (!String.IsNullOrEmpty(tableName))
193.         {
194.             sb.AppendFormat("SELECT TOP 1 * FROM {0} ", tableName);
195.             if (!String.IsNullOrEmpty(where))
196.             {
197.                 sb.AppendFormat("WHERE {0}", where);
198.             }
199.             DataTable table = DBService.Instance.ExecuteDataTable(sb.ToString(), tableName, parameters);
200.             if (table != null && table.Rows.Count > 0)
201.             {
202.                 entity = RowMapping2Entity(type, table.Rows[0]);
203.             }
204.         }
205.         return entity;
206.     }
208.     private object GetObjectMemberValue(IEntity entity ,string memberName)
209.     {
210.         FieldInfo field = GetField(entity, memberName);
211.         return field.GetValue(entity);
212.     }
214.     private void SetObjectMemberValue(IEntity entity, string memberName, object memberValue)
215.     {
216.         FieldInfo field = GetField(entity, memberName);
218.         field.SetValue(entity, GetObjValue(memberValue));
219.     }
221.     private FieldInfo GetField(IEntity entity, string memberName)
222.     {
223.         return entity.GetType().GetField(memberName, BindingFlags.Instance | BindingFlags.NonPublic);
224.     }
226.     private object GetDBValue(object obj)
227.     {
228.         if (obj == null)
229.         {
230.             return DBNull.Value;
231.         }
232.         return obj;
233.     }
235.     private object GetObjValue(object obj)
236.     {
237.         if (obj == DBNull.Value)
238.         {
239.             return null;
240.         }
241.         return obj;
242.     }
244.     private IEntity RowMapping2Entity(Type type, DataRow row)
245.     {
246.         IEntity entity = Activator.CreateInstance(type) as IEntity;
247.         EntityAttributeInfo attInfo = AttributeReader.GetAttributeInfo(entity);
248.         foreach (EntityColumnInfo columninfo in attInfo.ColumnInfo.Values)
249.         {
250.             SetObjectMemberValue(entity, columninfo.DALColumnName, row[columninfo.DbColumnName]);
251.         }
252.         return entity;
253.     }
254. }

这里的DBService替换成你的方法就可以了

好了，这个例子到这里就结束了