最近又复习了一遍设计模式,我开始重新审视原有的应用程序结构,发现了一些应该改进的地方。比如说,我在写MyMSDNTVLibrary的第一个版本时就非常想让它能够很方便地支持不同种类的数据源,例如Access、SQL Server,甚至是单纯的XML.我知道实现起来并不难,但怎样做才能最有效最有利于代码复用?想来想去,我决定在数据访问这一部分应用Factory Method模式。
Factory Method是GOF在Design Pattersn一书中给出的一种模式,GOF为它做出的定义是:
Define an interface for creating an object, but let subclasses decide which class to instantiate. Factory Method lets a class defer instantiation to subclasses.
简单来说,Factory Method的目的是想创建几个相似的(实现同一接口或继续同一父类)类中的某一个,为了达到这一目的,需要创建几个相似的creator类,通过creator类来决定创建哪一个所需的对象类。它的UML图示如下:
具体到这个项目来说,我需要针对不同的数据源来创建几个不同的DBHelper(我的个人习惯是通过DBHelper来封装针对特定的数据源的访问动作),如OleDBHelper、SqlDBHelper等,这些Helper有非常相近的结构,因此可以让它们继续于同一接口――IDBHelper.IDBHelper的定义如下:
using System;
using System.Data;
namespace musicland.MSDNTVLibrary.Component
{
public interface IDBHelper
{
DataSet GetAll();
}
}
注意其中给出了一个有待实现的方法GetAll,通过实现类对该方法的调用,可以获得应用程序所需的全部数据。
接下来就是从IDBHelper继续而来的两个具体数据访问辅助类。
OleDBHelper:
using System;
using System.Configuration;
using System.Data;
using System.Data.OleDb;
namespace musicland.MSDNTVLibrary.Component
{
// This is the helper class that will interact with OleDB for info.
internal class OleDBHelper: IDBHelper
{
private OleDbConnection conn;
public OleDBHelper()
{
conn=new OleDbConnection(ConfigurationSettings.AppSettings["OleConnectionString"]);
}
public DataSet GetAll()
{
OleDbDataAdapter da=new OleDbDataAdapter("select * from Episode order by Date desc", conn);
DataSet ds=new DataSet();
try
{
da.Fill(ds, "Episode");
}
catch (OleDbException ex)
{
throw ex;
}
finally
{
if (conn.State!=ConnectionState.Closed)
conn.Close();
}
return ds;
}
}
}
SqlDBHelper:
using System;
using System.Configuration;
using System.Data;
using System.Data.SqlClient;
namespace musicland.MSDNTVLibrary.Component
{
// This is the helper class that will interact with SqlServer for info.
internal class SqlDBHelper: IDBHelper
{
SqlConnection conn;
public SqlDBHelper()
{
conn=new SqlConnection(ConfigurationSettings.AppSettings["SqlConncectionString"]);
}
public DataSet GetAll()
{
SqlCommand cmd=new SqlCommand("GetAll", conn);
cmd.CommandType=CommandType.StoredProcedure;
SqlDataAdapter da=new SqlDataAdapter(cmd);
DataSet ds=new DataSet();
try
{
conn.Open();
da.Fill(ds, "Episode");
}
catch (SqlException ex)
{
throw ex;
}
finally
{
if (conn.State!=ConnectionState.Closed)
conn.Close();
}
return ds;
}
}
}
代码很简单,分别是针对不同的数据源来获取Episode表的全部内容(因为这个应用程序所需要的数访内容非常少,结构也很简单,因此一张Episode表就足够了)。其中,针对Access的OleDBHelper我直接使用SQL语句进行查询,而针对SQL Server的SqlDBHelper里这一部分则改用了存储过程,这也就非常清晰地体现出了不同数据源的访问方式的差别。
上面已经把数据访问辅助类构建完毕,接下来就该创建Creator和ConcreteCreator来动态调用这些辅助类了。OK,创建一个IDBCreatro接口:
using System;
namespace musicland.MSDNTVLibrary.Component
{
public interface IDBCreator
{
IDBHelper CreateDBHelper();
}
}
通过实现该接口,我们可以获得用于创建不同的数据访问辅助类的具体类:
OleDBCreator:
using System;
namespace musicland.MSDNTVLibrary.Component
{
// This is the ConcreteCreator class that helps to
// create and return the OleDBHelper class.
public class OleDBCreator: IDBCreator
{
public OleDBCreator() {}
public IDBHelper CreateDBHelper()
{
return new OleDBHelper();
}
}
}
SqlDBCreator:
using System;
namespace musicland.MSDNTVLibrary.Component
{
// This is the ConcreteCreator class helps to
// create and return the SqlDBHelper class.
public class SqlDBCreator: IDBCreator
{
public SqlDBCreator() {}
public IDBHelper CreateDBHelper()
{
return new SqlDBHelper();
}
}
}
以上两个类均实现了IDBCreator接口。通过实现CreateDBHelper方法,就可以创建一个数据访问辅助类(OleDBHelper或SqlDBHelper)的实例并传回调用方,这正是我们所需要的。
OK,主要框架已经搭建完毕,接下来我们只要在应用程序中通过适当的逻辑来进行调用了。我的初步设想是在。config文件中增加一个自定义的DBType键,通过为DBType设值来决定应用程序需要哪一种数据访问方式。配置文件部分内容如下:
<appSettings
Note: DBType indicates which DB need to interact with.
currently:
0: SqlServer
1: OleDB
――
<add key="DBType" value="1" /
<add key="OleConnectionString" value="Provider=Microsoft.Jet.OLEDB.4.0; Data Source=MSDNTV.mdb;" /
<add key="SqlConncectionString" value="Server=(local); Database=MyMSDNTVLibrary; Integrated Security=SSPI" /
……
</appSettings
设置好DBType以后,我们要做的只是在应用程序中读出这一配置值,然后去创建相应的DBCreator即可,代码如下:
// Get the corresponding IDBCreator class
public static IDBCreator GetDBCreator()
{
int dbType=Convert.ToInt32(ConfigurationSettings.AppSettings["DBType"]);
switch (dbType)
{
case 0:
return new SqlDBCreator();
case 1:
return new OleDBCreator();
default:
return new OleDBCreator();
}
}
以上代码可返回一个实现了IDBCreator接口的具体DBCreator,即OleDBCreator或SqlDBCreator,通过调用该类所实现的CreateDBHelper方法即可获得应用程序所需的DBHelper:
// Get the corresponding IDBHelper class
public static IDBHelper GetDBHelper(IDBCreator dbCreator)
{
return dbCreator.CreateDBHel