在C#項(xiàng)目中使用NHibernate的案例

這篇文章主要介紹了在C#項(xiàng)目中使用NHibernate的案例，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

前言

現(xiàn)代化大型項(xiàng)目通常使用獨(dú)立的數(shù)據(jù)庫來存儲數(shù)據(jù)，其中以采用關(guān)系型數(shù)據(jù)庫居多。用于開發(fā)項(xiàng)目的高級語言（C#、Java等）是面向?qū)ο蟮?，而關(guān)系型數(shù)據(jù)庫是基于關(guān)系的，兩者之間的溝通需要一種轉(zhuǎn)換，也就是對象/關(guān)系數(shù)據(jù)庫映射（Object/Relational Mapping，簡稱ORM）。

C#可用以解決對象/關(guān)系數(shù)據(jù)庫映射的工具有多種，常見的有EF (Entity Framework)、NHibernate、iBATIS等，各自的優(yōu)缺點(diǎn)及適用場景在此不做討論，本文只對如何使用NHibernate做個(gè)總結(jié)。

NHibernate是一個(gè)面向.NET環(huán)境的對象/關(guān)系數(shù)據(jù)庫映射工具。

1. 創(chuàng)建項(xiàng)目文件

在Visual Studio開發(fā)工具里創(chuàng)建需要的項(xiàng)目結(jié)構(gòu)。

2. 添加對NHibernate的引用

當(dāng)下載并解壓NHibernate安裝包后，電腦上就會創(chuàng)建一些目錄，包括“Required_Bins”，要把 Required_Bins目錄下的DLL引用到項(xiàng)目里來，它們是NHibernate使用的核心組件。

NHibernate.dll（基礎(chǔ)類庫，與數(shù)據(jù)庫直接打交道，位于數(shù)據(jù)訪問層）

Iesi.Collections（基礎(chǔ)類庫輔助類庫，位于數(shù)據(jù)訪問層）

Antlr3.Runtime（基礎(chǔ)類庫輔助類庫，位于數(shù)據(jù)訪問層）

NHibernate.ByteCode.Spring.dll（Proxy Factory類庫，用于打開/關(guān)閉Nhibernate Session，位于數(shù)據(jù)訪問層工具類庫）

 圖1 添加對NHibernate的引用

3. 配置NHibernate

文件：hibernate.cfg.xml，位于站點(diǎn)根目錄。

<?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">
 Data Source=120.120.200.200;Initial Catalog=MAMall;Persist Security Info=True;User ID=mamall;Password=mima123;connection reset=false;connection lifetime=50;min pool size=1;max pool size=500
 </property>
 <property name="adonet.batch_size">10</property>
 <property name="show_sql">true</property>
 <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>
 <property name="command_timeout">10</property>
 <property name="query.substitutions">true 1, false 0, yes 'Y', no 'N'</property>
 <property name="proxyfactory.factory_class"> NHibernate.ByteCode.Spring.ProxyFactoryFactory,NHibernate.ByteCode.Spring</property>
 <property name="connection.release_mode">on_close</property>
 <mapping assembly="Fuli.Entity"/>
 </session-factory>
</hibernate-configuration>

4. 編寫NHibernateHelper輔助類

文件：NHibernateHelper.cs

using System;
using Fuli.Tool.Log;
using NHibernate;
using NHibernate.Cfg;
namespace Fuli.DAL.Common
{
 public class NHibernateHelper
 {
 private static ISessionFactory _sessionFactory;
 private static ISessionFactory SessionFactory
 {
  get
  {
  if (_sessionFactory == null)
  {
   var configuration = new Configuration();
   configuration.Configure();
   _sessionFactory = configuration.BuildSessionFactory();
  }
  return _sessionFactory;
  }
 }

 public static ISession OpenSession()
 {
  try
  {
  return SessionFactory.OpenSession();
  }
  catch (Exception ex)
  {
  LogHelper.GetInstance().WriteMessage("打開數(shù)據(jù)庫失敗，錯(cuò)誤：" + ex.ToString());
  return null;
  }
 }
 }
}

5. 創(chuàng)建數(shù)據(jù)模型

NHibernate允許直接使用Plain Old CLR Objects (POCOs),而不用通過存儲過程來直接和數(shù)據(jù)庫交互。使用POCOs的一個(gè)優(yōu)勢在于不用綁定特定的持久化層。相比較而言，有些ORM解決方案需要特殊屬性，或者是基于模型對象，這些對象又是從特定的基類中繼承而來的。

在NHibernate中不用特殊的修飾就可以讓對象和持久化層交互。要注意的是所有需要持久化的屬性必須是虛擬的，并且要開啟延遲加載，所有數(shù)據(jù)模型類中的公共方法必須是虛擬的，哪怕它們并沒有包含到映射文件中。

通常來講，最好把所有的屬性都設(shè)置為虛擬的。

可以借助MyGeneration自動(dòng)代碼工具從數(shù)據(jù)表生成數(shù)據(jù)模型和對應(yīng)的映射文件。

using System;
using System.Collections.Generic;

namespace Fuli.Entity.Domain
{
 /// <summary>
 /// 共享編碼表（字典表）
 /// </summary>
 [Serializable]
 public class SharedCode
 {
 #region 構(gòu)造方法

 public SharedCode()
 {
  m_Id = 0;
  m_Category = string.Empty;
  m_Text = string.Empty;
  m_Value = string.Empty;
  m_IsDefault = false;
  m_Description = string.Empty;
  m_ParentId = 0;
  m_SortOrder = 0;
 }

 #endregion 構(gòu)造方法

 #region 私有變量

 private long m_Id;
 private string m_Category;
 private string m_Text;
 private string m_Value;
 private bool m_IsDefault;
 private string m_Description;
 private long m_ParentId;
 private short m_SortOrder;

 #endregion 私有變量

 #region 公有屬性

 ///<summary>
 /// 主鍵Id
 ///</summary>
 public virtual long Id
 {
  get { return m_Id; }
  set { m_Id = value; }
 }

 ///<summary>
 /// 分類
 ///</summary>
 public virtual string Category
 {
  get { return m_Category; }
  set { m_Category = value; }
 }

 ///<summary>
 /// 文本
 ///</summary>
 public virtual string Text
 {
  get { return m_Text; }
  set { m_Text = value; }
 }

 ///<summary>
 /// 編碼值
 ///</summary>
 public virtual string Value
 {
  get { return m_Value; }
  set { m_Value = value; }
 }

 ///<summary>
 /// 是否是同類里默認(rèn)
 ///</summary>
 public virtual bool IsDefault
 {
  get { return m_IsDefault; }
  set { m_IsDefault = value; }
 }

 ///<summary>
 /// 描述
 ///</summary>
 public virtual string Description
 {
  get { return m_Description; }
  set { m_Description = value; }
 }

 ///<summary>
 /// 父級Id(如果有)
 ///</summary>
 public virtual long ParentId
 {
  get { return m_ParentId; }
  set { m_ParentId = value; }
 }

 ///<summary>
 /// 排列次序
 ///</summary>
 public virtual short SortOrder
 {
  get { return m_SortOrder; }
  set { m_SortOrder = value; }
 }

 #endregion 公有屬性

 #region 擴(kuò)展屬性

 #endregion 擴(kuò)展屬性

 #region Rewrite Equals and HashCode

 /// <summary>
 /// 
 /// </summary>
 public override bool Equals(object obj)
 {
  if(this == obj) return true;
  if((obj == null) || (obj.GetType() != GetType())) return false;
  SharedCode castObj = (SharedCode)obj;
  return (castObj != null) && (m_Id == castObj.Id);
 }

 /// <summary>
 /// 用唯一值實(shí)現(xiàn)GetHashCode
 /// </summary>
 public override int GetHashCode()
 {
  int hash = 57;
  hash = 27 * hash * m_Id.GetHashCode();
  return hash;
 }

 #endregion Rewrite Equals and HashCode
 }
}

6. 創(chuàng)建NHibernate映射文件

Nhibernate使用XML映射文件來映射POCO到數(shù)據(jù)庫對象。雖然在很多案例中這可能是一對一關(guān)系，但這并不是必定的。

文件：SharedCode.hbm.xml

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2">
 <class name="Fuli.Entity.Domain.SharedCode, Fuli.Entity" table="SharedCode">
  <id name="Id" column="Id" type="Int64" unsaved-value="0">
   <generator class="native"/>
  </id>
  <property name="Category" type="String" column="Category"/>
  <property name="Text" type="String" column="Text"/>
  <property name="Value" type="String" column="Value"/>
  <property name="IsDefault" type="Boolean" column="IsDefault"/>
  <property name="Description" type="String" column="Description"/>
  <property name="ParentId" type="Int64" column="ParentId"/>
  <property name="SortOrder" type="Int16" column="SortOrder"/>
 </class>
</hibernate-mapping>

在hibernate-maping標(biāo)簽中，同時(shí)引用類集（POCOs）所屬的程序集命名空間。

• class元素表示到單個(gè)POCO的映射。name表示上面的程序集和命名空間中的類名，table屬性告訴NHibernate數(shù)據(jù)庫中的哪個(gè)表或者視圖將被映射。

• id元素告訴NHibernate哪個(gè)數(shù)據(jù)庫的字段和對應(yīng)的對象作為一個(gè)唯一鍵來使用。在本例中，我們使用Id這個(gè)字段。

• generator元素告訴NHibernate怎樣給新實(shí)體來創(chuàng)建唯一ID。

• property標(biāo)簽是見得最多的標(biāo)簽。它簡單地映射一個(gè)到數(shù)據(jù)表或者視圖中對應(yīng)字段的映射。

一旦XML文件創(chuàng)建好了，需要更改XML的生成方式確保它被設(shè)置為嵌入式資源，否則NHibernate不會讀取這個(gè)XML文件，那么映射就不會生效了。

圖2 映射文件必須是嵌入的資源

7. 使用 NHibernate連接數(shù)據(jù)庫

文件：CommonRepository

namespace Fuli.DAL.SQLServerImpl
{
 public class CommonRepository : ICommonRepository
 {
  #region 新增
  /// <summary>
  /// 新增實(shí)體表
  /// </summary>
  /// <param name="obj"></param>
  /// <returns></returns>
  public long AddNewEntity<T>(object obj, string tableName) where T : new()
  {
   long id = 0;
   try
   {
    using (ISession session = NHibernateHelper.OpenSession())
    {
     id = long.Parse(session.Save((T)obj).ToString());
     session.Flush();
    }
   }
   catch (Exception ex)
   {
    LogHelper.GetInstance().WriteMessage(tableName + OperationType.COMMA + ex.ToString());
   }
   return id;
  }

  /// <summary>
  /// 新增實(shí)體表
  /// </summary>
  /// <param name="entity"></param>
  /// <returns></returns>
  public TReturn AddNewEntity<TEntity, TReturn>(object entity, string tableName) where TEntity : new()
  {
   TReturn returnValue = default(TReturn);
   try
   {
    using (ISession session = NHibernateHelper.OpenSession())
    {
     object returnObject = session.Save(entity);
     if (returnObject != null)
     {
      returnValue = (TReturn)Convert.ChangeType(returnObject, typeof(TReturn));
     }
     session.Flush();
    }
   }
   catch (Exception ex)
   {
    LogHelper.GetInstance().WriteMessage(tableName + OperationType.COMMA + ex.ToString());
   }
   return returnValue;
  }
  #endregion 新增
 }
}

對于不同的實(shí)體，可以一對一地寫一個(gè)<Entity>Repository，專注負(fù)責(zé)相對應(yīng)的實(shí)體操作。

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“在C#項(xiàng)目中使用NHibernate的案例”這篇文章對大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，更多相關(guān)知識等著你來學(xué)習(xí)!