在C#项目中如何使用NHibernate详解

2020-01-24 00:19:15

字体：大中小

来源：转载

供稿：网友

前言

现代化大型项目通常使用独立的数据库来存储数据，其中以采用关系型数据库居多。用于开发项目的高级语言（C#、Java等）是面向对象的，而关系型数据库是基于关系的，两者之间的沟通需要一种转换，也就是对象/关系数据库映射（Object/Relational Mapping，简称ORM）。

C#可用以解决对象/关系数据库映射的工具有多种，常见的有EF (Entity Framework)、NHibernate、iBATIS等，各自的优缺点及适用场景在此不做讨论，本文只对如何使用NHibernate做个总结。

NHibernate是一个面向.NET环境的对象/关系数据库映射工具。

1. 创建项目文件

在Visual Studio开发工具里创建需要的项目结构。

2. 添加对NHibernate的引用

当下载并解压NHibernate安装包后，电脑上就会创建一些目录，包括“Required_Bins”，要把 Required_Bins目录下的DLL引用到项目里来，它们是NHibernate使用的核心组件。

NHibernate.dll（基础类库，与数据库直接打交道，位于数据访问层）

Iesi.Collections（基础类库辅助类库，位于数据访问层）

Antlr3.Runtime（基础类库辅助类库，位于数据访问层）

NHibernate.ByteCode.Spring.dll（Proxy Factory类库，用于打开/关闭Nhibernate Session，位于数据访问层工具类库）

图1 添加对NHibernate的引用

3. 配置NHibernate

文件：hibernate.cfg.xml，位于站点根目录。

<?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("打开数据库失败，错误：" + ex.ToString());  return null;  } } }}

5. 创建数据模型

NHibernate允许直接使用Plain Old CLR Objects (POCOs),而不用通过存储过程来直接和数据库交互。使用POCOs的一个优势在于不用绑定特定的持久化层。相比较而言，有些ORM解决方案需要特殊属性，或者是基于模型对象，这些对象又是从特定的基类中继承而来的。

在NHibernate中不用特殊的修饰就可以让对象和持久化层交互。要注意的是所有需要持久化的属性必须是虚拟的，并且要开启延迟加载，所有数据模型类中的公共方法必须是虚拟的，哪怕它们并没有包含到映射文件中。

通常来讲，最好把所有的属性都设置为虚拟的。

可以借助MyGeneration自动代码工具从数据表生成数据模型和对应的映射文件。

using System;using System.Collections.Generic;namespace Fuli.Entity.Domain{ /// <summary> /// 共享编码表（字典表） /// </summary> [Serializable] public class SharedCode { #region 构造方法 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 构造方法 #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> /// 是否是同类里默认 ///</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 扩展属性 #endregion 扩展属性 #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> /// 用唯一值实现GetHashCode /// </summary> public override int GetHashCode() {  int hash = 57;  hash = 27 * hash * m_Id.GetHashCode();  return hash; } #endregion Rewrite Equals and HashCode }}

6. 创建NHibernate映射文件

Nhibernate使用XML映射文件来映射POCO到数据库对象。虽然在很多案例中这可能是一对一关系，但这并不是必定的。

文件：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标签中，同时引用类集（POCOs）所属的程序集命名空间。

class元素表示到单个POCO的映射。name表示上面的程序集和命名空间中的类名，table属性告诉NHibernate数据库中的哪个表或者视图将被映射。
id元素告诉NHibernate哪个数据库的字段和对应的对象作为一个唯一键来使用。在本例中，我们使用Id这个字段。
generator元素告诉NHibernate怎样给新实体来创建唯一ID。
property标签是见得最多的标签。它简单地映射一个到数据表或者视图中对应字段的映射。

一旦XML文件创建好了，需要更改XML的生成方式确保它被设置为嵌入式资源，否则NHibernate不会读取这个XML文件，那么映射就不会生效了。

图2 映射文件必须是嵌入的资源

7. 使用 NHibernate连接数据库

文件：CommonRepository

namespace Fuli.DAL.SQLServerImpl{ public class CommonRepository : ICommonRepository {  #region 新增  /// <summary>  /// 新增实体表  /// </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>  /// 新增实体表  /// </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 新增 }}

对于不同的实体，可以一对一地写一个<Entity>Repository，专注负责相对应的实体操作。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对武林网的支持。

上一篇：C# Oracle批量插入数据进度条的实现代码

下一篇：C#基于FTP协议的简易软件自动升级程序