[Fluent NHibernate]第一個程序

目錄

寫在前面

Fluent Nhibernate簡介

基本配置

總結

寫在前面

在耗時兩月，NHibernate系列出爐這篇文章中，很多園友說了Fluent Nhibernate的東東，也激起我的興趣，想對它一探究竟，這里也將Fluent Nhibernate寫成一個系列，記錄自己的學習過程，關於這東東，也是第一次接觸，也只能邊摸索，邊記錄了。如果有描述錯誤的地方，還望多多包涵。

通過Nhibernate的學習，都覺得Nhibernate的使用映射文件的編寫很麻煩，這里通過Fluent Nhibernate的進行對比學習。

Fluent Nhibernate簡介

Fluent Nhibernate下載地址：http://www.fluentnhibernate.org/

在該網站上對Fluent Nhibernate的簡介

Fluent, XML-less, compile safe, automated, convention-based mappings for NHibernate. 

Fluent，更少的xml，編譯安全，自動化，基於Nhibernate的映射。

Fluent NHibernate offers an alternative to NHibernate's standard XML mapping files. Rather than writing XML documents (.hbm.xml files), Fluent NHibernate lets you write mappings in strongly typed C# code. This allows for easy refactoring, improved readability and more concise code.

用編程的方式進行配置，讓你能更好的理解，不需要編寫復雜的映射文件，它能完全替換NHibernate的映射文件，讓你在映射的時候能使用C#的強類型方式。

基本配置

測試項目結構

 

項目結構介紹

Wolfy.Data：項目數據層，存放操作數據庫類，FluentNhibernateHelper

Wolfy.Domain：存放持久化類，及映射類。

Wolfy.UnitTest:單元測試項目

首先使用Nuget安裝Fluent Nhibernate

安裝成功后

Fluent Nhibernate是基於Nhibernate的，所以在安裝Fluent Nhibernate的同時也會將Nhibernate的dll安裝上。此時的Nhibernate的程序集的版本為

Fluent Nhibernate對應的Nhibernate版本為3.3.1.4000

編寫FluentNhibernateHelper類

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using NHibernate;
using FluentNHibernate;
namespace Wolfy.Data
{
    /// <summary>
    /// Nhibernate輔助類
    /// </summary>
    public class FluentNHibernateHelper
    {
        private static ISessionFactory _sessionFactory;
        private static ISession _session;
        private static object _objLock = new object();
        private FluentNHibernateHelper()
        {

        }
        /// <summary>
        /// 創建ISessionFactory
        /// </summary>
        /// <returns></returns>
        public static ISessionFactory GetSessionFactory()
        {
            if (_sessionFactory == null)
            {
                lock (_objLock)
                {
                    if (_sessionFactory == null)
                    {
                        //配置ISessionFactory
                        _sessionFactory = FluentNHibernate.Cfg.Fluently.Configure()
                            //數據庫配置
                .Database(
                            //方言
                FluentNHibernate.Cfg.Db.MsSqlConfiguration.MsSql2012
                            //連接字符串
                .ConnectionString(
                     c => c.Server(".")
                    .Password("sa")
                    .Username("sa")
                    .Database("Shop")
                    .TrustedConnection()
                    )
                            //是否顯示sql
                    .ShowSql()
                    )
                            //映射程序集
                    .Mappings(m => m.FluentMappings
                        .AddFromAssembly(System.Reflection.Assembly.Load("Wolfy.Domain"))
                        .ExportTo("c:\\"))
                    .BuildSessionFactory();

                    }
                }
            }
            return _sessionFactory;

        }
        /// <summary>
        /// 重置Session
        /// </summary>
        /// <returns></returns>
        public static ISession ResetSession()
        {
            if (_session.IsOpen)
                _session.Close();
            _session = _sessionFactory.OpenSession();
            return _session;
        }
        /// <summary>
        /// 打開ISession
        /// </summary>
        /// <returns></returns>
        public static ISession GetSession()
        {
             GetSessionFactory();
            if (_session == null)
            {
                lock (_objLock)
                {
                    if (_session == null)
                    {
                        _session = _sessionFactory.OpenSession();
                    }
                }
            }
            return _session;
        }

    }
}

CreateSessionFactory方法對應Nhibernate的配置文件，通過代碼的方式指定Nhibernate的配置信息，使用起來更方便。下面為之前學習Nhibernate時寫的配置文件，不明白的可以回到NHIbernate系列文章去查看。

<?xml version="1.0" encoding="utf-8" ?>
 <hibernate-configuration  xmlns="urn:nhibernate-configuration-2.2" >
    <session-factory>
    <property name="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>
   <property name="connection.connection_string">
       server=.;database=shop;uid=sa;pwd=sa
  </property>
   <property name="dialect">NHibernate.Dialect.MsSql2008Dialect</property>
  <mapping  assembly="Wolfy.Shop.Domain"/>
  </session-factory>
  </hibernate-configuration>

一個例子

Customer持久化類

    /// <summary>
    /// 客戶持久化類
    /// </summary>
    public class Customer
    {
        public virtual Guid CustomerID { set; get; }
        public virtual int Version { set; get; }
        public virtual string CustomerName { set; get; }
        public virtual string CustomerAddress { set; get; }
    }

添加映射類

CustomerMapping.cs

   /// <summary>
    /// Customer映射實體類，需要集成ClassMap泛型類
    /// </summary>
    public class CustomerMapping : ClassMap<Customer>
    {
        /// <summary>
        /// 映射關系實體類的構造函數
        /// 在構造函數中處理好映射關系
        /// </summary>
        public CustomerMapping()
        {
            //指定持久化類對應的數據表
            Table("TB_Customer");
            //自動增長的id
            //Id(i => i.CustomerID);
            //映射關系
            Id<Guid>("CustomerID").GeneratedBy.Guid();
            Map(m => m.CustomerAddress).Length(50).Nullable();
            Map(m => m.CustomerName).Length(32).Nullable();
            Map(m => m.Version);
        }
    }

映射配置類需繼承ClassMap泛型類，在構造函數中可以通過Map方法，指定字段與數據表字段的對應關系，Map有兩個重載方法，如下：

        //
        // 摘要: 
        //     Create a property mapping.
        //
        // 參數: 
        //   memberExpression:
        //     Property to map
        public PropertyPart Map(Expression<Func<T, object>> memberExpression);
        //
        // 摘要: 
        //     Create a property mapping.
        //
        // 參數: 
        //   memberExpression:
        //     Property to map
        //
        //   columnName:
        //     Property column name
        public PropertyPart Map(Expression<Func<T, object>> memberExpression, string columnName);

這里有個需要注意的地方，如果不指定映射的數據表，默認持久化類要與數據庫中的表名對應，比如持久化類名為Customer，而數據表名為TB_Customer，則有以下異常： could not execute batch command.[SQL: SQL not available]

意思就是對應關系找不到。解決辦法就是指定映射的數據表名。

數據層CustomerData類添加AddCustomer方法

    /// <summary>
    /// 客戶類數據層
    /// </summary>
    public class CustomerData
    {
        /// <summary>
        /// 添加客戶對象
        /// </summary>
        /// <param name="customer"></param>
        /// <returns></returns>
        public bool AddCustomer(Customer customer)
        {           
            ISession session = FluentNHibernateHelper.GetSession();
            using (var trans = session.BeginTransaction())
            {
                try
                {
                    session.SaveOrUpdate(customer);
                    session.Flush();
                    trans.Commit();
                    return true;
                }
                catch (Exception)
                {
                    trans.Rollback();
                    return false;
                }
            }

        }
    }

你會發現，方法與使用Nhibernate的時候的方法實現沒什么區別，代碼相同，唯一的區別就是配置文件的編寫方式，一種是使用代碼實現，一種是使用xml文件進行配置的。

單元測試

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Wolfy.Domain.Entities;
using Wolfy.Data;
namespace Wolfy.UnitTest
{
    [TestClass]
    public class CustomerDataTest
    {
        private CustomerData _customerData;
        public CustomerDataTest()
        {
            _customerData = new CustomerData();
        }
        [TestMethod]
        public void AddCustomerTest()
        {
            var result = _customerData.AddCustomer(
                new TB_Customer()
                {
                    Version = 1, 
                    CustomerName = "wolfy",
                    CustomerAddress = "中國 北京",
                    CustomerID = Guid.NewGuid() 
                }
                );
            Assert.IsTrue(result);
        }
    }
}

描述：通過數據層的AddCustomer方法向數據庫中添加一個客戶對象，並獲得添加結果，斷言結果為true，則測試通過。
運行測試，測試結果

生成的sql語句

exec sp_executesql N'INSERT INTO [TB_Customer] 
(CustomerAddress, CustomerName, Version, CustomerID) 
VALUES (@p0, @p1, @p2, @p3)',
N'@p0 nvarchar(4000),
@p1 nvarchar(4000),
@p2 int,
@p3 uniqueidentifier',
@p0=N'中國 北京',
@p1=N'wolfy',
@p2=1,
@p3='F15D04CF-300F-45C1-A774-3394CBA08155'

回頭看一下，在FluentNhibernateHelper中，有這樣一句代碼：

                        //映射程序集
                    .Mappings(m => m.FluentMappings
                        .AddFromAssembly(System.Reflection.Assembly.Load("Wolfy.Domain"))
                        .ExportTo("c:\\"))

意思是將映射文件導出到c盤下，那么我們看一下c盤下生成了什么？

你會發現此時的xml文件正是Nhibernate中對應持久化類的映射文件，內容為：

<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2">
  <class xmlns="urn:nhibernate-mapping-2.2" name="Wolfy.Domain.Entities.Customer, Wolfy.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" table="TB_Customer">
    <id type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
      <column name="CustomerID" />
      <generator class="guid" />
    </id>
    <property name="CustomerAddress" type="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
      <column name="CustomerAddress" length="50" not-null="false" />
    </property>
    <property name="CustomerName" type="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
      <column name="CustomerName" length="32" not-null="false" />
    </property>
    <property name="Version" type="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
      <column name="Version" />
    </property>
  </class>
</hibernate-mapping>

 

總結

關於Fluent Nhibernate的基本使用就介紹到這里，不管怎樣，先讓第一個程序跑起來，才算是走好了第一步。

本篇內容學習了如何使用Fluent Nhibernate生成配置文件及映射文件。

參考文章

http://www.cnblogs.com/inday/archive/2009/08/04/Study-Fluent-NHibernate-Start.html