如何在C#專案中使用NHibernate

靈動生活發表於2018-03-28
C#

現代化大型專案通常使用獨立的資料庫來儲存資料，其中以採用關係型資料庫居多。用於開發專案的高階語言（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

 1 using System;
 2 using Fuli.Tool.Log;
 3 using NHibernate;
 4 using NHibernate.Cfg;
 5 
 6 namespace Fuli.DAL.Common
 7 {
 8     public class NHibernateHelper
 9     {
10         private static ISessionFactory _sessionFactory;
11         private static ISessionFactory SessionFactory
12         {
13             get
14             {
15                 if (_sessionFactory == null)
16                 {
17                     var configuration = new Configuration();
18                     configuration.Configure();
19                     _sessionFactory = configuration.BuildSessionFactory();
20                 }
21                 return _sessionFactory;
22             }
23         }
24 
25         public static ISession OpenSession()
26         {
27             try
28             {
29                 return SessionFactory.OpenSession();
30             }
31             catch (Exception ex)
32             {
33                 LogHelper.GetInstance().WriteMessage("開啟資料庫失敗，錯誤：" + ex.ToString());
34                 return null;
35             }
36         }
37     }
38 }

5. 建立資料模型

NHibernate允許直接使用Plain Old CLR Objects (POCOs),而不用通過儲存過程來直接和資料庫互動。使用POCOs的一個優勢在於不用繫結特定的持久化層。相比較而言，有些ORM解決方案需要特殊屬性，或者是基於模型物件，這些物件又是從特定的基類中繼承而來的。

在NHibernate中不用特殊的修飾就可以讓物件和持久化層互動。要注意的是所有需要持久化的屬性必須是虛擬的，並且要開啟延遲載入，所有資料模型類中的公共方法必須是虛擬的，哪怕它們並沒有包含到對映檔案中。

通常來講，最好把所有的屬性都設定為虛擬的。

可以藉助MyGeneration自動程式碼工具從資料表生成資料模型和對應的對映檔案。

  1 using System;
  2 using System.Collections.Generic;
  3 
  4 namespace Fuli.Entity.Domain
  5 {
  6     /// <summary>
  7     /// 共享編碼表（字典表）
  8     /// </summary>
  9     [Serializable]
 10     public class SharedCode
 11     {
 12         #region 構造方法
 13 
 14         public SharedCode()
 15         {
 16             m_Id = 0;
 17             m_Category = string.Empty;
 18             m_Text = string.Empty;
 19             m_Value = string.Empty;
 20             m_IsDefault = false;
 21             m_Description = string.Empty;
 22             m_ParentId = 0;
 23             m_SortOrder = 0;
 24         }
 25 
 26         #endregion 構造方法
 27 
 28         #region 私有變數
 29 
 30         private long m_Id;
 31         private string m_Category;
 32         private string m_Text;
 33         private string m_Value;
 34         private bool m_IsDefault;
 35         private string m_Description;
 36         private long m_ParentId;
 37         private short m_SortOrder;
 38 
 39         #endregion 私有變數
 40 
 41         #region 公有屬性
 42 
 43         ///<summary>
 44         /// 主鍵Id
 45         ///</summary>
 46         public virtual long Id
 47         {
 48             get { return m_Id; }
 49             set { m_Id = value; }
 50         }
 51 
 52         ///<summary>
 53         /// 分類
 54         ///</summary>
 55         public virtual string Category
 56         {
 57             get { return m_Category; }
 58             set { m_Category = value; }
 59         }
 60 
 61         ///<summary>
 62         /// 文字
 63         ///</summary>
 64         public virtual string Text
 65         {
 66             get { return m_Text; }
 67             set { m_Text = value; }
 68         }
 69 
 70         ///<summary>
 71         /// 編碼值
 72         ///</summary>
 73         public virtual string Value
 74         {
 75             get { return m_Value; }
 76             set { m_Value = value; }
 77         }
 78 
 79         ///<summary>
 80         /// 是否是同類裡預設
 81         ///</summary>
 82         public virtual bool IsDefault
 83         {
 84             get { return m_IsDefault; }
 85             set { m_IsDefault = value; }
 86         }
 87 
 88         ///<summary>
 89         /// 描述
 90         ///</summary>
 91         public virtual string Description
 92         {
 93             get { return m_Description; }
 94             set { m_Description = value; }
 95         }
 96 
 97         ///<summary>
 98         /// 父級Id(如果有)
 99         ///</summary>
100         public virtual long ParentId
101         {
102             get { return m_ParentId; }
103             set { m_ParentId = value; }
104         }
105 
106         ///<summary>
107         /// 排列次序
108         ///</summary>
109         public virtual short SortOrder
110         {
111             get { return m_SortOrder; }
112             set { m_SortOrder = value; }
113         }
114 
115         #endregion 公有屬性
116 
117         #region 擴充套件屬性
118 
119         #endregion 擴充套件屬性
120 
121         #region Rewrite Equals and HashCode
122 
123         /// <summary>
124         /// 
125         /// </summary>
126         public override bool Equals(object obj)
127         {
128             if(this == obj) return true;
129             if((obj == null) || (obj.GetType() != GetType())) return false;
130             SharedCode castObj = (SharedCode)obj;
131             return (castObj != null) && (m_Id == castObj.Id);
132         }
133 
134         /// <summary>
135         /// 用唯一值實現GetHashCode
136         /// </summary>
137         public override int GetHashCode()
138         {
139             int hash = 57;
140             hash = 27 * hash * m_Id.GetHashCode();
141             return hash;
142         }
143 
144         #endregion Rewrite Equals and HashCode
145     }
146 }

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

 1 namespace Fuli.DAL.SQLServerImpl
 2 {
 3     public class CommonRepository : ICommonRepository
 4     {
 5         #region 新增
 6 
 7         /// <summary>
 8         /// 新增實體表
 9         /// </summary>
10         /// <param name="obj"></param>
11         /// <returns></returns>
12         public long AddNewEntity<T>(object obj, string tableName) where T : new()
13         {
14             long id = 0;
15             try
16             {
17                 using (ISession session = NHibernateHelper.OpenSession())
18                 {
19                     id = long.Parse(session.Save((T)obj).ToString());
20                     session.Flush();
21                 }
22             }
23             catch (Exception ex)
24             {
25                 LogHelper.GetInstance().WriteMessage(tableName + OperationType.COMMA + ex.ToString());
26             }
27             return id;
28         }
29 
30         /// <summary>
31         /// 新增實體表
32         /// </summary>
33         /// <param name="entity"></param>
34         /// <returns></returns>
35         public TReturn AddNewEntity<TEntity, TReturn>(object entity, string tableName) where TEntity : new()
36         {
37             TReturn returnValue = default(TReturn);
38             try
39             {
40                 using (ISession session = NHibernateHelper.OpenSession())
41                 {
42                     object returnObject = session.Save(entity);
43                     if (returnObject != null)
44                     {
45                         returnValue = (TReturn)Convert.ChangeType(returnObject, typeof(TReturn));
46                     }
47                     session.Flush();
48                 }
49             }
50             catch (Exception ex)
51             {
52                 LogHelper.GetInstance().WriteMessage(tableName + OperationType.COMMA + ex.ToString());
53             }
54 
55             return returnValue;
56         }
57 
58         #endregion 新增
59     }
60 }

對於不同的實體，可以一對一地寫一個<Entity>Repository，專注負責相對應的實體操作。

8. 附錄

NHibernate開源專案：https://sourceforge.net/projects/nhibernate/files/NHibernate/

Your first NHibernate based application：http://nhibernate.info/doc/tutorials/first-nh-app/your-first-nhibernate-based-application.html

NHibernate 快速上手：http://www.oschina.net/translate/nhibernate-quickstart?p=1#comments

Quickstart with NHibernate：https://docs.google.com/document/d/1OTC16N1GnKvgkIDvQn_RkQS_y3vvjYav-Ons9JLEUCU/edit?pli=1

NHibernate詞條：https://baike.baidu.com/item/NHibernate

ANTLR：http://www.antlr.org/

 

酷客多小程式  陳蘇洲

相關文章