第2章 ISessionFactory配置

目录

可编程配置方式
获取ISessionFactory
用户自行提供ADO.NET连接
NHibernate提供ADO.NET连接
可选配置属性
SQL 方言 (SQL Dialects)
外连接抓取（Outer Join Fetching )
自定义 CacheProvider
查询语言替换
Logging

因为NHibernate被设计为可以在许多不同环境下工作，所以它有很多配置参数。幸运的是，大部分都已经有默认值了。 NHibernate.Test.dll包含了一个示例的配置文件app.config，它演示了一些可变的参数。

可编程配置方式

NHibernate.Cfg.Configuration的一个实例代表了应用程序中所有的.NET类到SQL数据库的映射的集合。Configuration用于构造一个(不可变的)ISessionFactory。这些映射是从一些XML映射文件中编译得来的。

你可以得到一个Configuration的实例，直接实例化它即可。下面有一个例子，用来从两个XML配置文件（和exe文件在同一个目录下）中的映射中初始化： 

Configuration cfg = new Configuration()
    .AddXmlFile("Item.hbm.xml")
    .AddXmlFile("Bid.hbm.xml");

另外一个（某些时候更好的）方法是让NHibernate自行用GetManifestResourceStream()来装载映射文件 

Configuration cfg = new Configuration()
    .AddClass( typeof(NHibernate.Auction.Item) )
    .AddClass( typeof(NHibernate.Auction.Bid) );

NHibernate 就会在这些类型的程序集的嵌入的资源中寻找叫做NHibernate.Auction.Item.hbm.xml 和 NHibernate.Auction.Bid.hbm.xml的映射文件。这种方法取消了所有对文件名的硬编码。

另外一个（可能是最好的）方法是让NHibernate读取一个程序集中所有的配置文件: 

Configuration cfg = new Configuration()
    .AddAssembly( "NHibernate.Auction" );

NHibernate将会遍历程序集查找任何以hbm.xml结尾的文件。 这种方法取消了所有对文件名的硬编码并且确保程序集中的配置文件文件都会被加载。

在使用VisualStudio.NET或者NAnt生成程序集时请确保hbm.xml文件是作为嵌入资源(Embedded Resources)添加的。

Configuration也可以指定一些可选的配置项 

Hashtable props = new Hashtable();
...
Configuration cfg = new Configuration()
    .AddClass( typeof(NHibernate.Auction.Item) )
    .AddClass( typeof(NHibernate.Auction.Bid) );
cfg.Properties = props;

Configuration是仅在配置期使用的对象，从第一个SessionFactory开始建立的时候，它就失效了。

获取ISessionFactory

当所有的映射都被Configuration解析之后，应用程序为了得到ISession实例，必须先得到它的工厂。这个工厂应该是被应用程序的所有线程共享的： 

ISessionFactory sessions = cfg.BuildSessionFactory();

当然，NHibernate并不禁止你的程序实例化多个ISessionFactory。在你使用不止一个数据库的时候，这就有用了。

用户自行提供ADO.NET连接

ISessionFactory可以使用一个用户自行提供的ADO.NET连接来打开一个ISession。这种设计可以让应用程序来自己管理ADO.NET连接: 

IDbConnection conn = myapp.GetOpenConnection();
ISession session = sessions.OpenSession(conn);
// do some data access work

应用程序必须小心，不能在同一个连接上打开两个并行的 ISession!

NHibernate提供ADO.NET连接

另一种方法就是，你可以让ISessionFactory替你打开连接。SessionFactory必须事先知道ADO.NET连接的参数，有几种不同的方法设置参数：

  1. 通过提供一个IDictionary实例给Configuration.Properties。

  2. 在名为nhibernate的System.Configuration.NameValueSectionHandler类型的配置节点添加属性。

  3. 在hibernate.cfg.xml 中包含<property>元素。

如果你使用这种方法，打开一个ISession是非常简单的： 

ISession session = sessions.OpenSession(); // open a new Session
// do some data access work, an ADO connection will be used on demand

所有的NHibernate属性名和约束都在 NHibernate.Cfg.Environment类中定义。我们讨论一下ADO.NET连接配置最重要的几项设置：

假若你设置了如下的属性，NHibernate会使用ADO.NET Data Provider来得到连接：

表 2.1. NHibernate ADO.NET 属性

属性名 用途
hibernate.connection.provider_class 定制IConnectionProvider的类型.

例如：full.classname.of.ConnectionProvider （如果提供者创建在NHibernate中）, 或者 full.classname.of.ConnectionProvider, assembly （如果使用一个自定义的IConnectionProvider接口的实现，它不属于NHibernate）。

hibernate.connection.driver_class 定制IDriver的类型.

full.classname.of.Driver （如果驱动类创建在NHibernate中）, 或者 full.classname.of.Driver, assembly （如果使用一个自定义IDriver接口的实现，它不属于NHibernate）。

hibernate.connection.connection_string 用来获得连接的连接字符串.
hibernate.connection.isolation 设置事务隔离级别. 请检查 System.Data.IsolationLevel 来得到取值的具体意义并且查看数据库文档以确保级别是被支持的。

例如： Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

下面是一个在web.config文件中指定连接属性的例子: 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
 <configSections>
  <section name="nhibernate" type="System.Configuration.NameValueSectionHandler, System,
     Version=1.0.5000.0,Culture=neutral, PublicKeyToken=b77a5c561934e089" />
  <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
 </configSections>
 
 <nhibernate>
  <add 
   key="hibernate.connection.provider"          
   value="NHibernate.Connection.DriverConnectionProvider" 
  />
  <add 
   key="hibernate.connection.driver_class"          
   value="NHibernate.Driver.SqlClientDriver" 
  />
  <add 
   key="hibernate.connection.connection_string" 
   value="Server=127.0.0.1;Initial Catalog=thedatabase;Integrated Security=SSPI" 
  />
  <add 
   key="hibernate.connection.isolation"
   value="ReadCommitted"
  />
  <add 
   key="hibernate.dialect"                      
   value="NHibernate.Dialect.MsSql2000Dialect" 
  />
  
 </nhibernate>
 
 <!-- log4net (required by NHibernate) and other app specific config follows -->
</configuration>
可选配置属性

下面是一些在运行时可以改变NHibernate行为的其他配置。所有这些都是可选的，也有合理的默认值。

表 2.2. NHibernate 配置属性

属性名 用途
hibernate.dialect NHibernate方言（Dialect）的类名 - 可以让NHibernate使用某些特定的数据库平台的特性

例如： full.classname.of.Dialect（如果方言创建在NHibernate中）, 或者full.classname.of.Dialect, assembly （如果使用一个自定义的方言的实现，它不属于NHibernate）。

hibernate.default_schema 在生成的SQL中，scheml/tablespace的全限定名.

例如： SCHEMA_NAME

hibernate.prepare_sql

是否准备sql语句

例如： true | false

hibernate.session_factory_name SessionFactory被创建后将自动绑定这个名称.

例如： some.name

hibernate.use_outer_join 允许使用外连接抓取。

例如：true | false

hibernate.cache.provider_class 指定一个自定义的CacheProvider缓存提供者的类名

例如： full.classname.of.CacheProvider（如果ICacheProvider创建在NHibernate中）, 或full.classname.of.CacheProvider, assembly（如果使用一个自定义的ICacheProvider，它不属于NHibernate）。

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

例如： hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC

SQL 方言 (SQL Dialects)

你总是可以为你的数据库设置一个hibernate.dialect方言，它是NHibernate.Dialect.Dialect 的一个子类。如果你不需要使用基于native或者sequence的主键自动生成算法，或者悲观锁定（使用ISession.Lock() 或者 IQuery.SetLockMode())的话，方言就可以不必指定。然而，假若你指定了一个方言，Hibernate会为上面列出的一些属性使用特殊默认值，省得你手工指定它们。

表 2.3. NHibernate SQL 方言 (hibernate.dialect)

RDBMS 方言
DB2 NHibernate.Dialect.DB2Dialect
PostgreSQL NHibernate.Dialect.PostgreSQLDialect
MySQL NHibernate.Dialect.MySQLDialect
Oracle (any version) NHibernate.Dialect.OracleDialect
Oracle 9/10g NHibernate.Dialect.Oracle9Dialect
Sybase NHibernate.Dialect.SybaseDialect
Microsoft SQL Server 2000 NHibernate.Dialect.MsSql2000Dialect
Microsoft SQL Server 7 NHibernate.Dialect.MsSql7Dialect
Firebird NHibernate.Dialect.FirebirdDialect
外连接抓取（Outer Join Fetching ）

如果你的数据库支持ANSI或者Oracle风格的外连接，外连接抓取可能提高性能，因为可以限制和数据库交互的数量（代价是数据库自身进行了更多的工作）。外连接抓取允许你在一个SELECT语句中就可以得到一个由多对一或者一对一连接构成的对象图。

默认情况下，抓取在叶对象，拥有代理的对象或者产生对自身的引用时终止。

对一个特定关联来说，通过在XML映射文件中设置outer-join属性可以控制是否开启抓取功能。

设置hibernate.use_outer_join为false将禁用全局的外连接抓取.设置为true将启用所有一对一(one-to-one)和多对一(many-to-one)关联中的外连接抓取,默认情况下，它被设置为auto，即自动外连接。但是，一对多关联和集合永远不会使用外连接抓取，除非对每个特定的关联进行明确声明。这一行为可以在运行时通过NHibernate 查询重载。

自定义 CacheProvider

通过实现NHibernate.Cache.ICacheProvider接口，你可以整合一个第二级缓存进来。你可以通过hibernate.cache.provider_class选择某个自定义的实现。

查询语言替换

你可以使用hibernate.query.substitutions定义新的NHibernate查询短语。比如说： 

hibernate.query.substitutions true=1, false=0

会在生成的SQL中把短语true和 false替换成整数值。 

hibernate.query.substitutions toLowercase=LOWER

这可以让你重新命名SQL的LOWER 函数。

Logging

通过Apache log4net，NHibernate记录很多事件。

你可以从 http://logging.apache.org/log4net/下载 log4net. 要使用log4net,你要在app.config或者web.config中配置log4net节点.在src/NHibernate.Test工程中有一个配置的例子.

我们强烈建议你熟悉NHibernate's的log信息。NHibernate's的很多工作都会尽量详细的留下log,也没有让它变的难以阅读。这是用来解决问题的最基本的设施。