NHibernate文档翻译第1章----快速起步

最新推荐文章于 2024-09-14 19:55:29 发布

cosio

最新推荐文章于 2024-09-14 19:55:29 发布

阅读量1.3k

点赞数

文章标签：文档 session user string 数据库 null

本文链接：https://blog.csdn.net/cosio/article/details/694584

版权

注：本文中使用的是NH1.0.1.0版本，其他版本配置可能略有不同。

示例代码下载。

数据库脚本下载

一、体系结构

首先我们来看看NHibernate的体系结构:

NHibernate是数据库和应用程序之间的持久化层，应用程序和NHibernate通过持久化(Persistent)对象联系在一起。NHibernate使用app.config或者web.config和映射文件进行设置。

下面来看看怎么使用NHibernate API的一个最小子集。

下面是图中一些对象的定义：

Configuration(NHibernate.Cfg.Configuration)

配置对象，用来指定用来出创建ISessionFactory的属性和映射文件。（图中没有此对象）

SessionFactory (NHibernate.ISessionFactory)

Session的工厂。

会话，Session (NHibernate.ISession)

代表应用程序和持久化层之间的一次对话。封装了一个ADO.NET连接。也是Transaction的工厂。保存有必需的（第一级）持久化对象的缓存，用于遍历对象图，或者通过标识符查找对象。

事务Transaction (NHibernate.ITransaction)

（可选）单线程，生命期短促的对象，应用程序用它来表示一批工作的原子操作。是底层的ADO.NET事务的抽象。一个Session某些情况下可能跨越多个Transaction 事务。

二、示例代码

我们看看他们是如何协同工作的,请看下面的代码。

代码示例（未改变数据库中的数据，查询操作）：

	//配置Configuration
	Configuration cfg = new Configuration().Configure();
	//创建ISessionFactory
	ISessionFactory factory = cfg.BuildSessionFactory();
	//打开ISession
	ISession session = factory.OpenSession();
	session=factory.OpenSession();
	try
	{
		在这里添加操作
	}
	finally
	{
		session.Close();
	}

Configuration的Configure方法，将使用应用程序的配置文件或者hibernate.cfg.xml文件的<hibernate-configuration>节点进行配置，返回值是一个配置好了的Configuration对象的实例。

然后这个Configuration通过BuildSessionFactory方法创建ISessionFactory的实例。

ISessionFactory的实例通过OpenSession打开一个ISession的实例，用这个实例完成数据库的操作，然后关闭它。

如果你的代码中需要事务，只需要把代码稍微修改一下。

代码示例（改变了数据库中的数据，数据的增删改）：

	//配置Configuration
	Configuration cfg = new Configuration().Configure();
	//创建ISessionFactory
	ISessionFactory factory = cfg.BuildSessionFactory();
	//定义事务
	ITransaction tx = null;
	//打开ISession
	ISession session = factory.OpenSession();
			
	try			
	{
		//开始事务
		tx = session.BeginTransaction();
		在这里添加操作
		tx.Commit();
	}
	catch(HibernateException ex)
	{
		if (tx!=null) tx.Rollback();				
		throw ex;
	}
	finally
	{
		//关闭ISession
		session.Close();
	}

我一般在不影响数据的方法（例如：查询）中不包含事务，而影响数据的方法（例如：增删改）使用事务。

三、配置文件

前面提到Configuration的Configure方法需要用到应用程序的配置文件或者hibernate.cfg.xml文件，这里我使用hibernate.cfg.xml配置文件，在下一章我们再探讨使用应用程序的配置文件和其他的配置方法。

这是一个典型的配置文件:

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-configuration xmlns="urn:nhibernate-configuration-2.0">
	<session-factory name="DDLLY.MyDoc.NHibernate.QuickStart">
		<!-- 属性 -->
		<property name="connection.provider">NHibernate.Connection.DriverConnectionProvider</property>
		<property name="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>
		<property name="connection.connection_string">server=.;database=user;uid=sa;pwd=sa;</property>
		<property name="show_sql">false</property>
		<property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
		<property name="use_outer_join">true</property>
		<property name="query.substitutions">true 1, false 0, yes 'Y', no 'N'</property>
		<!-- 映射文件 -->
		<mapping assembly="DDLLY.MyDoc.NHibernate.QuickStart" />
	</session-factory>
</hibernate-configuration>

属性connection.provider设置了数据库连接提供者（一般不需要更改，除非你决定自己实现提供者）。

connection.driver_class设置了数据库的的驱动类（这里设置了SqlServer的驱动类）。

connection.connection_string是数据库的连接字符串。

show_sql设置是否在运行时是否在控制台显示正在执行的SQL语句（这个属性在调试程序时很有用）。

dialect是NHibernate方言，可以让NHibernate使用某些特定的数据库平台的特性。

use_outer_join在后面的章节会有介绍。

query.substitutions，把NHibernate查询中的一些短语替换为SQL短语（比如说短语可能是函数或者字符）。

mapping节点设置了将使用到的映射文件，现在的设置方法是使用"DDLLY.MyDoc.NHibernate.QuickStart“中所有的映射文件。

四、映射文件

ISession怎么知道和数据库的哪张表哪个字段打交道，以及怎么把表和实体对象联系起来呢？靠的就是映射文件。

假设我们有个很简单的例子，我们有如下的一张表需要进行数据操作（字段和表含义一看就知道，我就不罗嗦了）：

CREATE TABLE [dbo].[users] (
	[Id] [int] IDENTITY (1, 1) NOT NULL ,
	[UserName] [nvarchar] (64)  NOT NULL ,
	[Password] [varchar] (32)  NOT NULL ,
	[Email] [varchar] (64)  NULL 
)

我们设置它的映射文件和相应的代码文件:

<?xml version="1.0" encoding="utf-8" ?> 
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.0">
    <class name="DDLLY.MyDoc.NHibernate.QuickStart.User, DDLLY.MyDoc.NHibernate.QuickStart" table="users">
		<id name="Id" type="Int32">
			<generator class="identity" />
		</id>
		
		<property name="UserName" type="String"/>
		<property name="Password" type="String"/>
		<property name="Email" type="String"/>
	</class>	
</hibernate-mapping>

	public class User
	{
		public User()
		{
		}

		private int m_Id;
		private string m_UserName;
		private string m_Password;
		private string m_Email;

		public int Id 
		{
			get { return m_Id; }
			set { m_Id = value; }
		}

		public string UserName 
		{
			get { return m_UserName; }
			set { m_UserName = value; }
		}

		public string Password 
		{
			get { return m_Password; }
			set { m_Password = value; }
		}

		public string Email 
		{
			get { return m_Email; }
			set { m_Email = value; }
		}
	}

<class name="DDLLY.MyDoc.NHibernate.QuickStart.User, DDLLY.MyDoc.NHibernate.QuickStart" table="users"> 表示映射文件对应的类文件是DDLLY.MyDoc.NHibernate.QuickStart程序集中的 DDLLY.MyDoc.NHibernate.QuickStart.User类,逗号后面是表示程序集。对应的数据库表为users。

表示Id是主键字段，generator是生成器，这里是使用SqlServer中内置标识字段来生成。

property定义了其他的字段。

五、完成代码

好了，下面我们可以开始对数据进行操作了。

我们来看看ISession为我们提供的常用方法。

Load：读取实体对象

Find：通过HQL查找实体对象

Save：保存实体对象

Delete：删除实体对象

用这些方法我们便可以完成对数据库的增删改查的操作了。下面是我完成的代码（使用NUnit进行测试）。

using System;
using System.Collections;
using System.Data;
using System.Data.SqlClient;

using NHibernate;
using NHibernate.Cfg;

using NUnit.Framework;

namespace DDLLY.MyDoc.NHibernate.QuickStart
{
	/// <summary>
	/// User测试类
	/// </summary>
	[TestFixture]
	public class UserFixture
	{
		#region 常量

		//连接字符串
		const string CONNECTIONSTRING="server=.;database=user;uid=sa;pwd=sa;";

		#endregion

		#region SetUp和TearDown

		[SetUp]
		public void SetUp() 
		{
			//添加名为LLY，密码为123456的用户，因为这是数据库的第一条记录，所以数据库标识为1
			string SetUpSql="INSERT INTO users([UserName],[Password]) VALUES('LLY','123456')";
			SqlExecuteNonQuery(SetUpSql);
		}

		[TearDown]
		public void TearDown() 
		{
			//清空users表，并把标识(identity)清零
			string TearDownSql="TRUNCATE TABLE users";
			SqlExecuteNonQuery(TearDownSql);
		}

		#endregion

		#region 私有方法

		/// <summary>
		/// 执行SQL语句
		/// </summary>
		/// <param name="sql">SQL语句</param>
		private void SqlExecuteNonQuery(string sql)
		{
			SqlConnection con=new SqlConnection(CONNECTIONSTRING);
			con.Open();
			SqlCommand cmd=new SqlCommand();
			cmd.Connection=con;
			cmd.CommandText=sql;
			cmd.ExecuteNonQuery();
			con.Close();
		}

		#endregion

		#region 测试方法

		/// <summary>
		/// 测试读取用户
		/// </summary>
		[Test]
		public void TestLoadUser()
		{
			User user=null;

			//配置Configuration
			Configuration cfg = new Configuration().Configure();
			//创建ISessionFactory
			ISessionFactory factory = cfg.BuildSessionFactory();
			//打开ISession
			ISession session = factory.OpenSession();
			session=factory.OpenSession();
			try
			{
				user=session.Load(typeof(User),1) as User;  
			}
			finally
			{
				session.Close();
			}	
			
			//************************数据检查*****************************
			//检查
			Assert.IsNotNull(user,"没有找到ID为1的用户！");
			Assert.AreEqual("LLY",user.UserName,"没有找到名字为LLY的用户！");
		}

		/// <summary>
		/// 测试查找用户
		/// </summary>
		[Test]
		public void TestFindUser()
		{
			IList userlist=null;

			//配置Configuration
			Configuration cfg = new Configuration().Configure();
			//创建ISessionFactory
			ISessionFactory factory = cfg.BuildSessionFactory();
			//打开ISession
			ISession session = factory.OpenSession();
			string hql="from User as u where u.UserName='LLY'";
			session=factory.OpenSession();
			try
			{
				userlist=session.Find(hql);
			}
			finally
			{
				session.Close();
			}

			//************************数据检查*****************************
			//检查
			Assert.AreEqual(1,userlist.Count,"名字为LLY的用户个数不为1！");
		}

		/// <summary>
		/// 测试添加用户
		/// </summary>
		[Test]
		public void TestAddUser() 
		{
			User newUser = new User();

			//配置Configuration
			Configuration cfg = new Configuration().Configure();
			//创建ISessionFactory
			ISessionFactory factory = cfg.BuildSessionFactory();
			//定义事务
			ITransaction tx = null;
			//打开ISession
			ISession session = factory.OpenSession();
			
			try			
			{
				//开始事务
				tx = session.BeginTransaction();
				newUser.UserName = "DDL";
				newUser.Password = "123456";
				newUser.Email = "DDLLY@tom.com";
				// 保存新用户
				session.Save(newUser);
				tx.Commit();
			}
			catch(HibernateException ex)
			{
				if (tx!=null) tx.Rollback();				
				throw ex;
			}
			finally
			{
				//关闭ISession
				session.Close();
			}


			//************************数据检查*****************************
			IList userlist=null;
			string hql="from User as u where u.UserName='DDL'";
			session=factory.OpenSession();
			try
			{
				userlist=session.Find(hql);
			}
			finally
			{
				session.Close();
			}

			//检查是否有且仅有一个名称为DDL的用户
			Assert.AreEqual(1,userlist.Count,"名字为DDL的用户个数不为1！");

		}

		/// <summary>
		/// 测试删除用户
		/// </summary>
		[Test]
		public void TestDeleteUser()
		{
			IList userlist=null;
			User user=null;
			//配置Configuration
			Configuration cfg = new Configuration().Configure();
			//创建ISessionFactory
			ISessionFactory factory = cfg.BuildSessionFactory();
			//定义事务
			ITransaction tx = null;
			//打开ISession
			ISession session = factory.OpenSession();
			try
			{
				//开始事务
				tx = session.BeginTransaction();

				user=session.Load(typeof(User),1) as User;
				session.Delete(user);

				tx.Commit();
			}
			catch(HibernateException ex)
			{
				if (tx!=null) tx.Rollback();				
				throw ex;
			}
			finally
			{
				session.Close();
			}

			//************************数据检查*****************************
			string hql="from User as u where u.UserName='LLY'";
			session=factory.OpenSession();
			try
			{
				userlist=session.Find(hql);
			}
			finally
			{
				session.Close();
			}	

			//检查
			Assert.AreEqual(0,userlist.Count,"名字为LLY的用户没有被删除！");
		}

		/// <summary>
		/// 测试更新用户
		/// </summary>
		[Test]
		public void TestUpdateUser()
		{
			User user=null;

			//配置Configuration
			Configuration cfg = new Configuration().Configure();
			//创建ISessionFactory
			ISessionFactory factory = cfg.BuildSessionFactory();
			//定义事务
			ITransaction tx = null;
			//打开ISession
			ISession session = factory.OpenSession();
			try
			{
				//开始事务
				tx = session.BeginTransaction();

				user=session.Load(typeof(User),1) as User;
				user.Password="123";
				session.Update(user);

				tx.Commit();
			}
			catch(HibernateException ex)
			{
				if (tx!=null) tx.Rollback();				
				throw ex;
			}
			finally
			{
				session.Close();
			}

			//************************数据检查*****************************
			session=factory.OpenSession();
			try
			{
				user=session.Load(typeof(User),1) as User;
			}
			finally
			{
				session.Close();
			}	

			//检查
			Assert.IsNotNull(user,"没有找到名字为LLY的用户！");
			Assert.AreEqual("123",user.Password,"没有找到名字为LLY的用户！");
		}
		#endregion
	}
}