在C#項(xiàng)目中如何使用NHibernate詳解
前言
現(xiàn)代化大型項(xiàng)目通常使用獨(dú)立的數(shù)據(jù)庫(kù)來(lái)存儲(chǔ)數(shù)據(jù),其中以采用關(guān)系型數(shù)據(jù)庫(kù)居多。用于開(kāi)發(fā)項(xiàng)目的高級(jí)語(yǔ)言(C#、Java等)是面向?qū)ο蟮?,而關(guān)系型數(shù)據(jù)庫(kù)是基于關(guān)系的,兩者之間的溝通需要一種轉(zhuǎn)換,也就是對(duì)象/關(guān)系數(shù)據(jù)庫(kù)映射(Object/Relational Mapping,簡(jiǎn)稱ORM)。
C#可用以解決對(duì)象/關(guān)系數(shù)據(jù)庫(kù)映射的工具有多種,常見(jiàn)的有EF (Entity Framework)、NHibernate、iBATIS等,各自的優(yōu)缺點(diǎn)及適用場(chǎng)景在此不做討論,本文只對(duì)如何使用NHibernate做個(gè)總結(jié)。
NHibernate是一個(gè)面向.NET環(huán)境的對(duì)象/關(guān)系數(shù)據(jù)庫(kù)映射工具。
1. 創(chuàng)建項(xiàng)目文件
在Visual Studio開(kāi)發(fā)工具里創(chuàng)建需要的項(xiàng)目結(jié)構(gòu)。
2. 添加對(duì)NHibernate的引用
當(dāng)下載并解壓NHibernate安裝包后,電腦上就會(huì)創(chuàng)建一些目錄,包括“Required_Bins”,要把 Required_Bins目錄下的DLL引用到項(xiàng)目里來(lái),它們是NHibernate使用的核心組件。
NHibernate.dll(基礎(chǔ)類庫(kù),與數(shù)據(jù)庫(kù)直接打交道,位于數(shù)據(jù)訪問(wèn)層)
Iesi.Collections(基礎(chǔ)類庫(kù)輔助類庫(kù),位于數(shù)據(jù)訪問(wèn)層)
Antlr3.Runtime(基礎(chǔ)類庫(kù)輔助類庫(kù),位于數(shù)據(jù)訪問(wèn)層)
NHibernate.ByteCode.Spring.dll(Proxy Factory類庫(kù),用于打開(kāi)/關(guān)閉Nhibernate Session,位于數(shù)據(jù)訪問(wèn)層工具類庫(kù))

圖1 添加對(duì)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("打開(kāi)數(shù)據(jù)庫(kù)失敗,錯(cuò)誤:" + ex.ToString());
return null;
}
}
}
}
5. 創(chuàng)建數(shù)據(jù)模型
NHibernate允許直接使用Plain Old CLR Objects (POCOs),而不用通過(guò)存儲(chǔ)過(guò)程來(lái)直接和數(shù)據(jù)庫(kù)交互。使用POCOs的一個(gè)優(yōu)勢(shì)在于不用綁定特定的持久化層。相比較而言,有些ORM解決方案需要特殊屬性,或者是基于模型對(duì)象,這些對(duì)象又是從特定的基類中繼承而來(lái)的。
在NHibernate中不用特殊的修飾就可以讓對(duì)象和持久化層交互。要注意的是所有需要持久化的屬性必須是虛擬的,并且要開(kāi)啟延遲加載,所有數(shù)據(jù)模型類中的公共方法必須是虛擬的,哪怕它們并沒(méi)有包含到映射文件中。
通常來(lái)講,最好把所有的屬性都設(shè)置為虛擬的。
可以借助MyGeneration自動(dòng)代碼工具從數(shù)據(jù)表生成數(shù)據(jù)模型和對(duì)應(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>
/// 父級(jí)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映射文件來(lái)映射POCO到數(shù)據(jù)庫(kù)對(duì)象。雖然在很多案例中這可能是一對(duì)一關(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ù)庫(kù)中的哪個(gè)表或者視圖將被映射。
- id元素告訴NHibernate哪個(gè)數(shù)據(jù)庫(kù)的字段和對(duì)應(yīng)的對(duì)象作為一個(gè)唯一鍵來(lái)使用。在本例中,我們使用Id這個(gè)字段。
- generator元素告訴NHibernate怎樣給新實(shí)體來(lái)創(chuàng)建唯一ID。
- property標(biāo)簽是見(jiàn)得最多的標(biāo)簽。它簡(jiǎn)單地映射一個(gè)到數(shù)據(jù)表或者視圖中對(duì)應(yīng)字段的映射。
一旦XML文件創(chuàng)建好了,需要更改XML的生成方式確保它被設(shè)置為嵌入式資源,否則NHibernate不會(huì)讀取這個(gè)XML文件,那么映射就不會(huì)生效了。

圖2 映射文件必須是嵌入的資源
7. 使用 NHibernate連接數(shù)據(jù)庫(kù)
文件: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 新增
}
}
對(duì)于不同的實(shí)體,可以一對(duì)一地寫一個(gè)<Entity>Repository,專注負(fù)責(zé)相對(duì)應(yīng)的實(shí)體操作。
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問(wèn)大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
- SpringBoot 使用hibernate validator校驗(yàn)
- Hibernate之CRUD操作實(shí)踐
- Springboot+hibernate實(shí)現(xiàn)簡(jiǎn)單的增刪改查示例
- 如何在.NET Core應(yīng)用中使用NHibernate詳解
- eclipse下搭建hibernate5.0環(huán)境的步驟(圖文)
- Java Web學(xué)習(xí)教程之Hibernate And MyBatis的理解
- 如何自定義hibernate validation注解示例代碼
- Spring MVC+FastJson+hibernate-validator整合的完整實(shí)例教程
- Spring+Hibernate+Struts(SSH)框架整合實(shí)戰(zhàn)
- Hibernate一級(jí)緩存和二級(jí)緩存詳解
相關(guān)文章
.net實(shí)現(xiàn)裁剪網(wǎng)站上傳圖片的方法
這篇文章主要介紹了.net實(shí)現(xiàn)裁剪網(wǎng)站上傳圖片的方法,比較實(shí)用的功能,需要的朋友可以參考下2014-07-07
c#異步操作后臺(tái)運(yùn)行(backgroundworker類)示例
這篇文章主要介紹了c#異步操作后臺(tái)運(yùn)行(backgroundworker類)示例,需要的朋友可以參考下2014-04-04
C#實(shí)現(xiàn)文字轉(zhuǎn)語(yǔ)音功能
這篇文章主要為大家詳細(xì)介紹了C#實(shí)現(xiàn)文字轉(zhuǎn)語(yǔ)音功能,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-03-03
C#實(shí)現(xiàn)帶百分比的進(jìn)度條功能示例
這篇文章主要介紹了C#實(shí)現(xiàn)帶百分比的進(jìn)度條功能,分析了帶百分比進(jìn)度條的功能需求并結(jié)合實(shí)例形式給出了具體實(shí)現(xiàn)步驟與相關(guān)操作方法,需要的朋友可以參考下2017-05-05
c# DevExpress gridcontrol日期行的顯示格式設(shè)置
這篇文章主要介紹了c# DevExpress gridcontrol日期行的顯示格式設(shè)置,需要的朋友可以參考下2017-02-02

