MyMSDNTVLibrary (http://blog.joycode.com/musicland/posts/13776.aspx) 是我以前写的一个小型WinForms项目,当时的想法是为初学者们演示如何创建一个简单但却完整的小项目。很多朋友都对这个简单的小东西很感兴趣,西安的一位朋友在看着源码重新做了一遍之后,甚至还自己增加了添加TV的新功能。这让我感到非常欣慰。
?
正好最近又复习了一遍设计模式,我开始重新审视原有的应用程序结构,发现了一些应该改进的地方。比如说,我在写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.CreateDBHelper();
????? }
?
这样,应用程序就可以针对特定的数据源来动态采用特定的数据访问方式了。
?
OK,以上我通过一个简单的例子来扩展了MyMSDNTVLibrary,同时也说明了Factory Method在具体应用程序中的应用。当然,设计模式不止这一种,而Factory Method的应用也不仅限于此。我所给出的环境只是个非常小的特例,在更多的情况下,不同的设计模式需要结合起来应用(Patterns are supposed to be sewn together to solve a problem)。下面我推荐一些有关设计模式的书籍和资料,希望对大家有帮助:
?
Design Patterns – Elements of Reusable Object-Oriented Software (设计模式——可复用面向对象软件的基础)(太经典了)
Design Patterns Explained – A new Perspective on Object-Oriented Design (设计模式解析) (结合上面一书学习)
C# Design Patterns: A Tutorial (C#设计模式)(完全用C#实现,有一定参考价值)
?
Update:
经JGTM’2004[MVP]指点,我对上文中所述的环境再次进行了重构,通过增加插件的形式(继承于IProvider接口的一个assembly)使Library从真正意义上动态支持多数据源而无须重新编译,从真正意义上做到了unplugged。具体的实现思路请见JGTM’2004[MVP]在文后给出的精彩回复。大家如果感兴趣也可以在这里下载全部源码(感谢JohnnyHu提供空间!)。
============================================
您太客气了,我们一起研习,共同进步吧!
关于FACTORY METHODS的应用,在很多地方均有涉及(尤其是framework代码中),在类似于data provider的场合尤其多见。.NET中IDbConnection中的CreateCommmand()方法是我最常举的例子,它使得client代码的开发对具体类的依赖大幅度减少。
正好现在有时间,随手举个例子给你吧,我用重构的方法根据你文中提到的要求来推导,okay!先看这个原始代码:
public DataSet ClientSample()
{
SqlCommand command = new SqlCommand(commandText);
SqlDataAdapter adapter = new SqlDataAdapter(command);
using (SqlConnection connection = new SqlConnection(connectionString))
{
DataSet result = new DataSet();
connection.Open();
adapter.Fill(result, "tableName");
return result;
}
}
注意看它依赖了多少个具体的数据源相关的类。为了让这段代码可以适应多种数据源,首先要把具体类换成抽象类或接口,如下:
public DataSet ClientSample2()
{
IDbCommand command = new SqlCommand(commandText);
IDataAdapter adapter = new SqlDataAdapter(command);
using (IDbConnection connection = new SqlConnection(connectionString))
{
DataSet result = new DataSet();
connection.Open();
adapter.Fill(result, "tableName");
return result;
}
}
然后把构造具体类的逻辑封装成所谓provider:
public DataSet ClientSample2()
{
IMyProvider provider = new MySqlProvider();
IDbCommand command = provider.GetCommand(commandText);
IDataAdapter adapter = provider.GetDataAdapter(command);
using (IDbConnection connection =
provider.GetConnection(connectionString))
{
DataSet result = new DataSet();
connection.Open();
adapter.Fill(result, "tableName");
return result;
}
}
现在你就只依赖一个具体类了,再把这个依赖性通过引入字符串来消除:
const providerTypeName = "MyCompany.MyProject.MySqlProvider, SqlProvider";
public DataSet ClientSample2()
{
IMyProvider provider =
(IMyProvider)Activator.CreateInstance(providerTypeName);
IDbCommand command = provider.GetCommand(commandText);
IDataAdapter adapter = provider.GetDataAdapter(command);
using (IDbConnection connection =
provider.GetConnection(connectionString))
{
DataSet result = new DataSet();
connection.Open();
adapter.Fill(result, "tableName");
return result;
}
}
这个常量是个可配置的信息,如果放到配置文件中,这段代码就已经做到数据源无关了。这里面使用FACTORY METHODS模式利用GetCommand、GetDataAdpator和GetConnection三个方法把对IDbCommand、IDataAdapter和IDbConnection的构造延迟到子类中。如果把GetCommand合并入GetDataAdapter,就得到比较理想的client逻辑:
public DataSet ClientSample2()
{
IMyProvider provider =
(IMyProvider)Activator.CreateInstance(providerTypeName);
using (IDbConnection connection =
provider.GetConnection(connectionString))
{
IDbCommand command = connection.CreateCommand();
IDataAdapter adapter = provider.GetDataAdapter(command);
DataSet result = new DataSet();
connection.Open();
adapter.Fill(result, "tableName");
return result;
}
}
这里你可以发现,我们利用了IDbConnection中的CreateCommand()这个FACTORY METHOD进一步减少了provider的责任,使得provider内部也只需要依赖于两个和数据源相关的具体类:XxxConnection和XxxDataAdaptor:
public class MySqlProvider: IMyProvider
{
public IDbConnection GetConnection(string connectionString)
{
return new SqlConnection(connectionString);
}
public IDataAdapter GetDataAdapter(IDbCommand command)
{
command.CommandType = CommandType.StoredProc;
command.CommandText = "myStoredProc";
return new SqlDataAdapter(command);
}
}
这里,IMyProvider应该是由你的框架代码来定义,所有的provider都要reference你的框架并依赖这个接口,这也是所谓IOC的具体应用——在没有任何具体的provider类之
前client可以独立的编译,它并不依赖、引用任何具体的可扩展的provider类库。
上面的例子希望能够对你理解FACTORY METHODS(其实是TEMPLATE METHODS的一种具体情形)有所帮助吧!另外,我写的例子千万不要拷贝粘贴到开发环境中,否则引起蓝屏
甚至硬件故障本人一概不负责任。嘿嘿!:)
JGTM'2004 [MVP]
JGTM Studio .NET