咱就入个门之NHibernate映射文件配置(二)

旧地址:http://blog.canself.com/nhibernate_onetomany/

上一篇主要介绍了NHibernate映射文件的基础配置,这篇我们介绍下NHibernate的一对多及多对一配置(文中我直接使用双向关联,即一和多两端都配置,开发中可以只使用一端),同时略带介绍下NHibernate.Mapping.Attributes方式配置表映射。

首先,我们使用Parent和Children两个类,Parent为一端,Chrildren为多端。

下面是Parent类和映射文件配置:

1
2
3
4
5
6
7
8
9
10
11
namespace NHibernateStudy.OneToMany
{
public class Parent
{
public virtual String Id { get; set; }

public virtual String Name { get; set; }

public virtual IList<Children> Children { get; set; }
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="NHibernateStudy" namespace="NHibernateStudy.OneToMany">
<class name="Parent" table="parents">
<id name="Id" column="id" type="String">
<generator class="uuid.hex" />
</id>
<property name="Name" column="name" type="String" />
<bag name="Children" table="children" inverse="true" cascade="all">
<key column="parentid" />
<one-to-many class="NHibernateStudy.OneToMany.Children"/>
</bag>
</class>
</hibernate-mapping>

其中cascade我配置了all,保证级联更新,若有其他需求可以使用none等值。

下面是Children类及配置文件:

1
2
3
4
5
6
7
8
9
10
11
namespace NHibernateStudy.OneToMany
{
public class Children
{
public virtual string Id { get; set; }

public virtual string Name { get; set; }

public virtual Parent TheParent { get; set; }
}
}

其中需要注意,many-to-one中,column写的是当前表的字段——外键;而配置一端时,其中key里的column配置的是多端的字段,即子表里的外键,而非当期表字段。

配置文件中添加mapping:

1
2
<mapping resource="NHibernateStudy.OneToMany.Parent.hbm.xml" assembly="NHibernateStudy" />
<mapping resource="NHibernateStudy.OneToMany.Children.hbm.xml" assembly="NHibernateStudy" />

下面是使用方式过程:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#region 添加一对多关联数据
Parent parent = new Parent();
parent.Name = "parent" + DateTime.Now.ToString("MMddHHmmss");
parent.Children = new List<Children>();
Children child = new Children();
child.Name = "child" + DateTime.Now.ToString("MMddHHmmss");
child.TheParent = parent;
parent.Children.Clear();
parent.Children.Add(child);
session.Save(parent);
session.BeginTransaction().Commit();
#endregion

#region 查看多对一数据
IList<Children> children = session.CreateCriteria<Children>().List<Children>();
foreach (var item in children)
{
Parent itemparent = item.TheParent ?? new Parent();
Console.WriteLine(string.Format("ChildId:{0} Name:{1} \r\nParentId:{2} ParentName:{3}", item.Id, item.Name, itemparent.Id, itemparent.Name));
}
#endregion

下面介绍下Attributes方式配置映射文件。
首先添加NHibernate.Mapping.Attributes引用,可以在nuget中查找。

下面是配置的类,使用此法可以避免使用hbm.xml的繁琐,其中的属性与hbm.xml中的基本一致。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
namespace NHibernateStudy
{
[Serializable]
[Class(Table = "animals", Name = "NHibernateStudy.Animal,NHibernateStudy")]
public class Animal
{
/// <summary>
/// 主键
/// </summary>
[Id(Name = "Id", Column = "id", TypeType = typeof(string))]
[Key]
[Generator(Class = "uuid.hex")]
public virtual String Id { get; set; }

[Property(Name = "Name", Column = "name")]
public virtual string Name { get; set; }

}
}

不过需要注意的是,在代码中使用的时候,需要使用以下方式加载Mapping。

1
2
3
4
5
6
7
8
9
10
11
12
13
Configuration cfg = new Configuration();

MemoryStream stream = new MemoryStream();
NHibernate.Mapping.Attributes.HbmSerializer.Default.Validate = true;
NHibernate.Mapping.Attributes.HbmSerializer.Default.Serialize(
stream, System.Reflection.Assembly.GetExecutingAssembly());
stream.Position = 0; // Rewind
cfg.Configure();
cfg.AddInputStream(stream); // Use the stream here
stream.Close();

ISessionFactory sessionFactory =cfg.BuildSessionFactory();
ISession session = sessionFactory.OpenSession();

下面是具体使用过程:

1
2
3
4
5
6
7
8
9
10
11
12
#region NHibernate.Mapping.Attributes映射添加一条数据
Animal a = new Animal();
a.Name = "animal" + DateTime.Now.ToString("MMddHHmmss");
session.Save(a);
session.BeginTransaction().Commit();

IList<Animal> an = session.CreateCriteria<Animal>().List<Animal>();
foreach (var item in an)
{
Console.WriteLine("Animal——ID: " + item.Id + " Name:" + item.Name);
}
#endregion

咱就入个门之NHibernate映射文件配置(一)

旧地址:http://blog.canself.com/nhibernate_hbm_xml/

之前写了数据库连接配置,这次说说映射文件的配置,即表映射【ORM的核心就是此啦!】。

下面我们使用最原始的手动配置hbm.xml文件。

步骤:

1、添加People类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
namespace NHibernateStudy
{
public class People
{
/// <summary>
/// 主键
/// </summary>
public virtual String Id { get; set; }

/// <summary>
/// 姓名
/// </summary>
public virtual string Name { get; set; }

/// <summary>
/// 性别
/// </summary>
public virtual bool Sex { get; set; }

/// <summary>
/// 年龄
/// </summary>
public virtual Int32 Age { get; set; }

public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual string FullName { get; set; }
public virtual string TempFullName { get; set; }
}
}

2、添加People.hbm.xml文件【注意哦:生成操作要改为“嵌入的资源”——右击文件,选择属性】

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="NHibernateStudy" namespace="NHibernateStudy">
<class name="People" table="peoples">
<id name="Id" column="id" type="String">
<generator class="uuid.hex" />
</id>
<property name="Name" column="name" type="String" />
<property name="Sex" column="sex" type="Boolean" />
<property name="Age" column="age" type="Int32" />

<property name="FirstName" column="firstname" type="String" />
<property name="LastName" column="lastname" type="String" />
<property name="FullName" formula="firstname||lastname" type="String" />
<property name="TempFullName" formula="(select A.firstname||A.lastname fro m peoples as A where A.id=id)" type="String" />
</class>
</hibernate-mapping>

3、hibenate.cfg.xml中添加映射文件配置【添加到session-factory节点内】

1
<mapping resource="NHibernateStudy.People.hbm.xml" assembly="NHibernateStudy" />

4、可以操作People添加数据啦!

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
ISessionFactory sessionFactory = (new Configuration()).Configure().BuildSessionFactory();
ISession session = sessionFactory.OpenSession();

#region 添加一条数据
session.Delete("fro m People;");
session.BeginTransaction().Commit();

People p = new People();
p.Name = "addp" + DateTime.Now.ToString("MMddHHmmss");
p.Sex = false;
p.Age = 25;
p.FirstName = "first" + DateTime.Now.ToString("MMddH");
p.LastName = "last" + DateTime.Now.ToString("Hmmss");
session.Save(p);
session.BeginTransaction().Commit();
session.Evict(p);
#endregion

#region 显示数据库数据
//session.Clear();
IList<People> ps = session.CreateCriteria<People>().List<People>();
foreach (var item in ps)
{

Console.WriteLine("ID:" + item.Id + " Name:" + item.Name + " Sex:" + item.Sex + " Age:" + item.Age);
Console.WriteLine("FirstName:" + item.FirstName + " FullName:" + item.FullName + " TempFullName:" + item.TempFullName);
}
#endregion

上述代码中有两个额外的要点,下面理一下

第一个是自动生成id的策略,第二个是formula的使用

1、官方提供了许多常用的ID生成策略,基本足够用了,当然也可以自己实现。【注:个人常用的应该是uuid.hex了,主要是使用guid的字符串】

详见官方文档:查看;此处仅接受个人常用

- - - -
identity 数据库生成int型主键
uuid.hex System.Guid使用ToString()生成Guid
guid.comb Guid类型标识符

其中uuid映射为字符串类型,guid映射为Guid类型。

2、关于formula的使用,主要用于一个字段不是直接来自于数据库,是通过计算或多表筛选得出的。上文中就使用firstname和lastname拼接fullname【sqlite中字符串拼接用‘||’】。

其中需要注意的:新增数据,保存后立即查询,formula不生效,需要执行session.clear()清空缓存以使生效,或者使用session.Evict(x)将之前加的数据从缓存中移除,如此,formula才能正确执行。

NHibernate学习资料汇总

旧地址:http://blog.canself.com/nhibernate_docs/

相关学习网站:

1、官方网站——英文(地址更换过,后面许多网站或文档里的官网地址是老的,已经不能用了)

2、官方学习教程——英文

3、国内NHibernate讨论社区——博客园(活跃度已经降低了很多)

4、NHibernate之旅——李永京(写得比较早,现在某些地方不一样,不过仍然可以作为教程使用)

5、riccc的博客——博客园(可以作为参考,里面介绍了一些相关的东西,不过文章都有些老,有些东西需自己在理理)

6、源代码——GitHub(老代码在sourceforge上:去看看


下面是一些资料文档:
1、NHibernate2.0文档(中文版,虽然旧了点,但毕竟是中文的):下载地址1

2、NHibernate教程(李永京博客整理):下载地址1

3、NHibernate 3 Beginner’s Guide(英文):下载地址1

4、NHibernate 3.0 Cookbook(英文-推荐;虽然我英文不好,但也把他当参考书看了一点点,觉得这个书才是比较好的,唯独是英文的):下载地址1

Cookbook代码:下载地址1

咱就入个门之NHibernate数据库连接配置

旧地址:http://blog.canself.com/nhibernate_conn/

此文仅介绍NHibernate连接数据库配置;有关NHibernate的介绍此处不做详解,具体见NHibernate资料汇总页。

想用NHibernate,首先得连接数据库,下面就看看NHibernate的数据库连接。

关于不同数据库连接的简单配置,其实官方提供了许多【官方包中的Configuration Templates】-学习之初可以使用。

步骤【一般处理】:

1、添加hibernate.cfg.xml;

注:记得修改文件的属性“复制到输出目录”,改为始终复制或较新复制

2、添加文件内容,代码如下:【下为sqlite数据库配置】

1
2
3
4
5
6
7
8
9
10
<?xml version="1.0" encoding="utf-8" ?>
<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2" >

<session-factory name="MySessionFactory">
<property name="connection.driver_class">NHibernate.Driver.SQLite20Driver</property>
<property name="connection.connection_string">Data Source=nhibernate.db;Password=12345678</property>
<property name="dialect">NHibernate.Dialect.SQLiteDialect</property>
</session-factory>

</hibernate-configuration>

3、添加cs代码

1
2
3
ISessionFactory sessionFactory = (new Configuration()).Configure().BuildSessionFactory();
sessionFactory.OpenSession();
sessionFactory.Close();

执行即可【注:sqlite中open不验证密码,此处可能无法验证其连接字符串正确性,可以换其他数据库尝试】

关于数据库的配置,不仅仅可以在hibernate.cfg.xml中配置数据库连接,亦可以在app.config中配置,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!--App.config-->
<?xml version="1.0" encoding="utf-8"?>
<configuration>

<configSections>
<section name="hibernate-configuration" type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
</configSections>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory name="MySessionFactory">
<property name="connection.driver_class">NHibernate.Driver.SQLite20Driver</property>
<property name="connection.connection_string">Data Source=nhibernate.db;Password=12345678</property>
<property name="dialect">NHibernate.Dialect.SQLiteDialect</property>
</session-factory>
</hibernate-configuration>

<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
</startup>
</configuration>

同样,可以使用hibernate.cfg.xml和app.config同时配置,相同的项会使用hibernate.cfg.xml配置会覆盖app.config的配置。

实际使用中,有时会出现需要连接多个数据库,可以通过手动指定配置文件来加载数据库连接,如下:【我们添加了一个second.cfg.xml文件,处理与hibernate.cfg.xml处理类似】

1
2
3
ISessionFactory secondsessionFactory= (new Configuration()).Configure(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "second.cfg.xml")).BuildSessionFactory();
secondsessionFactory.OpenSession();
secondsessionFactory.Close();

好了,简单连接配置这么多应该都用了。

下面看看hibernate.cfg.xml中的每一项的配置意义。【NHibernate.Cfg.Environment中列举了许多】

首先是上面用到的

connection.driver_class 连接驱动【某些数据库连接可省,有dialect即可】
connection.connection_string 数据库连接字符串
dialect sql方言【自己意会啥意思吧】

具体有哪些sql方言,直接上官网去看吧,挺多的。

下面是一些比较常用的配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!--是否启用批量更新,默认0不启用-->
<property name="adonet.batch_size" >1</property>
<!--建表相关-->
<property name="hbm2ddl.auto">
update
<!--create:每次运行删除上一次的表-->
<!--create-drop:每次运行,sessionFactory打开建表,关闭删表-->
<!--update:常用,自动更新表结构-->
<!--validate:验证表结构,不删除创建表-->
</property>
<!--外连接抓取:单项关联(一对一,多对一);取值(0到3,0为关闭);NHibernate1.0中有use_outer_join,现弃用-->
<property name="max_fetch_depth">1</property>
<!--输出sql语句到控制台或日志——日志使用log4net配置-->
<property name="show_sql">true</property>
<!--查询语言中的替换;如下,true和false将在sql中翻译为整数常量-->
<property name="query.substitutions">true 1,false 0</property>
<!--启用查询缓存-->
<property name="cache.use_query_cache">true</property>
<!--启用二级缓存-->
<property name="cache.use_second_level_cache">true</property>

其中有一个没有加进去,proxyfactory.factory_class——因这个我网上查了许多,一开始就是不知道他是干哈的,最后才有所理解,其实际知识点是“动态代理”,基础不行,后面再好好看看这一块。