NHibernate搭建教程

1. 第一个NHibernate应用程序

1.1. 开始NHibernate之旅

这个教程演示了如何在微软开发环境里搭建一个NHibernate 2.0.0例子. 使用了以下工具:

1. Internet 信息服务(IIS)管理器 - ASP.NET支持的Web服务器.

2. SQL Server 2005 - 数据库服务器. 这个例子里面使用的是桌面版本(EXPRESS), 可以从微软免费下载. NHibernate也支持其他数据库，更换数据库要做的仅仅是在配置文件里更改数据库方言和数据库驱动。

3. Visual Studio .NET 2005 - 开发环境.

首先，我们创建一个Web项目.项目命名为QuickStart。 项目会自动的创建一个http://localhost/QuickStart虚拟目录。 打开项目，添加NHibernate.dll引用。Visual Studio会自动的将你引用的库的这个库的依赖文件拷贝到你的输出目录. 如果你使用其他数据库，请添加对应的数据访问程序集到你的项目。

我们现在开始为NHibernate配置数据库连接信息。在这之前，打开项目里面自动生成的Web.config文件按照下面的方式添加一个配置元素： 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <!-- Add this element -->
    <configSections>
        <section
            name="hibernate-configuration"
            type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate"
        />
    </configSections>

    <!-- Add this element -->
    <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
        <session-factory>
            <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>
            <property name="connection.provider">NHibernate.Connection.DriverConnectionProvider</property>
            <property name="connection.connection_string">
                Server=(local);initial catalog=quickstart;Integrated Security=SSPI
            </property>
            <mapping assembly="QuickStart" />
        </session-factory>
    </hibernate-configuration>

    <!-- Leave the system.web section unchanged -->
    <system.web>
        ...
    </system.web>
</configuration>

<configSections>在配置文件里定义了一个配置节并且声明了这个配置节里面的数据如何解析。

<hibernate-configuration> 配置包含了NHibernate的配置信息，告诉NHibernate我们使用 Microsoft SQL Server 2005数据库并且通过指定的连接字符串连接数据库. 方言（dialect）是必选设置，每个数据库对SQL标准的解释都不一样。 NHibernate通过方言（dialect）来消除这些这些开源或者是商业数据库之间对SQL标准的解释的差异。

ISessionFactory在NHibernate里面是一个单个数据存储的概念（在SQLServer里面就是对应一个database），多数据库操作可以使用创建多个XML配置文件以及在程序里创建多个Configuration和 ISessionFactory对象来实现。

<mapping assembly="QuickStart" />该节点声明了 QuickStart作为包含持久化类以及对应映射文件所在的应用程序集名称。

注意：如果忽略此节点，NHibernate将无法自动载入数据映射文件

 映射文件包含POCO类映射到一个或者多个数据库表的元数据信息。我们待会就会提到映射文件。首先我们来写一个POCO类，然后为这个类写一个数据库映射文件。

1.2. 第一个持久化类

NHibernate使用简单的.Net对象(Plain Old CLR Objects ,就是POCOs,有时候也称作Plain Ordinary CLR Objects）这种编程模型来进行持久化,POCO类通过set和get属性 访问其内部成员变量，对外则隐藏了内部实现的细节(假若需要的话,NHibernate也可以直接访问其内部成员变量)。 

namespace QuickStart
{
    public class Cat
    {
        private string id;
        private string name;
        private char   sex;
        private float  weight;

        public Cat()
        {
        }

        public virtual string Id
        {
            get { return id; }
            set { id = value; }
        }

        public virtual string Name
        {
            get { return name; }
            set { name = value; }
        }

        public virtual char Sex
        {
            get { return sex; }
            set { sex = value; }
        }

        public virtual float Weight
        {
            get { return weight; }
            set { weight = value; }
        }
    }
}

NHibernate对属性使用的类型不加任何限制。所有的.NET类型和原始类型（比如string,char和DateTime)都可以被映射，也包括.Net 集合（System.Collections)中的类。你可以把它们映射成为值，值集合，或者与其他实体类相关联。Id是一个特殊的属性，代表了这个类的数据库标识符(主键)，对于类似于Cat这样的实体类我们强烈建议使用。NHibernate也可以使用内部标识符，但这样我们会失去一些程序架构方面的灵活性。

持久化类不需要实现什么特别的接口，也不需要从一个特别的持久化根类继承下来。NHibernate也不需要使用任何编译期处理，比如IL操作，它独立的使用.Net反射机制和运行时类增强（通过Castle.DynamicProxy2 library）。所以不依赖于NHibernate(POJO的类不需要依赖NHibernate)，我们就可以把POJO的类映射成为数据库表。

为了让上面提到运行时类增强功能生效，NHibernate持久化类的所有的public的属性必须声明为virtual。

1.3. 映射cat

Cat.hbm.xml映射文件包含了对象/关系映射（O/R Mapping）所需的元数据。元数据包含持久化类的声明和属性到数据库的映射（指向字段和其他实体的外键关联）。

注意：Cat.hbm.xml在Visual Stuido里面要设置为嵌入式资源（embedded resource）。 

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2"
    namespace="QuickStart" assembly="QuickStart">

    <class name="Cat" table="Cat">

        <!-- A 32 hex character is our surrogate key. It's automatically
            generated by NHibernate with the UUID pattern. -->
        <id name="Id">
            <column name="CatId" sql-type="char(32)" not-null="true"/>
            <generator class="uuid.hex" />
        </id>

        <!-- A cat has to have a name, but it shouldn' be too long. -->
        <property name="Name">
            <column name="Name" length="16" not-null="true" />
        </property>
        <property name="Sex" />
        <property name="Weight" />
    </class>

</hibernate-mapping>

每个持久化类都应该有一个标识属性（实际上，这个类只代表实体，而不是独立的值类型类， 后者会被映射称为实体对象中的一个组件）。这个属性用来区分持久化对象：如果catA.Id.Equals(catB.Id)结果是true的话， 这两个Cat就是相同的。这个概念称为数据库标识。NHibernate附带了几种不同的标识符生成器， 用于不同的场合（包括数据库本地的顺序(sequence)生成器、hi/lo高低位标识模式、和程序自己定义的标识符）。 我们在这里使用UUID生成器（只在测试时建议使用，如果使用数据库自己生成的整数类型的键值更好）， 并指定Cat表中的CatId字段（作为表的主键）存放生成的标识值。

All other properties of Cat are mapped to the same table. In the case of theName property, we mapped it with an explicit database column declaration. This is especially useful when the database schema is automatically generated (as SQL DDL statements) from the mapping declaration with NHibernate'sSchemaExport tool. All other properties are mapped using NHibernate's default settings, which is what you need most of the time. The tableCat in the database looks like this: Cat的其他属性都映射到同一个表的字段。对Name属性来说， 我们把它显式地声明映射到一个数据库字段。如果数据库schema是通过由映射声明自动生成的（作为SQL DDL指令）的话， 这就特别有用。所有其它的属性都用NHibernate的默认值映射，大多数情况你都会这样做。数据库中的Cat表看起来是这样的：

 
 Column |     Type     | Modifiers
--------+--------------+----------------------
 CatId  | char(32)     | not null, primary key
 Name   | nvarchar(16) | not null
 Sex    | nchar(1)     |
 Weight | real         |

1.4. 与Cat同乐

我们现在可以开始使用NHibernate的ISession了。它是一个 持久化管理器， 我们通过ISession来从数据库中存取Cat。首先，我们要从ISessionFactory中获取一个ISession（NHibernate的工作单元）。

ISessionFactory sessionFactory =
            new Configuration().Configure().BuildSessionFactory();

ISessionFactory代表一个数据库，并且使用一个XML配置文件（Web.config或者hibernate.cfg.xml）。 NHibernate通过对Configuration().Configure()的调用来装载配置文件,并初始化成一个Configuration实例。通过Configuration实例创建一个ISessionFactory。 在创建 ISessionFactory之前（它是不可变的），你可以访问Configuration来设置其他属性（甚至修改映射的元数据）。 我们应该在哪儿创建ISessionFactory，在我们的程序中又如何访问它呢？

ISessionFactory通常只是被初始化一次，比如说在Application_Start事件里来初始化。 这意味着你不应该在ASP.NET页面中把它作为一个实例变量来持有，而应该放在其他地方。进一步的说， 我们需要使用单例（Singleton）模式，我们才能更容易的在程序中访问ISessionFactory。 下面的方法就同时解决了两个问题：对ISessionFactory的初始配置与便捷使用。

下面实现了一个名为NHibernateHelper的帮助类：

using System;
using System.Web;
using NHibernate;
using NHibernate.Cfg;

namespace QuickStart
{
    public sealed class NHibernateHelper
    {
        private const string CurrentSessionKey = "nhibernate.current_session";
        private static readonly ISessionFactory sessionFactory;

        static NHibernateHelper()
        {
            sessionFactory = new Configuration().Configure().BuildSessionFactory();
        }

        public static ISession GetCurrentSession()
        {
            HttpContext context = HttpContext.Current;
            ISession currentSession = context.Items[CurrentSessionKey] as ISession;

            if (currentSession == null)
            {
                currentSession = sessionFactory.OpenSession();
                context.Items[CurrentSessionKey] = currentSession;
            }

            return currentSession;
        }

        public static void CloseSession()
        {
            HttpContext context = HttpContext.Current;
            ISession currentSession = context.Items[CurrentSessionKey] as ISession;

            if (currentSession == null)
            {
                // No current session
                return;
            }

            currentSession.Close();
            context.Items.Remove(CurrentSessionKey);
        }

        public static void CloseSessionFactory()
        {
            if (sessionFactory != null)
            {
                sessionFactory.Close();
            }
        }
    }
}

这个类不用考虑ISessionFactory，应为它被设置为static类型的，并且将ISessionhttp请求之中。

ISessionFactory是安全线程，可以由很多线程并发访问并获取到ISessions。 单个ISession不是安全线程对象，它只代表与数据库之间的一次操作。ISession通过ISessionFactory获得并在所有的工作完成后关闭。

ISession session = NHibernateHelper.GetCurrentSession();

ITransaction tx = session.BeginTransaction();

Cat princess = new Cat();
princess.Name = "Princess";
princess.Sex = 'F';
princess.Weight = 7.4f;

session.Save(princess);
tx.Commit();

NHibernateHelper.CloseSession();

在一个ISession中，每个数据库操作都是在一个事务(transaction)中进行的， 这样就可以隔离开不同的操作（甚至包括只读操作）。 我们使用NHibernate的ITransaction API来从底层的事务策略中（本例中是ADO.NET事务）脱身出来。 注意这个例子没有包含任何异常处理。

注意：你可以随心所欲的多次调用NHibernateHelper.GetCurrentSession();，你每次都会得到同一个当前请求的Session。 不管是在你的Application_EndRequest代码中，或者在Application_EndRequest中还是在HTTP结果返回之前， 你都必须确保这个Session在你的数据库访问工作完成后关闭。这样做还有一个好处就是可以容易的使用延迟装载（lazy initialization）：ISession在渲染view层的时候仍然打开着的，所以你在遍历当前对象图的时候可以装载所需的对象。

NHibernate有不同的方法用来从数据库中取回对象。最灵活的方式就是使用NHibernate查询语言(HQL),这是一种容易学习的语言，是对SQL的面向对象的强大扩展

using(ITransaction tx = session.BeginTransaction())
    {
    IQuery query = session.CreateQuery("select c from Cat as c where c.Sex = :sex");
    query.SetCharacter("sex", 'F');
    foreach (Cat cat in query.Enumerable())
        {
        Console.Out.WriteLine("Female Cat: " + cat.Name);
        }
    tx.Commit();
    }

Hibernate也提供一种面向对象的按条件查询API，可以执行简洁安全类型的查询。 当然，NHibernate在所有与数据库的交互中都使用IDbCommand和参数绑定。你也可以使用NHibernate的直接SQL查询特性， 或者在特殊情况下从ISession获取一个原始的ADO.NET连接。 

1.5. 总结

在这个短小的教程中，我们对NHibernate的浅尝即止。请注意我们没有在例子中包含任何ASP.NET相关代码。 你必须自行编写ASP.NET Page，并插入合适你的NHibernate代码。

请记住NHibernate作为一个数据库访问层，是与你的程序紧密相关的。 通常情况下，所有其他层次都依赖持久机制。请确信你理解了这种设计的内涵