NHibernate 2.0 參考文檔 - 03 配置

昵稱10504424 2014-03-31

展開(kāi)全文

3. 配置

　　由于NHibernate是為了能在各種不同環(huán)境下工作而設(shè)計(jì)的, 因此存在著大量的配置參數(shù).

　　幸運(yùn)的是多數(shù)配置參數(shù)都有比較直觀的默認(rèn)值, 并有隨Hibernate一同分發(fā)的配置樣例 App.config(位于src\NHibernate.Test)來(lái)展示各種配置選項(xiàng).

　　所需做的僅僅是將這個(gè)樣例文件復(fù)制到自己的項(xiàng)目路徑下并做一些自定義的修改.

3.1. 可編程的配置方式

　　一個(gè)NHibernate.Cfg.Configuration實(shí)例代表了一個(gè)應(yīng)用程序中.NET類(lèi)型到SQL數(shù)據(jù)庫(kù)映射的完整集合．

　　Configuration被用來(lái)構(gòu)建一個(gè)(不可變的 (immutable)) ISessionFactory. 映射定義則由不同的XML映射定義文件編譯而來(lái)。

　　你可以直接實(shí)例化Configuration來(lái)獲取一個(gè)實(shí)例，下面是一個(gè)例子如何加載兩個(gè)xml映射文件。

1 Configuration cfg = new Configuration()
2     .AddFile("Item.hbm.xml")
3     .AddFile("Bid.hbm.xml");

　　另一個(gè)方法（有時(shí)候可能會(huì)更好），讓NHibernate從嵌入式資源里面加載映射文件：

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

　　NHibernate將會(huì)在當(dāng)前應(yīng)用程序集中中尋找名字為NHibernate.Auction.Item.hbm.xml和 NHibernate.Auction.Bid.hbm.xml嵌入式資源文件. 這種方式消除了任何對(duì)文件名的硬編碼(hardcoded).

　　還有一種方法（應(yīng)該是最好的），讓NHibernate自動(dòng)到程序集加載所有的嵌入式資源xml映射文件。

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

　　NHibernate會(huì)自動(dòng)到應(yīng)用程序集里查找所有的以.hbm.xml結(jié)尾的資源文件。這種方式消除了任何對(duì)文件名的硬編碼(hardcoded)，并且確保了應(yīng)用程序集里的所有的xml映射文件都被加載。

　　如果使用Visual Studio .NET 和 NAnt 來(lái)編譯應(yīng)用程序集的話，請(qǐng)確保.hbm.xml文件被作為嵌入式資源編譯進(jìn)應(yīng)用程序集。

Configuration也允許你指定配置屬性：

1 IDictionary<string, string> props = new Dictionary<string, string>();
2 ...
3 Configuration cfg = new Configuration()
4     .AddClass(typeof(NHibernate.Auction.Item))
5     .AddClass(typeof(NHibernate.Auction.Bind))
6     .SetProperties(props);

　　Configuration實(shí)例被設(shè)計(jì)成啟動(dòng)期間（configuration-time）對(duì)象, 一旦ISessionFactory創(chuàng)建完成它就被丟棄了。

3.2. 獲得ISessionFactory

　　當(dāng)所有映射定義被Configuration解析后，應(yīng)用程序必須獲得一個(gè)用于構(gòu)造ISession實(shí)例的工廠。這個(gè)工廠將被應(yīng)用程序的所有線程共享：

1 ISessionFactory sessions = cfg.BuildSessionFactory();

　　NHibernate允許你的應(yīng)用程序創(chuàng)建多個(gè)ISessionFactory實(shí)例。這對(duì)使用多個(gè)數(shù)據(jù)庫(kù)的應(yīng)用來(lái)說(shuō)很有用。

3.3. 用戶自行提供ADO.NET連接

　　ISessionFactory可以通過(guò)用戶自己創(chuàng)建的ADO.NET連接創(chuàng)建一個(gè)ISession，這樣的設(shè)計(jì)可以讓你讓你們的程序更方便的獲取數(shù)據(jù)庫(kù)連接：

1 IDbConnection conn = myApp.GetOpenConnection();
2 ISession session = sessions.OpenSession(conn);
3 
4 // do some data access work

　　注意不要用同一個(gè)ADO.NET打開(kāi)兩個(gè)不同的ISession！

3.4. NHibernate提供ADO.NET連接

　　另一種方法就是，你可以讓ISessionFactory替你打開(kāi)連接。ISessionFactory必須事先知道ADO.NET連接的參數(shù)，有幾種不同的方法設(shè)置參數(shù)：

通過(guò)提供一個(gè)IDictionary實(shí)例給Configuration.SetProperties()。
在名為nhibernate的System.Configuration.NameValueSectionHandler類(lèi)型的配置節(jié)點(diǎn)添加屬性。
在應(yīng)用程序的配置文件中的配置節(jié)里包含 <property>元素，配置節(jié)命名為 hibernate-configuration，并且要被設(shè)置為使用NHibernate.Cfg.ConfigurationSectionHandler處理。 XML名稱空間要被設(shè)置為urn:nhibernate-configuration-2.2。
在hibernate.cfg.xml 中包含 <property>元素（后面會(huì)繼續(xù)討論）。

　　如果你使用這種方法，打開(kāi)一個(gè)ISession是非常簡(jiǎn)單的：

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

　　所有的NHibernate屬性名和約束都在 NHibernate.Cfg.Environment類(lèi)中定義。我們討論一下ADO.NET連接配置最重要的幾項(xiàng)設(shè)置：

　　假若你設(shè)置了如下的屬性，NHibernate會(huì)使用ADO.NET Data Provider來(lái)得到連接：

表 3.1. NHibernate ADO.NET 屬性

屬性名	用途
`connection.provider_class`	實(shí)現(xiàn)`IConnectionProvider`接口的類(lèi)型。例如：（如果是NHibernate內(nèi)部的`IConnectionProvider`實(shí)現(xiàn)類(lèi)）`full.classname.of.ConnectionProvider`，（如果是自定義的NHibernate外部的`IConnectionProvider`實(shí)現(xiàn)類(lèi) ）`full.classname.of.ConnectionProvider, assembly`。
`connection.driver_class`	如果使用`DriverConnectionProvider`，實(shí)現(xiàn)`IDriver`接口的類(lèi)型。（如果是NHibernate內(nèi)部的實(shí)現(xiàn)的IDriver類(lèi)型）`full.classname.of.Driver` （如果是自定義的NHibernate外部的IDriver實(shí)現(xiàn)類(lèi) ）`full.classname.of.Driver, assembly`。這個(gè)配置通常是不需要配置的，如果設(shè)置好了`hibernate.dialect`一般會(huì)自動(dòng)選好對(duì)應(yīng)的`IDriver`。詳細(xì)的dialect與IDriver的默認(rèn)對(duì)應(yīng)關(guān)系可以查看API文檔。
`connection.connection_string`	數(shù)據(jù)庫(kù)連接字符串
`connection.connection_string_name`	數(shù)據(jù)庫(kù)連接字符串名稱(定義在.Net配置文件`<connectionStrings>`配置節(jié)里面的連接字符串名。
`connection.isolation`	ADO.NET事務(wù)隔離級(jí)別，查看`System.Data.IsolationLevel`類(lèi)來(lái)了解各個(gè)值的具體意義, 但請(qǐng)注意多數(shù)數(shù)據(jù)庫(kù)都不支持所有的隔離級(jí)別. 例如： `Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified`
`connection.release_mode`	指定ADO.NET何時(shí)釋放數(shù)據(jù)庫(kù)連接。查看10.7 連接釋放模式. 例如： `auto` (默認(rèn)) \| `on_close` \| `after_transaction` 注意,這些設(shè)置僅對(duì)通過(guò)`ISessionFactory.OpenSession`得到的`ISession`起作用。對(duì)于通過(guò)`ISessionFactory.GetCurrentSession`得到的`ISession`，所配置的`ICurrentSessionContext`實(shí)現(xiàn)控制這些`ISession`的連接釋放模式。請(qǐng)參閱2.3。上下文相關(guān)的(Contextual) Session獲取更多信息。
`command_timeout`	指定NHibernate生成的`IDbCommands`對(duì)象的超時(shí)時(shí)間。 .
`adonet.batch_size`	指定用ADO.Net的批量更新的數(shù)量，默認(rèn)設(shè)置為0（不啟用該功能）。請(qǐng)參閱16.6. 批量更新.

　　下面是一個(gè)如何在web.config里如何設(shè)置數(shù)據(jù)庫(kù)連接屬性的例子：

 1 <configuration>
 2     <configSections>
 3         <section name="hibernate-configuration"
 4          type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
 5     </configSections>
 6 
 7                 <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
 8         <session-factory>
 9             <property name="connection.provider">NHibernate.Connection.DriverConnectionProvider, NHibernate</property>
10             <property name="connection.connection_string">
11                 Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI
12             </property>
13             <property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
14             <property name="current_session_context_class">managed_web</property>
15         </session-factory>
16     </hibernate-configuration>
17     <!-- other app specific config follows -->
18     
19 </configuration>

在web.config里設(shè)置數(shù)據(jù)庫(kù)連接屬性

　　NHibernate依賴的ADO.NET自己實(shí)現(xiàn)的數(shù)據(jù)庫(kù)連接池。

　　你也可以通過(guò)實(shí)現(xiàn)NHibernate.Connection.IConnectionProvider接口來(lái)自己定義ADO.NET連接獲取策略，你也可以通過(guò)設(shè)置connection.provider_class來(lái)更換數(shù)據(jù)庫(kù)連接獲取策略。

3.5. 可選的配置屬性

　　有大量屬性能用來(lái)控制NHibernate在運(yùn)行期的行為. 它們都是可選的, 并擁有適當(dāng)?shù)哪J(rèn)值.

　　警告: 其中一些屬性是"系統(tǒng)級(jí)(system-level)的"，系統(tǒng)級(jí)屬性只能通過(guò)在代碼里設(shè)置NHibernate.Cfg.Environment類(lèi)的靜態(tài)屬性，或者在配置文件里的<hibernate-configuration>配置節(jié)里來(lái)設(shè)置, 而不能用Configuration.SetProperties方法來(lái)設(shè)置。

表 3.2. NHibernate配置屬性

屬性名	用途
`dialect`	設(shè)置NHibernate的`Dialect`類(lèi)名 - 允許NHibernate針對(duì)特定的關(guān)系數(shù)據(jù)庫(kù)生成優(yōu)化的SQL 可用值： `full.classname.of.Dialect, assembly`
`default_schema`	在生成的SQL中, 將給定的schema/tablespace附加于非全限定名的表名上. 可用值： `SCHEMA_NAME`
`use_outer_join`	允許外連接抓取，已棄用，請(qǐng)使用`max_fetch_depth`。可用值： `true` \| `false`
`max_fetch_depth`	為單向關(guān)聯(lián)(一對(duì)一, 多對(duì)一)的外連接抓?。╫uter join fetch）樹(shù)設(shè)置最大深度. 值為`0`意味著將關(guān)閉默認(rèn)的外連接抓取可用值：建議在`0` 到`3`之間取值。
`use_reflection_optimizer`	開(kāi)啟運(yùn)行時(shí)代碼動(dòng)態(tài)生成來(lái)替代運(yùn)行時(shí)反射機(jī)制(系統(tǒng)級(jí)屬性). 使用這種方式的話程序在啟動(dòng)會(huì)耗費(fèi)一定的性能，但是在程序運(yùn)行期性能會(huì)有更好的提升. 注意即使關(guān)閉這個(gè)優(yōu)化, Hibernate還是需要CGLIB. 你不能在hibernate.cfg.xml中設(shè)置此屬性. 這個(gè)屬性不能在`hibernate.cfg.xml`或者是應(yīng)用程序配置文件`<hibernate-configuration>` 配置節(jié)中設(shè)置。可用值： `true` \| `false`
`bytecode.provider`	指定字節(jié)碼provider用于優(yōu)化NHibernate反射性能。 `null`代表完全關(guān)閉性能優(yōu)化, `lcg`用于輕量級(jí)的代碼動(dòng)態(tài)生成,`codedom`基于CodeDOM代碼動(dòng)態(tài)生成。可用值： `null` \| `lcg` \| `codedom`
`cache.provider_class`	設(shè)置緩存實(shí)現(xiàn)類(lèi)（實(shí)現(xiàn)`ICacheProvider`接口的類(lèi)）可用值： `classname.of.CacheProvider, assembly`
`cache.use_minimal_puts`	以頻繁的讀操作為代價(jià), 優(yōu)化二級(jí)緩存來(lái)最小化寫(xiě)操作（對(duì)群集緩存有效）。可用值： `true` \| `false`
`cache.use_query_cache`	允許查詢緩存, 個(gè)別查詢?nèi)匀恍枰辉O(shè)置為可緩存的. 可用值： `true` \| `false`
`cache.query_cache_factory`	自定義實(shí)現(xiàn)`IQueryCacheFactory`接口的類(lèi)名, 默認(rèn)為內(nèi)建的`StandardQueryCacheFactory`。可用值： `classname.of.QueryCacheFactory, assembly`
`cache.region_prefix`	二級(jí)緩存區(qū)域名的前綴。可用值： `prefix`
`query.substitutions`	將NHibernate查詢中的符號(hào)映射到SQL查詢中的符號(hào) (符號(hào)可能是函數(shù)名或常量名字). 可用值： `hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC`
`show_sql`	輸出所有SQL語(yǔ)句到控制臺(tái). 可用值： `true` \| `false`
`hbm2ddl.auto`	在`ISessionFactory`創(chuàng)建時(shí)，自動(dòng)檢查數(shù)據(jù)庫(kù)結(jié)構(gòu)，或者將數(shù)據(jù)庫(kù)schema的DDL導(dǎo)出到數(shù)據(jù)庫(kù). 使用 create-drop時(shí),在顯式關(guān)閉`ISessionFactory`時(shí)，將drop掉數(shù)據(jù)庫(kù)schema. 可用值： `create` \| `create-drop`
`use_proxy_validator`	是否啟用驗(yàn)證接口或者是類(lèi)是否可以使用代理，默認(rèn)開(kāi)啟。（檢查實(shí)體類(lèi)的屬性或者是方法是否被設(shè)置為Virtual）可用值： `true` \| `false`
`transaction.factory_class`	自定義`ITransactionFactory`的實(shí)現(xiàn)，默認(rèn)為NHibernate內(nèi)建的`AdoNetTransactionFactory`。可用值： `classname.of.TransactionFactory, assembly`

3.5.1. SQL 方言

　　你應(yīng)當(dāng)總是為你的數(shù)據(jù)庫(kù)將hibernate.dialect屬性設(shè)置成正確的 NHibernate.Dialect.Dialect子類(lèi).

　　不過(guò)這并不是要嚴(yán)格執(zhí)行的除非你帶算使用 native或者是sequence主鍵生成策略或者是悲觀鎖定（例如使用ISession.Lock()或者是IQuery.SetLockMode()），如果你指定一種方言, NHibernate將為上面列出的一些屬性使用合理的默認(rèn)值, 為你省去了手工指定它們的功夫.

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

關(guān)系型數(shù)據(jù)庫(kù)	方言	備注
DB2	`NHibernate.Dialect.DB2Dialect`
DB2 for iSeries (OS/400)	`NHibernate.Dialect.DB2400Dialect`
Ingres	`NHibernate.Dialect.IngresDialect`
PostgreSQL	`NHibernate.Dialect.PostgreSQLDialect`
PostgreSQL 8.1	`NHibernate.Dialect.PostgreSQL81Dialect`	方言在PostgreSQL8.1中現(xiàn)在支持`FOR UPDATE NOWAIT`了。
PostgreSQL 8.2	`NHibernate.Dialect.PostgreSQL82Dialect`	方言在PostgreSQL8.2中現(xiàn)在支持在 `DROP TABLE`和`DROP SEQUENCE`中使用`IF EXISTS`關(guān)鍵字了。
MySQL 3 or 4	`NHibernate.Dialect.MySQLDialect`
MySQL 5	`NHibernate.Dialect.MySQL5Dialect`
Oracle (any version)	`NHibernate.Dialect.OracleDialect`
Oracle 9/10g	`NHibernate.Dialect.Oracle9Dialect`
Sybase Adaptive Server Enterprise	`NHibernate.Dialect.SybaseDialect`
Sybase Adaptive Server Anywhere	`NHibernate.Dialect.SybaseAnywhereDialect`
Microsoft SQL Server 2000	`NHibernate.Dialect.MsSql2000Dialect`
Microsoft SQL Server 2005	`NHibernate.Dialect.MsSql2005Dialect`
Microsoft SQL Server 2005 Everywhere Edition	`NHibernate.Dialect.MsSqlCeDialect`
Microsoft SQL Server 7	`NHibernate.Dialect.MsSql7Dialect`
Firebird	`NHibernate.Dialect.FirebirdDialect`	把`driver_class`設(shè)置為 `NHibernate.Driver.FirebirdClientDriver`啟用Firebird provider for .NET 2.0。
SQLite	`NHibernate.Dialect.SQLiteDialect`	把`driver_class`設(shè)置為`NHibernate.Driver.SQLite20Driver`啟用System.Data.SQLite provider for .NET 2.0。
Ingres 3.0	`NHibernate.Dialect.IngresDialect`

　　其他可用的方言都包含在NHibernate Contrib項(xiàng)目中，(請(qǐng)參閱《I. NHibernateContrib 參考文檔》)?，F(xiàn)在這個(gè)項(xiàng)目里僅僅包含Microsoft Access (Jet)數(shù)據(jù)庫(kù)方言.

1 query.substitutions true=1, false=0

　　將導(dǎo)致符號(hào)true和false在生成的SQL中被翻譯成整數(shù)常量.

1 query.substitutions toLowercase=LOWER

　　將允許你重命名SQL中的LOWER函數(shù).

3.6. 日志

　　NHibernate使用Apache log4net來(lái)為各種事件記錄日志。

　　你可以從http://logging./log4net/下載log4net。你需要在應(yīng)用程序配置文件添加一個(gè)log4net配置節(jié)用于配置log4net。

　　NHibernate的源代碼分發(fā)包里有一個(gè)示例配置文件，位置在src/NHibernate.Test。

　　我們強(qiáng)烈建議你熟悉一下NHibernate的日志消息. 在不失可讀性的前提下，我們做了很多工作，使NHibernate的日志可能地詳細(xì)。

　　這是必要的查錯(cuò)利器。當(dāng)你遇到問(wèn)題的時(shí)候不要忘了設(shè)置show_sql開(kāi)啟SQL日志。

3.7. 實(shí)現(xiàn) `INamingStrategy`

　　NHibernate.Cfg.INamingStrategy接口允許你為數(shù)據(jù)庫(kù)中的對(duì)象和schema 元素指定一個(gè)“命名標(biāo)準(zhǔn)”.

　　這個(gè)特性有助于減少冗長(zhǎng)的映射定義文件. (例如：TBL_ 前綴). NHibernate默認(rèn)是最小化實(shí)現(xiàn)。

　　在加入映射定義前，你可以調(diào)用 Configuration.SetNamingStrategy()指定一個(gè)不同的命名策略:

1 ISessionFactory sf = new Configuration()
2     .SetNamingStrategy(ImprovedNamingStrategy.Instance)
3     .AddFile("Item.hbm.xml")
4     .AddFile("Bid.hbm.xml")
5     .BuildSessionFactory();

　　NHibernate.Cfg.ImprovedNamingStrategy是一個(gè)內(nèi)建的命名策略, 對(duì)一些應(yīng)用程序而言，可能是非常有用的起點(diǎn).

3.8. XML配置文件

　　另一個(gè)配置方法是在hibernate.cfg.xml文件中指定一套完整的配置. 這個(gè)文件可以當(dāng)成配置文件中的 <nhibernate;>和<hibernate-configuration>配置節(jié)的替代。

　　XML配置文件默認(rèn)放在應(yīng)用程序的根目錄下。下面是一個(gè)例子：

 1 <?xml version='1.0' encoding='utf-8'?>;
 2 <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
 3     <session-factory>
 4         <!-- properties -->
 5         <property name="connection.provider">NHibernate.Connection.DriverConnectionProvider</property>
 6         <property name="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>
 7         <property name="connection.connection_string">Server=localhost;initial catalog=nhibernate;User Id=;Password=</property>
 8         <property name="show_sql">false</property>
 9         <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>
10         <property name="use_outer_join">true</property>
11 
12         <!-- mapping files -->
13         <mapping resource="NHibernate.Auction.Item.hbm.xml" assembly="NHibernate.Auction" />
14         <mapping resource="NHibernate.Auction.Bid.hbm.xml" assembly="NHibernate.Auction" />
15     </session-factory>
16 /hibernate-configuration>

XML配置文件

　　使用XML配置，使得啟動(dòng)NHibernate變的異常簡(jiǎn)單, 如下所示，一行代碼就可以搞定：

1 ISessionFactory sf = new Configuration().Configure().BuildSessionFactory();

　　你可以使用如下代碼來(lái)添加一個(gè)不同的XML配置文件

1 ISessionFactory sf = new Configuration()
2     .Configure("/path/to/config.cfg.xml")
3     .BuildSessionFactory();

本站是提供個(gè)人知識(shí)管理的網(wǎng)絡(luò)存儲(chǔ)空間，所有內(nèi)容均由用戶發(fā)布，不代表本站觀點(diǎn)。請(qǐng)注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購(gòu)買(mǎi)等信息，謹(jǐn)防詐騙。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容，請(qǐng)點(diǎn)擊一鍵舉報(bào)。

轉(zhuǎn)藏 分享

QQ空間 QQ好友新浪微博微信

獻(xiàn)花（0） +1

來(lái)自：昵稱10504424 > 《工作》

舉報(bào)/認(rèn)領(lǐng)