Nhibernate入门

Size: px

Start display at page:

Download "Nhibernate入门"

鹊皮
5 years ago
Views:

1 Nhibernate 入门对大部分 Nhibernte 操作, 都写了一个 Demo, 映射文件全部手写 ( 手疼 ), 看完后会对 Nhibernte 有个全面的了解不想看文字的, 可以看看附件中的代码什么是 Nhibernate Nhibernate 会把数据库中的表用对象图的形式表现出来, 对开发人员来说, 他们面对的不是底层的 ADO,DateSet 等结构, 而是包含业务逻辑的对象 Nhibernate 足够聪明, 它能做到自动透明的持久化对象图, 这节省了大量的开发时间, 也弥补了对象设计和数据库设计间的不对称性 Nhibernte 主要用来解决复杂的业务逻辑, 而不适合简单逻辑或以数据为中心的系统 Nhibernte 中的几个重要对象下面介绍 Nhibernate 中常用的几个对象, 首先是 Configuration Configuration Configuration 负责管理 Nhibernate 的配置信息以及类与数据库之间的映射文件 (*.hbm.xm), 负责创建 ISessionFactory Nhibernate 可以通过下面两种方式进行初始化 : 一配置文件配置文件是最常用的方式, 灵活简单 <?xml version="1.0" encoding="utf-8"?> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2" > <session-factory name="sampledb"> <property name="dialect">nhibernate.dialect.mssql2000dialect</property> <property name="connection.provider">nhibernate.connection.driverconnectionprov ider</property> <property name="connection.driver_class">nhibernate.driver.sqlclientdriver</pro perty> <property name="connection.connection_string">data Source=DD-10980FA277D7;Databa se=sampledb;user ID=sa;Password=sa;</property> <property name="connection.isolation">readcommitted</property>

2 <property name="default_schema">sampledb.dbo</property> <property name="show_sql">true</property>  <mapping assembly="domain" /> </session-factory> </hibernate-configuration> 下面的代码会调用默认的 hibernat.cfg.xml 配置文件 : Configuration cfg = new Configuration().Configure(); 如果要用非默认文件初始化可以用下面代码 : Configuration cfg = new Configuration().Configure(specificConfigName); 二通过代码设置 Configuration 属性, 这种方式不推荐使用通过配置文件名 Configuration cfg = new Configuration().AddFile("Item.hbm.xml").AddFile("Bid.hbm.xml"); 通过内嵌资源 Configuration cfg = new Configuration().AddClass(typeof(NHibernate.Auction.Item)).AddClass(typeof(NHibernate.Auction.Bid)); 这种方式自动加载对应类名称的 hbm.xml 文件通过程序集 Configuration cfg = new Configuration().AddAssembly( "NHibernate.Auction" ); 这种方式会加载指定程序集中所有的 hbm.xml 文件注意 :Nhibernate 需要的只是 hbm.xml 文件, 而不需要每个文件对应的类, 类信息有 Nhibernte 通过反射与动态代理得到

3 ISessionFactory ISessionFactory 管理数据库的映射关系二级缓存和 Sql 语句池, 负责创建 Session, 重量级对象, 一个数据库对应一个, 不能频繁创建, 一般采用单例模式下面语句创建了 ISessionFactory ISessionFactory sessions = cfg.buildsessionfactory(); ISession ISession 作为 Nhibernate 的一级缓存, 是最常用的对象,ISession 的操作比较复杂, 涉及到的内容很多, 后面会详细介绍下面语句创建 ISession ISession session=sessions.opensession(); 持久化类与映射文件下面的例子实现最简单的持久化操作假定我们已经抽象出了某个业务领域的域模型 : 包含客户订单客户有客户名, 订单包含订单号, 并且要求根据订单能找到对应的客户信息首先创建持久化类持久化类作为域对象使用, 可以是标准的 C# 类, 也可以是 POCO 类型, 如果持久化类遵循 POCO 模型,Nhibernate 可以工作的更好在最新的 Nhibernate 中, 默认了属性的延迟加载, 为了能够让动态代理创建持久化的代理对象, 必须把属性设置为 virtual, 否则通过 lazy=false 关闭延迟加载不要混淆持久化类与持久化状态, 持久化类没有状态概念, 它可以处于任何状态用 C# 实现上面的域模型定义 Customer: public class Customer private int _id;

4 private string _name; public Customer() public Customer(string name) _name = name; public virtual int Id get return _id; set _id = value; public virtual string Name get return _name; set _name = value; 定义 Order, 并建立到 Customer 的单向关联 : public class Order private int _id; private string _ordernumber; private Customer _customer; public Order(string orderno,customer c) _ordernumber = orderno; _customer = c; public Order() public virtual int Id get return _id; set _id = value;

5 public virtual string OrderNumber get return _ordernumber; set _ordernumber = value; public virtual Customer Customer get return _customer; set _customer = value; 到此持久化类以及定义完, 下面要做的是把它映射到表在 Nhibernate 中通过配置文件实现映射, 这保证了域模型的可移植性映射文件以 nbm.xml 作为后缀名, 映射文件名称可以任意, 但是最好和持久化类同名其次创建映射文件 Customer 的映射文件 Customer.hbm.xml <?xml version="1.0" encoding="utf-8"?> <hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="domain" namespace= "Domain" > <class name="customer" table="customers" > <id name="id" column="id" type="int32"> <generator class="native"/> </id> <property name="name" column="name" type="string"/> </class> </hibernate-mapping> Order.hbm.xml <?xml version="1.0" encoding="utf-8"?> <hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="domain" namespace= "Domain" >

6 <class name="domain.order,domain" table="orders" > <id name="id" column="id" type="int32"> <generator class="native"/> </id> <property name="ordernumber" column="order_number" type="string"/> <many-to-one name="customer" class="domain.customer,domain" column="customer_ Id" cascade="save-update"/> </class> </hibernate-mapping> 配置文件完成下面的几类映射一首先通过 OID 建立对象引用和数据表主键间的映射在.net 中, 通过引用来唯一标识一个对象, 而在数据库中用主键唯一标识一条记录, 因此必须建立对象与数据库表记录之间的一一对应关系这种关系在 Nhibernate 中通过 OID 建立如 Customer.hbm.xml <id name="id" column="id" type="int32"> <generator class="native"/> </id> OID 通过 id 元素映射, 通常对应表的主键 (ID), 但这也不是强制性的, OID 的目的是为了建立一一映射关系二建立类和表之间的关系要建立下面几种映射 : 通过 class 元素建立类名称与表名称的映射 : <class name="domain.order,domain" table="orders" /> 通过 property 元素建立类属性和表字段的映射 <property name="name" column="name" type="string"/> Type 可以为 Nhibernate 类型.net 类型自定义类型, 此处用的是 Nhibernate 类型建立对象间关系和表关系的映射, 如把对象单向多对一关联映射为外健关系 <many-to-one name="customer" class="domain.customer,domain" column="customer_id" cascade="save-update"/> 建立一些辅助功能, 这些能让 nhibernate 把持久化做的更好, 如 : 延迟加载, 抓取策略以及为更好生成数据库 schema 而设置的特性 (column 特性 ) 等

7 下面的配置为数据库架构生成器提供了更详细信息 : <property name="name" > <column name="name" sql-type="varchar" length="80"/> </property> 到此, 已经建立了持久化类和数据表的关系, 以后就可以透明持久化数据, Nhibernate 会把我们对持久化类的操作通过 Sql 映射到数据库这时我们也从烦人的 ADO 中解脱出来, 可以把精力放到业务关系上, 着力解决实际问题, 而不是技术问题最后要做的是通过 Session 把业务数据存储到数据库简单的 CRUD 操作, 其中 Session 是 Sessin 接口的实例, 例子中省去了 Session 管理 public void Insert() Customer c1 = new Customer("ding"); Session.Save(c1); public void Select() Customer c1 = Session.Load<Customer>(1); public void Update() Customer c1 = Session.Load<Customer>(1); c1.name = "dinghao"; Session.Save(c1); public void Delete() Customer c1 = Session.Load<Customer>(1); Session.Delete(c1); 代码是不是很简单?Nhibernate 就是如此简便因为涉及到 Session, 稍做些解释, 这些有利于后面其他概念的理解和优化 Nhibernate

8 Session 作为一级缓存, 维护着内存中的对象图, 每当加载对象时 Session 就保存对象的一份引用, 使之不被回收, 作为缓存待用如 : Customer c1 = Session.Load<Customer>(1); 会创建 Customer 实例的两份引用, 一份保存在 c1, 另一份保存在 Session, 这样即使 c1 不在引用 Customer, 只要 Session 不被情空,Customer 对象仍然存活这样查询时如果缓存命中, 就不会再读取数据库, 提高了效率 Customer c1 = new Customer("1"); Session.Save(c1); // 执行 insert Customer c2 = Session.Get<Customer>(c1.Id); // 缓存中有数据, 不会执行 select Session 还可以提供更优化的 Sql, 因为只有在清理缓存时才执行 sql, 这也就提供了一个优化 sql 的时机, 这时可以通过一些策略来使 Nhibernate 生产更高效的 sql 语句, 优化后面有更详细说明但是 Session 的缺点也很明显, 它必须维护缓存于数据库的一致性, 这造成没有办法实现高效的更新和删除操作, 每次更新删除时必须通过执行查询, 来保证 Session 不存在脏数据如下面的删除操作 : public void Delete() Customer c1 = Session.Load<Customer>(1); Session.Delete(c1); 首先执行 Load, 然后删除这是 Nhibernate 不能解决的问题, 是 Session 模型本身的缺陷, 一些优化只能缓解这种性能损失, 所以批量操作最好通过 NativeSql Nhibernte1.2 的文档说, 通过把 batch-size 设置为 0,SqlServer 会执行批量更新删除没有经过测试或许后续版本会提供无状态的 Session 和 bulk 更新删除 (Hibernate3) 状态对象分三种状态, 理解状态是理解 Session 管理的基础临时状态 : 对象位于内存, 但没有被 Session 管理, 不对应数据库记录

9 持久状态 : 已经加入到 Session 中, 由 Session 管理,Nhibernate 负责持久化, 有对应记录游离状态 : 没有被 Session 管理, 但可能对应一条纪律, 也可能没有简单的说这条记录有主键值,Nh 会把它作为游离态, 否则作为临时态对象转换图 : 实体和值对象 Nhibernate 中对象分两种, 一种是值一种是实体, 这是非常重要的概念两者的本质区别是值没有 OID, 这就意味着值是个残缺的实体, 他不能单独持久化, 不能建立到实体的关联抓取策略新版中通过 lazy 和 fetch 定义抓取策略, 其中 lazy 定义什么时候检索数据, fetch 定义如何检索数据两种结合使用,lazy 默认为 true,fetch 默认是 select 由于默认采用延迟加载, 如果 Session 关闭后, 访问没有被加载对象会抛异常, 可以调用 NhibernteUtil.Initialize(); 使其被加载或者 Session 关闭前对数据做初始化

10 Fetch 默认采用 select, 这通常导致 N+1 问题, 其中的一种解决方式是, 把 fetch 设置为 join, 以采用左外链接检索批量检索, 通过 batch-size 可以缩减生成的 Select 语句数量查询方式 Hql Hql 是面向对象的查询语言, 虽然看起来类似于 sql, 这只是为了让熟悉 sql 的用户更容易使用,Hql 用到的是持久化类几个例子 : public void AgrigateFunction() IList customers = Session.CreateQuery("select max(c.age),sum(c.age) f rom Customer c").list(); Console.Write(customers.Count); public void InnerJoin() IList customers = Session.CreateQuery("select c from Customer c inner join c.orde rs o where c.name like 'T%'").List(); Console.Write(customers.Count); public void FetchLeftJoin() IList<Customer> customers = Session.CreateQuery("from Customer c left join fetch c.orders o w here c.name like 'T%'").List<Customer>(); Console.Write(customers.Count); QBC

11 提供面向对象的查询语法, 不需要了解 Sql, 就可以使用如 : public void WhereSelect() IList<Customer> customers = Session.CreateCriteria(typeof(Customer)).Add(Expression.Eq ("Name", "Tom")).List<Customer>(); IList<Customer> customers2 = Session.CreateCriteria(typeof(Customer)).Add(Expression.E q("this.name", "Tom")).List<Customer>(); 下面是简单的 Hql 和 QBC 操作 NativeSql 最新的 Nhibernte 增强了本地 sql 查询, 感觉可以比上 Ibatise 了, 比以前好用很多如 : 实体查询, 把 sql 语句查询结果自动映射到类 public void Entiy() IList<Customer> c = Session.CreateSQLQuery("select * from CUstomers").AddEntit y(typeof(customer)).list<customer>(); Console.Write(c.Count); 标量查询 : 把查询结果映射到集合 public void ScaleSelect() IList c =Session.CreateSQLQuery("select * from CUstomers").AddScalar("Name", N HibernateUtil.String).AddScalar("Age", NHibernateUtil.Int32).List(); Console.Write(c.Count);

12 数据库设计和类设计关系数据库和 OO 的不对称性, 才使得 ORM 有用武之地, 首先是粒度, 数据库为了效率一般采用粗粒度模型, 而 OO 为了重用性简便性多采用细粒度模型这要求 Nhibernte 必须能透明的再两者间转换其次是 OO 的一些特性, 如关联继承多态组合, 在数据库中没有对应概念, 这时 Nhibernte 要解决的第二个问题以关联为例, 类有一对一, 一对多, 多对一, 多对多关联, 并且这些关系是有方向的数据库并不存在这些关系, 也没有任何方向问题, 但是数据库通过 SQL 可以模拟任意的关联关系所以只要设置好 Nhibernte 的映射元数据, 就可以把对象关联映射到数据库后面有这几种映射方式的例子, 见代码把 OO 概念映射到数据库下面的通过例子说明怎么映射 OO 概念到数据库, 虽然分开说明, 但他们不是孤立的映射关联关系类的关联不一定需要映射到数据库, 反之也一样管理分实体间的关联与实体到值对象的关联, 其中实体关联最常用通过两种方式映射下面的关联关系实体间的 one2many 关联

代码 : private IList<Order> _orders; public virtual IList<Order> Orders get return _orders; set _orders = value; 建立文件 : <bag name="orders" table="orders"> <key column="customer_id"/> <one-to-many

13 代码 : private IList<Order> _orders; public virtual IList<Order> Orders get return _orders; set _orders = value; 建立文件 : <bag name="orders" table="orders"> <key column="customer_id"/> <one-to-many class="domain.order" not-found="exception"/> </bag> 如果不希望 Order 有自觉的生命期, 可以建立实体与值对象间的关联, 代码 : private IList<Order> _valueorders; public virtual IList<Order> ValueOrders get return _valueorders; set _valueorders = value; 映射文件 : <bag name="valueorders" table="orders">

<key column="customer_id"/> <composite-element class="order"> <property name="ordernumber" column="order_number" type="string"/> <property name="price" column="price" type="decimal"/>

14 <key column="customer_id"/> <composite-element class="order"> <property name="ordernumber" column="order_number" type="string"/> <property name="price" column="price" type="decimal"/> </composite-element> </bag> 测试代码 : public void ComponentSet() Customer c = new Customer("ding"); IList<Domain.Order> os = new List<Domain.Order>(); os.add(new Domain.Order("dd",3)); c.valueorders = os; Session.Save(c); 映射组成关系组件在 Nhibernate 中用于映射对象间的组成关系组件是值对象 (Value), 用 Componet 以及包含 Component 的其他元素映射如, 映射下面的模型 <component name="homeaddress" class="address"> <property name="street" type="string" column="home_street"/> <property name="city" type="string" column="home_city"/> <property name="province" type="string" column="home_province"/>

15 <property name="zipcode" type="string" column="home_zipcode"/> </component> <component name="companyaddress" class="address"> <property name="street" type="string" column="com_street"/> <property name="city" type="string" column="com_city"/> <property name="province" type="string" column="com_province"/> <property name="zipcode" type="string" column="com_zipcode"/> </component> private Address _homeaddress; public virtual Address HomeAddress get return _homeaddress; set _homeaddress = value; private Address _companyaddress; public virtual Address CompanyAddress get return _companyaddress; set _companyaddress = value; 测试代码 [TestFixture] [Category("Composite")] public class Composite:NhSession public void SaveAll() Customer c = new Customer("ding"); Address ha = new Address("ha", "bj", "hb", "0000"); Address ca = new Address("ha", "bj", "hb", "0000"); Session.Save(c); public void SaveWithoutComponent()

16 Customer c = new Customer("ding"); Session.Save(c); public void NullSemantic() Customer c = new Customer("ding"); Session.Save(c); Customer c2 = Session.Load<Customer>(c.Id); Assert.IsNull(c2.HomeAddress); 映射继承关系以及多态映射继承有下面三种方式 : 现在以例子说明 table per class 与 concrete table inheritance 继承方式假设存在下面的对象关系 :

如果用为了提高数据库效率, 可以通过一个表映射继承, 也就是单表继承首先再数据库设置一个标志例, 该列说明雇员的类型程序代码 : 见附件映射关系 : <?xml version="1.0" encoding="utf-8"?> <hibernate-mapping xmlns="urn:nhibernate-mapping-2.

17 如果用为了提高数据库效率, 可以通过一个表映射继承, 也就是单表继承首先再数据库设置一个标志例, 该列说明雇员的类型程序代码 : 见附件映射关系 : <?xml version="1.0" encoding="utf-8"?> <hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="domain" namespace="domai n.inheritance"> <class name="iemployee" table="employees"> <id name="id" column="id" type="int32"> <generator class="native"/> </id> <discriminator column="employee_type" type="string"/> <property name="name" column="name" type="string"/> <subclass name="salariedemployee" discriminator-value="se" > <property name="salary" column="salary" type="int32"/> </subclass> <subclass name="hourlyemployee" discriminator-value="he"> <property name="rate" column="rate" type="int32"/> </subclass> </class> </hibernate-mapping>

18 测试代码 : [TestFixture] [Category("PerClassInheritence")] public class PerClassInheritence:NhSession public void SaveSubClass() IEmployee se = new SalariedEmployee("ding",3); Session.Save(se); /// <summary> /// 多态查询 /// </summary> public void GetBase() IList<IEmployee> es= Session.CreateQuery("from IEmployee").List<IEmployee>(); Console.Write(es.Count); public void GetSubBase() int id = SaveHourEmployee(); IEmployee es = Session.Get<HourlyEmployee>(id); Console.Write(es.ToString()); private int SaveHourEmployee() IEmployee he = new HourlyEmployee("ding", 3); Session.Save(he); return he.id; 这种方式至持多态查询一个具体类一个表, 这种方式不能映射基类, 所以不支持多态查询

19 代码省略, 见附件集合映射集合映射分两类, 一是实体类型集合, 如关联的多端, 另一类是值类型集合集合映射有两种语义, 一种是.net 中集合的概念, 另一种是 nhibernate 中集合的概念, 前种在代码文件中体现, 后一种体现在映射文件中如用 bag 映射 IList,ICollection 集合对应数据库中的表, 表必须存在外键做为集合元素的列, 如果用含有索引语义的集合做映射, 还必须包含能做索引的项这部分和关联关系密切, 可以结合理解代码种经常会使用到集合, 下面看看怎么把集合映射到数据库假设有下面的代码 private ISet<string> _images; public virtual ISet<string> Images get return _images; set _images = value; private IDictionary<string,string> _mapimages; public virtual IDictionary<string,string> MapImages get return _mapimages; set _mapimages = value; private IList<Order> _valueorders; public virtual IList<Order> ValueOrders get return _valueorders; set _valueorders = value; 映射 Set,set 是无序, 没有索引, 没有重复值的集合

20 <set name="images" table="image" > <key column="customer_id" /> <element column="filename" type="string"/> </set> 映射 Map,map 包含键值对 <map name="mapimages" table="image"> <key column="customer_id"/> <index column="filename" type="string"/> <element column="imagename" type="string"/> </map> 映射组件见关联关系集合排序, 分两种一种为内存排序, 另一种为通过 Sql 排序内存排序可以通过实现 IComparer 接口, 实现自定义排序 Sql 排序通过 order-by 特性制定列名及排序机制, 如 :order-by= Filename desc 怎么理解 Nhibernte 理解 NHibernate, 应该从对象开始, 即总是要考虑如何把对象映射到对应的数据库结构, 而不是反过来思考考虑 Nhibernte 生成的 Sql 是否过量, 如果是考虑优化 Nhibernate, 确实很复杂, 我们用到的一般只是他的一部分功能开发方式开发可以从数据库建模开始, 也可以从 OO 建模开始如果从数据库开始, 就要把数据库表映射为类 hbm.xml 文件反之则把 OO 映射为表 hbm.xml 文件由于 Nhibernte 可以可以隔离类和数据库, 我认为这种情况下两种方式区别已经不大, 主要的问题在于哪知能更好的自动生成, 以及在以后修改一方时能更好的自动更正另一方不过最重要的一点是, 不论从哪一方开始设计, 最终的对象都不能是表的直接映射, 否则采用 Nhibernte 也就没有什么意义了

21 好像还可以同时进行, 建立抽象模型后, 一边设计数据库, 一边设计持久化类, 最后用 hbm.xml 映射两者的关系这种方式好像是最优的, 缺点就是没有办法用自动生成工具, 工作量较大辅助工具最常用的是通过书库架构生成类和映射文件, 目前支持 1.2 的工具不多, 下面是支持 1.2 的模版 : 但是必须要明确的是, 生成的类一定要看看是否符合 OO 的标准, 不要把任何表都映射为类其他工具包括, 通过 hbm.xml 生成数据库, 通过特性映射而不用写 hbm.xml 资料中文 : 孙卫琴, 精通 hibernte,java 对象持久化技术详解英文 :nhibernate referenc,hibernate in action,nhibernae in action( 十月出版 ) 认真写了好久的例子 : 为什么不选用 ActiveRecord

OOP with Java 通知 Project 4: 4 月 18 日晚 9 点关于抄袭没有分数

OOP with Java Yuanbin Wu cs@ecnu OOP with Java 通知 Project 4: 4 月 18 日晚 9 点关于抄袭没有分数复习类的复用组合 (composition): has-a 关系 class MyType { public int i; public double d; public char c; public void set(double