NHibernate：教你如何搭建数据访问层？

NHibernate：教你如何搭建数据访问层？

什么是NHibernate

NHibernate 是一个基于.net 的针对关系型数据库的对象持久化类库。NHibernate 来源于非常优秀的基于Java的Hibernate 关系型持久化工具。
NHibernate 从数据库底层来持久化你的.net 对象到关系型数据库。NHibernate 为你处理这些，远胜于你不得不写SQL去从数据库存取对象
。你的代码仅仅和对象关联，NHibernat 自动产生SQL语句，并确保对象提交到正确的表和字段中去。

这篇文档意在让你尽可能快的开始使用NHibernate。它将介绍如何持久化一个简单的对象到一张表里，完成对表的操作。

开发的过程

我们将进行以下步骤:
1．新建一个将要持久化.net对象的表
2．构建一个需要被持久化的.net类
3．构建一个可以让NHibernate知道如何持久化对象属性的映射文件
4．构建一个让NHibernate知道如何连接数据库的配置文件
5．使用NHibernate的API
6．测试

第一步：写构建表的SQL

这里我们将使用的是一个非常简单的例子。假设你正在为你的网站开发一个基本的用户管理子系统。我们将使用如下的一张User表（假定你已经设置好一个数据库—例子里我称它为test）。

CREATE TABLE users (
LogonID integer not null ,
Name nvarchar(40) default NULL,
Password nvarchar(20) default NULL,
EmailAddress nvarchar(40) default NULL,
LastLogon datetime default NULL,
PRIMARY KEY (LogonID)
)

我使用的是sqlite, 但也可以使用任何数据库，只要你有关于它们的基于.net数据提供驱动程序。我们将得到一个含有LogonID,Name, Password, Email 和LastLogon的表. 经过以上标准步骤，我们下一步是写一个.net类处理一个给定的User对象。

第二步:产生一个.Net 类文件

当内存中有一堆User对象的时候，我们需要某种对象去保存它们。NHibernate通过对象属性的反射来工作，因此我们需要添加我们希望持久化的对象属性。一个可以被NHibernate持久化的类应该看起来象下面的样子：

using System;

namespace NHibernate.Domain
{
    public class User
    {
        public virtual int Id { get; set; }

        public virtual string UserName { get; set; }

        public virtual string Password { get; set; }

        public virtual string EmailAddress { get; set; }

        public virtual DateTime LastLogon { get; set; }
    }
}

第三步：写映射文件

现在我们有数据表和需要去映射它的.net类。我们需要一种方式去让NHibernate知道如何从一个映射到另一个。这个任务依赖于映射文件来完成。最易于管理的办法是为每一个类写一个映射文件，如果你命名它是YourObject.hbm.xml 并且把它放在和类的同一个目录里，NHiberante将会使得事情简单起来。下面是一个User.hbm.xml的例子：

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="NHibernate.Domain" namespace="NHibernate.Domain">
  <class name="NHibernate.Domain.User,NHibernate.Domain" table="users" >
    <id name="Id" column="LogonId" type="int" unsaved-value="0">
      <generator class="increment"/>
    </id>
    <property name="UserName" column= "Name" type="String" length="40"/>
    <property name="Password" type="String" length="20"/>
    <property name="EmailAddress" type="String" length="40"/>
    <property name="LastLogon" type="DateTime"/>
  </class>
</hibernate-mapping>

让我们来看看这个文件中让我们感兴趣的某些行。第一个有趣的标签是class。这里我们将映射类型名称到我们数据库中的User表，这里和Hibernate有一点点的不同。你将不得不告诉NHibernate从何处提取对象。

让我们先跳过id标签，来讨论property标签。简要看一下，你将发现NHibernate所要做的工作。name属性的值正是我们.net 类的属性，column属性值将是我们数据库里的字段。type属性是可选的（如果你不标明，NHibernate将利用反射进行最佳的推测）。

好了，让我们回到标签id，你可以猜测到这个标签将是映射数据库表的主键，的确如此，id标签的组成和我们刚才看的property标签是相似的。我们映射属性到目标数据库的字段。
内嵌的generator标签告诉NHibernate 如何生成主键（它将恰当的为你生成主键，不管你指定何种类型，但你必须告诉它）。

提示：请将user.hbm.xml的Build Action属性设置为Embedded Resource。

第四步：为你的数据库产生一个配置文件

我们至今还没有告诉NHibernate 去哪里连接数据库。最直接的办法是在你的应用程序的配置文件里设置一个NHibernate配置节。这和在Hibernate里使用属性文件是等价的。如下配置（hibernate.cfg.xml）：

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-configuration  xmlns="urn:nhibernate-configuration-2.2" >
  <session-factory name="NHibernate.Test">
    <property name="connection.driver_class">NHibernate.Driver.SQLite20Driver</property>
    <property name="connection.connection_string">
      Data Source=..\output\test.db
    </property>
    <property name="dialect">NHibernate.Dialect.SQLiteDialect</property>
    <property name="show_sql">true</property>
    <mapping assembly="NHibernate.Domain" />
  </session-factory>
</hibernate-configuration>

上面的例子里用了sqlite驱动，在本地连接名称为test的数据库，记得引用System.Data.SQLite.dll，否则运行时会报错。这里还有其他属性你需要调整来确定如何让NHibernate来访问数据库。再次说明，你可以在文档里获取更多信息。

请注意以上的配置里并没有涉及到log4net的配置信息。NHibernate使用log4net来记录内部发生的一切。在一个应用程序产品里，在你特定环境里，我推荐配置log4net，并为NHibernate设置一定的日志级别。

第五步：开始展现NHibernate的魔力

所有艰苦的工作已经完成。你将有以下内容
User.cs ----你需要持久化的C#类
User.hbm.xml ----你的NHibernate映射文件
hibernate.cfg.xml ----对数据库连接的配置信息（如果你愿意，你可以在代码中实现）。
你的数据库里有一张User表。

现在可以在你的代码中恰当简洁的使用NHibernate。
为了让你更清晰，我们来看一些代码。

首先创建一个数据库连接类（NHibernateHelper.cs）：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using NHibernate.Cfg;

namespace NHibernate.DataPortal
{
    class NHibernateHelper
    {
        private ISessionFactory sessionFactory;

        public NHibernateHelper()
        {
            sessionFactory = GetSessionFactory();
        }

        private ISessionFactory GetSessionFactory()
        {
            return (new Configuration()).Configure().BuildSessionFactory();
        }

        public ISession GetSession()
        {
            return sessionFactory.OpenSession();
        }
    }
}

NHibernate在建树数据库连接之前，须要读取配置文件，然后创建会话（ISession）。在会话中完成各类对数据库的操纵。

然后建立一个数据库操作类（UserDal.cs）：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using NHibernate.Domain;

namespace NHibernate.DataPortal
{
    public class UserDal
    {
        private NHibernateHelper nhibernateHelper = new NHibernateHelper();

        protected ISession Session { get; set; }

        public UserDal()
        {
            this.Session = nhibernateHelper.GetSession();
        }

        public UserDal(ISession session)
        {
            this.Session = session;
        }

        public void AddUser(User user)
        {
            var aa = Session.Save(user);
            Session.Flush();
        }

        public void DeleteUser(User user)
        {
            Session.Delete(user);
            Session.Flush();
        }

        public void UpdateUser(User user)
        {
            Session.Update(user);
            Session.Flush();
        }

        public IList<User> GetUsers()
        {
            return Session.QueryOver<User>().List();
        }
    }
}

第六步：效果测试

新建一个wpf app界面：

数据库交互：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;
using NHibernate.DataPortal;
using NHibernate.Domain;

namespace TestApp
{
    /// <summary>
    /// MainWindow.xaml 的交互逻辑
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private UserDal ud = new UserDal();

        private void button1_Click(object sender, RoutedEventArgs e)
        {
            //Add();
            //Delete();
            //Update();
            Select();
        }

        private void Add()
        {
            User user = new User() { UserName = "Jame", Password = "123456", EmailAddress = "[e-mail]", LastLogon = DateTime.Now };
            ud.AddUser(user);
        }

        private void Delete()
        {
            User user = new User() { Id = 3 };
            ud.DeleteUser(user);
        }

        private void Update()
        {
            User user = new User() { Id = 1, UserName = "Jame1", Password = "1234561", EmailAddress = "[e-mail]", LastLogon = DateTime.Now };
            ud.UpdateUser(user);
        }

        private void Select()
        {
            IList<User> list = ud.GetUsers();
            listView1.ItemsSource = list;
        }
    }
}

测试结果：

亲！真心不错吧！

本文源码：http://files.cnblogs.com/yuanli/MyNHibernate.zip

分类: .net, 精华篇