如何在.NET Core應用中使用NHibernate詳解

來源：懂視網責編：小采時間：2020-11-27 22:34:59

如何在.NET Core應用中使用NHibernate詳解

如何在.NET Core應用中使用NHibernate詳解:前言 Nhibernate 來源于非常優秀的基于Java的Hibernate 關系型持久化工具。NHibernate 最近發布了 5.1.3 版本，支持 .NET Standard 2.0 ，這意味著可以在 .NET Core 2.0 應用中使用，本文就已 WebAPI 應用為例，介紹一下如何在 .NET Co

推薦度：

點擊下載本文 文檔為doc格式

導讀如何在.NET Core應用中使用NHibernate詳解:前言 Nhibernate 來源于非常優秀的基于Java的Hibernate 關系型持久化工具。NHibernate 最近發布了 5.1.3 版本，支持 .NET Standard 2.0 ，這意味著可以在 .NET Core 2.0 應用中使用，本文就已 WebAPI 應用為例，介紹一下如何在 .NET Co

前言

Nhibernate 來源于非常優秀的基于Java的Hibernate 關系型持久化工具。NHibernate 最近發布了 5.1.3 版本，支持 .NET Standard 2.0 ，這意味著可以在 .NET Core 2.0 應用中使用，本文就已 WebAPI 應用為例，介紹一下如何在 .NET Core 應用中如何使用 NHibernate 。下面話不多說了，來一起看看詳細的介紹的吧

使用方法如下：

1、新建一個基于 .NET Core 的 Web API應用，命令如下：

mkir WebApiTest
cd WebApiTest/
dotnet new webapi

2、添加 NHibernate 包以及對應的數據庫驅動程序（以 Npgsql 為例）：

dotnet add pakcage NHibernate
dotnet add package NHibernate.NetCore
dotnet add package Npgsql

現在打開項目文件 WebApiTest.csproj ，可以看到已經添加了這些包：

 <ItemGroup>
 <PackageReference Include="Microsoft.AspNetCore.App" />
 <PackageReference Include="NHibernate" Version="5.1.3" />
 <PackageReference Include="NHibernate.NetCore" Version="1.0.1" />
 <PackageReference Include="NpgSql" Version="4.0.2" />
 </ItemGroup>

3、在項目中新建一個 Models 目錄，并創建實體類以及對應的 xml 映射文件，代碼如下：

namespace WebApiTest.Models {

 public class GpsPosition {
 public virtual long Id { get; set; }
 public virtual string UserAgent { get; set;}
 public virtual long? Timestamp { get; set; }
 public virtual float? Latitude { get; set; }
 public virtual float? Longitude { get; set; }
 public virtual float? Accuracy { get; set; }
 public virtual float? Altitude { get; set; }
 public virtual float? AltitudeAccuracy { get; set; }
 public virtual float? Heading { get; set; }
 public virtual float? Speed { get; set; }
 public virtual string Tag { get; set; }
 }
}

對應的 xml 映射文件如下：

<?xml version="1.0" encoding="utf-8"?>
<hibernate-mapping
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns="urn:nhibernate-mapping-2.2"
 namespace="WebApiTest.Models"
 assembly="WebApiTest">
 <class name="GpsPosition" schema="public" table="gps_position">
 <id name="Id" column="id" type="long">
 <generator class="sequence">
 <param name="sequence">public.gps_position_id_seq</param>
 </generator>
 </id>
 <property name="UserAgent" column="user_agent" type="string" />
 <property name="Timestamp" column="timestamp" type="long" />
 <property name="Latitude" column="latitude" type="float" />
 <property name="Longitude" column="longitude" type="float" />
 <property name="Accuracy" column="accuracy" type="float" />
 <property name="Altitude" column="altitude" type="float" />
 <property name="AltitudeAccuracy" column="altitude_accuracy" type="float" />
 <property name="Heading" column="heading" type="float" />
 <property name="Speed" column="speed" type="float" />
 <property name="Tag" column="tag" type="string" />
 </class>
</hibernate-mapping>

這些都是 NHibernate 的常規做法，因此不做過多介紹，不熟悉的可以查閱 NHIbernate 的相關文檔。

4、將 xml 文件編譯為嵌入的資源，打開項目文件 WebApiTest.csproj ，添加一個 ItemGroup 節點：

<ItemGroup>
 <None Remove="Models/*.hbm.xml" />
 <EmbeddedResource Include="Models/*.hbm.xml" />
</ItemGroup>

5、創建 NHibernate 的配置文件，并設置為復制到輸出目錄：

<?xml version="1.0" encoding="UTF-8"?>
<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
 <session-factory>
 <property name="connection.connection_string">server=localhost;database=test_db;user id=postgres;password=postgres;</property>
 <property name="dialect">NHibernate.Dialect.PostgreSQL83Dialect</property>
 <property name="connection.driver_class">NHibernate.Driver.NpgsqlDriver</property>
 <property name="show_sql">true</property>
 <property name="format_sql">true</property>
 <property name="adonet.batch_size">10</property>
 <mapping assembly="NaturalReserveApi" />
 </session-factory>
</hibernate-configuration>

打開項目文件，添加 ItemGroup 節點，內容如下：

<ItemGroup>
 <Content Update="hibernate.config">
 <CopyToOutputDirectory>Always</CopyToOutputDirectory>
 </Content>
</ItemGroup>

6、修改 Startup.cs 文件，將 NHibernate 集成到 .NET Core 內置的依賴注入框架中：

6.1、修改 Startup.cs 的 using 部分，添加下面的語句：

using Microsoft.Extensions.Logging;
using NHibernate.NetCore;

6.2、修改 Startup.cs 的構造函數，代碼如下：

public Startup(
 IConfiguration configuration,
 ILoggerFactory factory
) {
 Configuration = configuration;
 // 將內置的日志組件設置為 NHibernate 的日志組件
 factory.UseAsHibernateLoggerFactory();
}

6.3、修改 ConfigureServices 方法，添加 NHibernate 相關的服務：

public void ConfigureServices(IServiceCollection services) {
 // nhibernate 配置文件的路徑
 var path = System.IO.Path.Combine(
 AppDomain.CurrentDomain.BaseDirectory,
 "hibernate.config"
 );
 // 添加 NHibernate 相關的服務
 services.AddHibernate(path);
 services.AddMvc()
 .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}

7、修改默認的 ValuesController.cs ，注入并使用 NHibernate：

7.1、修改構造函數，注入 ISessionFactory ：

public ValuesController(ISessionFactory factory) {
 this.factory = factory;
}

7.2、修改 Get 方法，使用 NHibernate 進行查詢：

// GET api/values
[HttpGet]
public ActionResult<IEnumerable<GpsPosition>> Get() {
 using (var session = factory.OpenSession()) {
 var query = session.Query<GpsPosition>();
 return query.ToList();
 }
}

8、編譯并運行：

dotnet run

之后可以看到類似這樣的 NHibernate 初始化信息：

Using launch settings from ~/Projects/WebApiTest/Properties/launchSettings.json...
info: NHibernate.Cfg.Environment[0]
 NHibernate 5.1.3 (assembly 5.1.0.0)
info: NHibernate.Cfg.Environment[0]
 hibernate-configuration section not found in application configuration file
info: NHibernate.Cfg.Environment[0]
 Bytecode provider name : lcg
info: NHibernate.Cfg.Environment[0]
 Using reflection optimizer
dbug: NHibernate.Cfg.Configuration[0]
......
Hosting environment: Development
Content root path: ~/Projects/WebApiTest
Now listening on: https://localhost:5001
Now listening on: http://localhost:5000
Application started. Press Ctrl+C to shut down.

看到這些信息，就表示已經可以正常的使用 NHibernate 了。

總結

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com