转自http://www.cnblogs.com/caviare

 

下载链接

 

介绍

通过本文你可以学习到如何利用微软企业库、CodeSmith、.NetTiers模板在少于15分钟内快速构建数据访问层。

从现在起我们把数据访问层(Data Access Layer)简称为DAL,它是程序中和数据库进行交互的层。手写DAL层代码是非常枯燥无味,浪费时间的重复活动,还有可能在编译程序的时候出现好多漏洞。

我们需要确保已经安装了SQL Server的Northwind数据库,但是这个例子也可以运行在其它任何数据库上。当然了,看完文章后你将不会再单调无味的浪费时间去为你的应用程序写DAL层代码了,而是更快、更简单。

如果你看完这篇文章你将会在1分钟内使用最佳实践来创建一个数据访问层(其它14分钟是用来第一次下载所需的软件)。

代码生成概述

代码生成,或者使用工具软件生成代码,不是一个新的概念。实际上,代码生成已经很普遍了。本篇文章我们用CodeSmith来生成DAL层的代码以及T-SQL脚本。

CodeSmith是一个开发者常用工具,它可以使用模板来输出你想要的格式代码。你可以使用模板来生成任何你想要的代码,功能特别强大,本文就是用了一个.NetTiers模板。

 

第一步 安装软件

首先我们就是下载CodeSmith和.NetTiers,其中前者是30天试用版(当然网上也有破解工具,当前最新版是3.2,是for .net 2.0的,我们下载3.1或者3.0版就行)

下载并安装CodeSmith

http://www.codesmithtools.com/

CodeSmith已经内置了好多模板,并且我们一会儿会让它包含进我们需要的.NetTiers模板,安装好CodeSmith,我们下载.NetTiers模板库。

为CodeSmith下载.NetTiers模板库

http://cstemplates.sourceforge.net/

在上面的地址里下载最新的.NetTiers模板库安装文件。

最后一步就是确保你安装了SQL Server数据库并且准备好连接到数据库的连接字符串。

第二步– CodeSmith

打开CodeSmith,我们先快速熟悉一下它的用法。

前文介绍过CodeSmith是一个模板驱动的工具。在CodeSmith的右边有一个模板浏览器窗口,它可以让你快速使用你已经安装的模板,见下图。

我们先来学习一下使用模板,双击Hashtable.cst模板。

Hashtable.cst是用来生成强类型集合的hashtable类型的模板。我们再来快速看一下CodeSmith的另一个窗口,属性窗口。

属性窗口可以让你来设置模板的属性,如果使用Hashtable.cst模板,我们需要设置ClassName,ItemType和KeyType属性。举个例子,我们要创建一个Person对象的集合,并且使用integer类型键来访问的PersonCollection集合。你需要把在属性窗口里把ClassName设置成PersonCollection,ItemType设置成Person,KeyType设置成int。点击工具栏里的run按钮,就可以生成你需要的强类型集合的源码了。

你看一下Hashtable.cst你就会发现它有点儿像ASP.NET的语法,其实CodeSmith模板就是使用类似ASP.NET的形式来生成你想要的代码,只不过是ASP.NET是用来生成HTML代码的,而CodeSmith是用来生成你需要的源代码的。

你要记住的一点是CodeSmith不会自动生成你需要的代码,但你可以自己定义模板来生成所有你想要的代码。

第三步 –生成数据访问层

我们已经基本理解了CodeSmith的用法,现在来演示如何使用.NetTiers模板。

记住,CodeSmith允许你快速的生成代码,并且很少会有手写代码造成的错误。.NetTiers模板生成的代码也是微软推荐的数据访问的最佳实践。

First we need to add the .NetTiers templates to the CodeSmith Template Explorer:

首先我们需要把.Nettiers模板添加到模板浏览器窗口。

  1. 在模板浏览器点击打开目录图标并浏览包含模板的目录
  2. 选择.NetTiers的安装目录,我的安装目录是是C:\Program Files\SerialCoder\NetTiers 0.9.2 - Caribert\Templates\
  3. 选择后就会在模板浏览器窗口里添加一个文件夹,展开它并选中NetTiers.cst模板
  4. 现在我们来配置数据连接字符串,打开NetTiers.cst模板,在属性窗口里点击SourceDataBase属性后面的对话框。
  5. 在这个窗口里你可以新创建一个自己的数据源,如下图。
  6. 测试一下连接是否成功,点击OK按钮关闭此窗口,然后选择你刚才创建的数据源名字。
  7. 最后,这是EntireDatabase属性为True,NameSpace属性为Demo,OutputDirectory属性为你想输出的目录,当然你需要提前创建好要生成代码的目录。

至此,你已经完成了NetTiers.cst模板的所有属性设置,它看起来应该如下图。

当然我们没有告诉你所有的关于.NetTiers的属性设置,但是对于生成扑通的DAL层代码已经足够了,点击工具栏里Run按钮(小箭头)就可以生成代码了。

注意:你建立的数据表一定要设置主建哦,如果没有主建,这个表就不会生成响应的代码,你点了Run按钮后会弹出一个报表,你可以看到都生成了哪些表的相关代码。

第四步 – 查看生成的代码

用Visual Studio .NET打开你刚才设置的代码输出目录里(我设置的是c:\NetTiers\Northwind_Demo\ directory)的Demo.sln解决方案。

我们来快速看一下解决方案包含的项目和文件。

You should find 3 projects within the solution:

你会看到有解决方案里包含3个项目

  • Demo –此项目包含了你要和数据库交互的主要的类。
  • Demo.DataAccessLayer –  此类库包含了实际的数据库操作执行代码
  • Demo.DataAccessLayer.SqlClient –此类库包含了微软推荐的访问数据库的设计模式和最佳实践(Microsoft Patterns & Practices classes)的代码。

第五步–编译、完成

接下来,我们用Visual Studio来编译项目。

祝贺你,你现在已经有了一个使用微软推荐的访问数据库的最佳实践的数据库访问层

现在你就可以在其它项目里使用你的DAL层了,举个例子,你需要获取,更新和删除一条员工的记录。

using Demo.DataAccessLayer.SqlClient;
 
// Select by primary key
Employee employee = SqlDataRepository.EmployeeProvider.GetByEmployeeID(13);
employee.FirstName = "John";
employee.LastName = "Doe";
 
// Save changes
SqlDataRepository.EmployeeProvider.Save(employee);
 
// Delete record
SqlDataRepository.EmployeeProvider.Delete(employee);
    

关于更多生成DAL层的信息,参考下面的.NetTiers的链接。

http://cstemplates.sourceforge.net/nettiers-manual-v1.html

记住,你的数据访问层的代码都是通过模板生成的。如果你修改了数据库的结构,你只需要简单的通过模板重新生成一下DAL层代码就行了。(当然了,如果你在重新生成代码前修改了一下生成的代码,再重新生成就给你覆盖了,这个怎么办呢,比较麻烦,你可以写一个继承自自动生成类的子类,在那里重写相关的方法,或者在.NET 2.0里使用多文件类)另外你可以根据你的想法扩展你的模板,包括注释,命名约定,模式等等。

小节

 

CodeSmith可以根据你的模板生成任何你想要的代码,本文向你演示了如何在短短几分钟内使用.NetTiers模板来在你应用程序中创建使用访问数据库最佳实践的数据库访问层。

你可以在这里查看视频演示:

http://community.codesmithtools.com/r.ashx?id=1

CodeSmith 3.1的一个新特征就是可以计算代码行。它可以保守的计算CodeSmith生成的代码。

 


这里可以看到.NetTiers生成了91,559行代码。假设一个很厉害的程序员一小时可以写60行代码,写完这些代码需要1,800小时。加入一个厉害的程序员你每小时要付给它接近60美元,CodeSmith和.NetTiers帮你公司节省了1,800小时的时间和109,000美元。(好像夸张了点儿哦。)

现在获取一个CodeSmith并发挥它的威力吧。

CodeSmith和.NetTiers 相关资源

如果你对CodeSmith有一些问题,可以访问它的社区来获取解决: http://community.codesmithtools.com/. CodeSmith社区里有好多人写的模板并共享给每个人下载,你可以去看看有没有自己需要的。

如果你想想购买CodeSmith,可以访问它的网站http://www.codesmithtools.com/. 你可以获取一个授权来免除30天试用的限制。如果你还有问题,可以给它们的售后支持邮箱发email sales@codesmithtools.com.

如果你对.NetTiers模板有问题,可以访问下面的论坛:

http://community.codesmithtools.com/forums/16/ShowForum.aspx

英文链接:

Build a Data Access Layer in less than 15 minutes

http://community.codesmithtools.com/blogs/tutorials/archive/2006/02/13/nettiers.aspx

另外借此贴调查一下各位的持久层用的都是什么呀,NHibernate, ibatis.net,DAAB,SPL,SQLHelper,CMP还是其它的,我想以后在项目中主要用一下企业库里的DAAB,不知道适合适合企业开发,它有那些缺点呀。

NetTier模板用法

1.1. 概述:
使用NetTier模板生成的.net代码,包括完整的数据层,使用的技术是微软的
EnterpriseLibrary1.1版本,对应每张表都生成相对应的增删改查函数和存储过程,在查询中支
持多字段查询和翻页。数据层为工厂模型,只要调用DataRepository 类即可获取相应表的接
口实例,然后可以对改表进行操作了。对于多表关联操作,在父表中可以获取子集的查询记
录,保存在IList 容器里面,对于子表,提供父表的对象实例。对于数据库的操作提供事务功
能。对于更加复杂的操作,直接提供EnterpriseLibrary的数据库操作实例,直接进行操作。
特征:
1、 生成vs.net工程和解决方案;
2、 集成EnterpriseLibrary1.1版本,对于数据库链接可以直接使用EnterpriseLibrary的配置文
件;
3、 数据表和实体的映射关系是1:1的,每张表都有一个实体生成,在实体里面对应了每个
字段,实体类是序列化的,有trigger事件,支持枚举类型的字段;
4、 对于表和视图生成的实体的操作包括:基本的CRUD操作:UPDATE, DELETE, INSERT,
SELECT ALL, PAGED SELECT, FIND;支持主键、外键、多表关联、排序、分页、sql
语句、视图查询;
5、 获取强类型的数据集存储在Ilist或者Vlist里面,可以绑定到DataGrid、GridView或
者其他的页面控件中,支持表格排序;
6、 生成webservice 服务进行数据分发;
7、 创建存储过程脚本,而且自动安装到数据库服务器上面;
8、 生成nant的完整的build.xml 文件,可以自动编译、测试代码,生成chm 格式的api
文档;
9、 根据数据库生成完整的数据验证规则,包括一个管理规则的框架;
10、 每个表都有一个实体类,你可以在你的客户代码里面继承,然后增加自己的处理方
法;
11、 生成数据源可以让你你无需再去处理数据源的问题了;
12、 创建全套的web admin用户控件,你可以对数据库进行web管理;
13、 完整的nunit测试;
14、 完整的注释,符合微软的命名规则;
15、 nettiers 模板是免费开源的。
1.2. 框架结构:
数据逻辑包括客户业务逻辑组件、数据接口逻辑组件(持久层逻辑),整个设计建筑在el
上面。
下面以northwind数据库的单表employee为例进行讲解。
Employee数据表结构:
生成的OO 结构:
接口统一的调用DataRepository 获取各功能块的provider,然后进行单表的增删改查操
作,如果需要更加复杂的业务逻辑,比如要用到事务来同时处理几个表,那么需要另外写业务
逻辑代码了,这些逻辑层代码可以放在bl 层里面。值得一提的是,现在在bl 层里面生成的代
码,只有最基本和通用的业务逻辑,只生成了单表数据的实体类VO、单表数据各字段的处理
和数据集合的排序、检索等处理。
EmployeesCollection
EmployeesCollectionBase
Employees
EmployeesBase EmployeesVO
在DataRepository 里面获取各功能模块的provider的方法是static 方法,得到的是各
个sqlprovider 的实例,而提供给外界使用的是其对应的抽象类定义的方法。
实例的调用顺序是:
:
DataRepository
:
SqlDataProvider
:
SqlEmployeesProviderBase
1: EmployeesProvider
2: GetAll
3: GetByEmployeeID
分析DataRepository.EmployeesProvider.GetAll()的操作:实例化的顺序是
DataRespository 类里面维护了一个全局的变量Current,这个Current实际上是
SqlDataProvider 的实例,而Current是DataProviderBase 类型,关系为:
DataProviderBase
SqlDataProvider
(from sqlclient)
在DataRepository 中获取EmployeesProvider的时候,实际上是调用了
SqlDataProvider 里面的方法EmployeesProvider(),new 了一个SqlEmployeesProvider 实
例,而这个实例中所有的方法的实现在SqlEmployeesProviderBase类中实现的,因为
SqlEmployeesProvider继承了SqlEmployeesProviderBase类,这个类相当于是dao 层,直接进行
数据库操作。
SqlEmployeesProviderBase
EmployeesProviderBase
(from base)
SqlEmployeesProvider
在生成各个sqlprovider 实例的时候,需要先实例化SqlDataProvider,这个用的是
Activator 类根据配置文件提供的这个类的名字生成的,nettier为了做到对不同数据库的支
持,提供了一个配置文件nettiersconfigdata.config 和读取这个配置文件的dll:
NetTiers.Configuration.dll。
Activator 类可以动态构造对象,有点像Java里面的
Class.forName(ClassName).newInstance()语句,因为用Activator 类构造对象,其类名在
编译时可以不确定,所以可以用来做插件的接口,做出Winamp 那种可以外加DLL 插件的程序
来。
1.3. 调用接口的方法:
1.3.1. 获取所有数据
获取所有的Employee数据,按照LastName字段进行排序:
using Northwind.DataAccessLayer;
// Get all the employee, sort it on the LastName and print them out
TList<Employees> employees = DataRepository.EmployeeProvider.GetAll();
employees.Sort(EmployeeColumns.LastName, ListSortDirection.Ascending);
foreach(Employee employee in employees)
{
Console.WriteLine("{1} {0}", employee.FirstName, employee.LastName);
}
1.3.2. 新增数据
创建一个新的employee 并且保存
using Northwind.DataAccessLayer;
// Create a new record and save
Employee employee = new Employee();
employee.FirstName = "John";employee.LastName = "Doe";
employee.BirthDate = DateTime.Now;employee.Address = "10 , fake street";
employee.City = "Metroplolis";employee.Country = "USA";
employee.HireDate = DateTime.Now;
employee.HomePhone = "0123456789";
employee.Notes = "This is a fake employee";
employee.Title = "M";
employee.TitleOfCourtesy = "Dear";
employee.PostalCode = "5556";
employee.Region = "New-York";
DataRepository.EmployeeProvider.Insert(employee);
//look, new id already populated
Console.WriteLine("New Employee ID" + employee.EmployeeId);
1.3.3. 修改数据
按照下标获取数据并且修改数据;
using Northwind.DataAccessLayer;
// Select by Index and Update
TList<Employees> employees =
DataRepository.EmployeeProvider.GetByLastName("Doe");
if (employees.Count == 1)
{
employees[0].Notes = "This is a modified fake employee";
DataRepository.EmployeeProvider.Save(employees[0]);
Console.Write(employees[0]);
}
1.3.4. 删除数据
通过主键查询数据并且删除
using Northwind.DataAccessLayer;
// Select by primary key and Delete
// (Demonstrate that insert, update, delete methods can also take collection
as parameter)
Employee employee = SqlDataRepository.EmployeeProvider.GetByEmployeeID(13);
DataRepository.EmployeeProvider.Delete(employees);
1.3.5. 事务控制
事务控制实例,可以用事务控制插入、修改、删除的操作,保证全部成功或者失败回滚;
using Northwind.DataAccessLayer;
// The SqlClient can work with transactions.
// Also show the Save method, wich encapsulate the use of Insert, Update and
Delete methods.
TransactionManager transaction = DataRepository.CreateTransaction();
transaction.BeginTransaction(/*IsolationLevel.ReadUncommited*/);
try
{
// Insert
Employee employee = new Employee();
employee.FirstName = "John";
employee.LastName = "Doe";
employee.BirthDate = DateTime.Now;
employee.Address = "10 , fake street";
employee.City = "Metroplolis";
employee.Country = "USA";
employee.HireDate = DateTime.Now;
employee.HomePhone = "0123456789";
mployee.Notes = "This is a fake employee";
employee.Title = "M";
employee.TitleOfCourtesy = "Doctor";
employee.PostalCode = "5556";
employee.Region = "New-York";
DataRepository.EmployeeProvider.Save(transaction, employee);
// modify the employee instance
employee.Notes = "This is a modified fake employee";
// Update
DataRepository.EmployeeProvider.Save(transaction, employee);
transaction.Commit();
Console.WriteLine("ok");
}
catch(Exception ex)
{
try { transaction.Rollback();} catch(){}
Console.WriteLine("nok : {0}", ex);
}
1.3.6. 关联保存
深度保存,可以同时保存父对象和子集
/*
DeepSave helper method can help you to save an object and its children in
one call.
*/
using Northwind.DataAccessLayer;
Order order = Order.CreateOrder("ALFKI", 1, DateTime.Now, DateTime.Now,
DateTime.Now, 1, 0.1m, "ship name", "ship address" , "paris", "idf", "75000",
"france");
order.OrderDetailCollection.Add(order.OrderID, 1, 15.6m, 10, 0.02f);
order.OrderDetailCollection.Add(order.OrderID, 2, 122.6m, 43, 0.03f);
DataRepository.OrderProvider.DeepSave(order);
Console.WriteLine("new order saved: orderId is: " + order.OrderID.ToString());
1.3.7. 多数据库支持
同时支持多个不同的数据库进行操作,在el 配置文件中配置不同的数据库连接或者在代
码中动态生成不同的数据库连接,达到同时使用不同类型数据库的目的。
/*
You can configure multiple data provider in the configuration console, and
write code to acces a specific one, instead of the default.
*/
using Northwind.DataAccessLayer;
SqlDataProvider myRepository = DataRepository.Providers["my second data
provider"] as Northwind.DataAccessLayer.SqlClient.SqlDataProvider;
this.listBox1.DataSource = myRepository.ProductProvider.GetAll();
this.listBox1.DisplayMember = "ProductName";
this.listBox1.ValueMember = "ProductID";
//Or if you can't have it pre-configured, you can change the connection
string at runtime.
using Northwind.DataAccessLayer;
//New syntax using a declared connection string:
TList<Products> list =
DataRepository.Connections["NorthwindConnectionString2"].Provider.CustomersProvide
r.GetAll();
//New syntax using a dynamic connection string:
DataRepository.AddConnection("DynamicConnectionString", "Data
Source=(local);Initial Catalog=Northwind;Integrated Security=true;");
TList<Products< list =
DataRepository.Connections["DynamicConnectionString"].Provider.ProductsProvider.Ge
tAll();
this.listBox1.DataSource = list;
this.listBox1.DisplayMember = "ProductName";
this.listBox1.ValueMember = "ProductID";
1.4. 配置nettiers模板
1.4.1. Datasource目录:
SourceDatabase 数据库名字和连接参数,在codesmith explore中有配置界面弹出
SourceTables 在数据表里面需要实体化的表
EntireDatabase 明确在数据库中需要实体化的表,这个设置将取代SourceTables 的设置
1.4.2. General 目录
OuputDirectory 输出目录,在codesmith explore里面有配置界面弹出
BusinessLogicLayerFolderName 逻辑层子目录名,推荐置空
DataAccessLayerFolderName 数据层子目录名,推荐值:DataAccessLayer
SqlFolderName 存储过程脚本目录名,推荐:SQL
NameSpace 项目的命名空间,名称和目录同。
GenerateUnitTest 声明生成nunit测试项目名
VsNetIntegration 声明是整个的生成一个工程还是按层分开生成工程
VsNetVersion Vs.net的版本
1.4.3. Webservice参数
GenerateWebService 声明是否生成webservice服务
WebServiceOutputPath Webservice的生成文件路径
WebServiceUrl 数据层子目录名,推荐值:DataAccessLayer
SqlFolderName 指向WebServiceOutputPath 的url
配置完成后可以保存为配置文件,下次只需要载入即可。
新增了web层的模板,叫weblayer,实现单表的增删改查;
给一个配置好的例子,对sqlserver2000的数据库northwind的配置例子,见netier目录下面
property.xml文件,可以直接载入然后生成对应的代码,生成的是完整的工程,可以直接编译
运行。