Felice Pollano Blog - hbm2net

Hbm2net & Db2hbm built on NH3

Felice Pollano — Wed, 22 Dec 2010 10:39:01 GMT

The hbm2net and db2hbm tool are now updated to the latest NH version. The fastest location for download are:

The solution on sourceforge now is updated to VS 2010.

NHibernate de la ZERO Partea a 6-a: Utilizarea sesiunilor

Felice Pollano — Sat, 23 Oct 2010 17:47:18 GMT

Continuare la partea a 5-a

În această parte ne vom opri puţin să analizăm mai bine cum şi când se activează sesiunea (ISession) şi care sunt modalităţile cele mai corecte pentru a o face. Să vedem în mare ce face Session:

Permite recuperarea, salvarea şi eliminarea entităţilor.
Menţine un mapp al entităţilor organizat ca reference/ID Database
Administrează un cache ( first level cache ) care, prin mapp-ul de mai sus, evită să meargă la baza de date pentru a recupera o entitate pe care o avem deja in memorie
Ţine evidenţa entităţilor modificate
Administrează interacţiunile cu driver-ul ADO.NET , inclusiv deschiderea închiderea conexiunilor.
Ne permite să închidem şi să deschidem tranzacţiile.

Cel de-al doilea punct merită un comentariu: între diferenţele conceptuale dintre baza de date şi obiecte .Net există identitatea obiectului. În baza de date relaţia de identitate este după o ultimă analiză garantată de ID-ul rândului, în timp ce în .NET identitatea a două obiecte este după o ultimă analiză raportată la confruntarea dintre două reference. NHibernate vrea să evite existenţa acestor ambiguităţi şi susţine faptul că trebuie să existe o singură reference care să mizeze la un determinat obiect persistent: chiar dacă creăm un obiect clonă al unui obiect persistent şi incercăm, de exemplu să-l eliminăm sau să-l modificăm, această clonă nu va fi acceptată de NHibernate.

Practic când avem nevoie să interacţionăm cu obiectele persistent, avem necesitatea de a lucra în sfera unei sesiuni. Acest lucru introduce adesea nişte erori când căutăm momentul oportun pentru a deschide sesiunea:

Open Session: De evitat

1. De evitat deschiderea unei sesiuni pentru fiecare interacţiune pe care vrem să o avem cu stratul persistenţei ( Session-per-operation Antipattern )

2. De evitat utilizarea unei singure sesiuni pe întreaga durată a aplicaţiei. ( Session-per-application Antipattern ) Am mai spus acest lucru, dar e bine de amintit având în vedere că vorbim despre lucruri de evitat: dacă sesiunea are o anumită agilitate de uz, Session Factory trebuie să fie deschisă o singură dată în interiorul unui app domain. Nu pentru că ar exista ceva ce nu funcționează, dar pur şi simplu sesiunea factory se încarcă lent.

Dacă folosim prima strategie, ne lovim puternic de faptul că NH nu vrea să "mixeze" entităţi ce aparţin mai multor sesiuni, se pierde orice fel de beneficiu al cach-ului de prim nivel, iar obiectele lazy tind să producă cunoscuta eroare “NHibernate.LazyInitializationException: illegal access to loading collection”, datorită faptului că sesiunea care a creat obiectul a fost deja închisă, iar NH nu poate să meargă să recupereze obiectele colecţiei.

Cea de-a doua strategie este mai complicată: lucrăm cu date în "repaus", adică date ce probabil nu sunt aduse la zi cu respectivele obiecte salvate, sesiunea se îngreunează (NH devine din ce în ce mai lent dacă obiectele tratate de o sesiune sunt prea multe), nu se mai asigură o politică corectă de administrare a conexiunii la BD, care trebuie să fie deschisă doar pe timpul necesar, şi deci închisă.

Soluţia recomandată este Session per Business Transaction. O busuness transaction este, pentru a face un exemplu: „citesc prima pagină a clienţilor", "Introduc o nouă comandă", "Caut toate produsele ce încep cu XXX în depozit", etc. Deci operaţiuni autoincluse, dar nu triviale. În aplicaţii pot exista uşoare diferenţe între rich client şi Web application, în aceste din urmă realizarea acestui pattern poate converge în Session Per Request, ce constă în deschiderea unei sesiuni când se verifică evenimentul Begin request, şi închiderea acesteia la următorul End. Acest gen de contact, în general este aproape echivalent cu Session Per bussines transaction, pentru că de fapt, într-o aplicaţie web un ciclu request/response coincide cu o bussines transaction.

Putem folosi în acest scop patterm-ul Unit of Work. În sursele de exemplu am pus o versiune simplă, care utilizează ContextSession ale NH. Practic aceste Context session ne permit să împărtăşim o sesiune între mai multe funcţii ale aplicaţiei noastre, în realaţie cu un context ce poate fi, de exemplu Thread-ul curent, sau HttpContext-ul apelului la web server, sau oricare alt lucru, din punctul de vedere al configurării. Ca să ne fie mai clar, să vedem sursele:

 1: public class NHUow:IDisposable

 2: {

 3: private NHUow()

 4: {

 5: if (CurrentSessionContext.HasBind(sessionFactory))

 6: throw new InvalidOperationException("Nested
unit of work not allowed.");

 7: CurrentSessionContext.Bind(sessionFactory.OpenSession());

 8: }

9:

 10: static object lockObject
= new object();

 11: public static NHUow
Open()

 12: {

 13: lock (lockObject)

 14: {

 15: if (sessionFactory
== null)

 16: CreateSessionFactory();

 17: }

 18: return new NHUow();

 19: }

 20: public static ISession
CurrentSession

 21: {

 22: get
{ return sessionFactory.GetCurrentSession();
}

 23: }

24:

 25: private static ISessionFactory
sessionFactory;

 26: private static void CreateSessionFactory()

 27: {

 28: Configuration
cfg = CreateConfiguration();

 29: sessionFactory
= cfg.BuildSessionFactory();

 30: }

31:

 32: private static Configuration
CreateConfiguration()

 33: {

 34: Configuration
cfg = new Configuration();

 35: cfg.Configure();

 36: //
implicitamente carichiamo tutti i mapping che si trovano nell'assembly che

 37: //
contiene customer

 38: cfg.AddAssembly(typeof(Customer).Assembly);

 39: return cfg;

 40: }

41:

42:

 43: #region IDisposable
Members

44:

 45: public void Dispose()

 46: {

 47: if (!CurrentSessionContext.HasBind(sessionFactory)
)

 48: {

 49: throw new InvalidOperationException("Invalid
current session");

 50: }

 51: var
session = sessionFactory.GetCurrentSession();

 52: CurrentSessionContext.Unbind(sessionFactory);

 53: if (!session.IsOpen)

 54: {

 55: throw new InvalidOperationException("Session
closed before UOW end");

 56: }

57:

 58: if ( null !=
session.Transaction && session.Transaction.IsActive )

 59: {

 60: if (session.Transaction.WasCommitted
== false && session.Transaction.WasRolledBack
== false)

 61: session.Transaction.Rollback();

 62: }

 63: session.Close();

 64: }

65:

 66: #endregion

 67: }

Obiectul implementează IDisposable, şi ne permite să-l utilizăm în acest fel:

 1: using (var
uow = NHUow.Open())

 2: {

 3: var
transaction = NHUow.CurrentSession.BeginTransaction();

 4: Customer
c = new Customer();

 5: c.Name
= "FELIX";

 6: c.AddressLine1
= c.AddressLine2 = "";

 7: c.City
= "XX";

 8: c.ZipCode
= "12060";

 9: NHUow.CurrentSession.Save(c);

 10: transaction.Commit();

 11: }

Practic deschid o unitate de lucru cu using new… şi, odată ieşiţi din scope, uow se închide. În interiorul acestui scope, întregul nostru cod va putea accesa sesiunea curentă folosind funcţia statică NHUow.CurrentSession. Cei mai atenţi vor observa faptul că configurarea sesiunii factory este fixă:acest lucru se întâmplă pentru a simplifica clasa UOW, pentru a o face să devină generală este de ajuns să intervenim adăugând o Session FactoryFactory, pe care UOW o va utiliza pentru a recupera Session factory - ul extern.

Dacă în acest moment am lansa unit testul de probă, am obţine următoarea excepţie:

No CurrentSessionContext configured (set the property current_session_context_class)!

Asta se întâmplă deoarece mecanismul de întreţinere al sesiunilor de context al NH este configurabil, iar noi nu am specificat nimic. După cum spune mesajul de eroare, trebuie să adăugăm în fişierul de config rândul current_session_context_class ( rândul 11 ):

 1: <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">

 2: <session-factory name="NHibernate.Test">

 3: <property name="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>

 4: <property name="connection.connection_string">Server=.\SQLEXPRESS;initial
catalog=NHFROMSCRATCH;Integrated Security=SSPI</property>

 5: <property name="adonet.batch_size">10</property>

 6: <property name="show_sql">true</property>

 7: <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>

 8: <property name="use_outer_join">true</property>

 9: <property name="command_timeout">60</property>

 10: <property name="query.substitutions">true
1, false 0, yes 'Y', no 'N'</property>

 11: <property name="current_session_context_class">thread_static</property>

 12: <property name="proxyfactory.factory_class">NHibernate.ByteCode.LinFu.ProxyFactoryFactory,
NHibernate.ByteCode.LinFu</property>

 13: </session-factory>

 14: </hibernate-configuration>

Observaţi că nu am introdus un nume al clasei, asta pentru că există anumite shortcut pentru cei mai folosiţi context manager. Enumerăm posibili context manager:

· NHibernate.Context.WebSessionContext – Sesiunea curentă este inclusă în HttpContext. Alias web.

· NHibernate.Context.CallSessionContext - Sesiunea curentă este inclusă în CallContext. Alias call.

· NHibernate.Context.ThreadStaticSessionContext – Sesiunea curentă este în context –ul thread-ului. Alias thread_static.

Desigur, tot cu filosofia maximei extensibilităţi, putem scrie context manager-ul nostru.

In sursele de exemplu, pe lângă clasa UOW, există o clasă a Unit Test-ului NHFromScratch.Tests.Uow , care arată cum se foloseşte.

NHibernate: Partire da ZERO Parte 6:Utilizzo delle sessioni

Felice Pollano — Sat, 16 Oct 2010 16:48:51 GMT

In questa parte ci fermiamo un attimo ad analizzare meglio come e quando attivare la sessione (ISession) e quali siano le modalità più corrette per farlo. Vediamo per grandi linee cosa fa Session:

Consente di recuperare salvare ed eliminare le entità.
Mantiene una mappa delle entità organizzata come reference/ID Database
Gestisce una cache ( first level cache ) che, tramite la mappa di cui sopra, ci evita di andare sul database per recuperare un entità che abbiamo già in memoria
Tiene traccia delle entità modificate
Gestisce le interazioni con il driver ADO.NET sottostante, comprese l’apertura chiusura delle connessioni.
Ci consente di aprire e chiudere le transazioni.

Il punto 2 merita un commento: tra le difformità concettuali tra database e oggetti .NET vi è l’identità dell’oggetto. Nel database la relazione di identità è in ultima analisi garantita dall’ID della riga, mentre in .NET l’identità di due oggetti è in ultima analisi riconducibile al confronto fra due reference. NHibernate vuole evitare che ci siano queste ambiguità, e asserisce che ci debba essere una sola reference che punti ad un determinato oggetto persistent: anche se creiamo un oggetto clone di un oggetto persistent e cerchiamo, per esempio, di cancellarlo o di modificarlo, questo clone non sarà accettato da NHIbernate.

In pratica, quando ci serve di interagire con gli oggetti persistent, abbiamo necessita di lavorare nell’ambito di una sessione. Questo introduce spesso degli errori quando cerchiamo il momento opportuno per aprire la sessione:

Open Session: Pratiche da evitare

Evitare di aprire la session per ogni singola interazione che si vuole avere con lo strato di persistenza. ( Session-per-operation Antipattern )
Evitare di utilizzare una sola session per l’intera durata dell’ applicazione. ( Session-per-application Antipattern )

Già lo abbiamo detto, ma è meglio ricordarlo visto che siamo in zona di cose da evitare: se la session ha comunque una certa agilità di uso, la SessionFacory deve essere aperta una volta sola all’interno di un app domain. Non che ci sia qualcosa che non funziona, ma semplicemente la session factory è lenta a caricarsi.

Se si usa la prima strategia, ci si scontra violentemente con il fatto che NH non vuole “mixare” entità appartenenti a più sessioni, si perde qualsiasi beneficio della cache di primo livello, e gli oggetti lazy tendono a produrre il famigerato errore “NHibernate.LazyInitializationException: illegal access to loading collection”, dovuto al fatto che la sessione che ha creato l’ogegtto ormai l’abbiamo chiusa, e NH non può andare a fare il recupero degli oggetti della collection.

La seconda strategia se possibile è anche peggiore: lavoriamo con dati in “stallo”, cioè possibilmente non aggiornati con i rispettivi oggetti persistiti, la session si appesantisce ( NH diventa sempre più lento se gli oggetti trattati da una session sono troppi ), non si assicura più una corretta politica di gestione della connessione al DB,che deve essere aperta per il tempo strettamente necessario e quindi chiusa.

La soluzione consigliata è la Session per Business Transaction. Una business transaction è, tanto per fare un esempio: “leggo la prima pagina dei clienti”, “Inserisco un nuovo ordine”, “cerco tutti i prodotti in magazzino che iniziano per XXX”, ecc. Quindi operazioni autocontenute, ma non triviali. Nelle applicazioni ci possono essere delle leggere differenze tra rich client e Web application, in queste ultime la realizzazione di questo pattern può convergere nella Session Per Request, che consiste nell’aprire una session quando si verifica l’evento Begin request, e di chiuderla al succesivo End. Questo approccio in generale è pressoche equivalente al Session Per business transaction, perchè di fatto in un applicativo web un ciclo request/response coincide con una business transaction.

Possiamo utilizzare per questo scopo il pattern Unit of Work. Nei sorgenti di esempio ne ho messo una versione semplice, che utilizza le ContextSession di NH. In pratica le context session ci consentono di condividere una sessione tra più funzioni del nostro applicativo, in relazione ad un contesto che può essere, per esempio il Thread corrente, oppure l’HttpContext della chiamata al web server, o qualunque altra cosa, configurabilmente. Vediamo i sorgenti che così è più chiaro:

 1: public class NHUow:IDisposable

 2: {

 3: private NHUow()

 4: {

 5: if (CurrentSessionContext.HasBind(sessionFactory))

 6: throw new InvalidOperationException("Nested
unit of work not allowed.");

 7: CurrentSessionContext.Bind(sessionFactory.OpenSession());

 8: }

9:

 10: static object lockObject
= new object();

 11: public static NHUow
Open()

 12: {

 13: lock (lockObject)

 14: {

 15: if (sessionFactory
== null)

 16: CreateSessionFactory();

 17: }

 18: return new NHUow();

 19: }

 20: public static ISession
CurrentSession

 21: {

 22: get
{ return sessionFactory.GetCurrentSession(); }

 23: }

24:

 25: private static ISessionFactory
sessionFactory;

 26: private static void CreateSessionFactory()

 27: {

 28: Configuration
cfg = CreateConfiguration();

 29: sessionFactory
= cfg.BuildSessionFactory();

 30: }

31:

 32: private static Configuration
CreateConfiguration()

 33: {

 34: Configuration
cfg = new Configuration();

 35: cfg.Configure();

 36: //
implicitamente carichiamo tutti i mapping che si trovano nell'assembly che

 37: //
contiene customer

 38: cfg.AddAssembly(typeof(Customer).Assembly);

 39: return cfg;

 40: }

41:

42:

 43: #region IDisposable
Members

44:

 45: public void Dispose()

 46: {

 47: if (!CurrentSessionContext.HasBind(sessionFactory)
)

 48: {

 49: throw new InvalidOperationException("Invalid
current session");

 50: }

 51: var
session = sessionFactory.GetCurrentSession();

 52: CurrentSessionContext.Unbind(sessionFactory);

 53: if (!session.IsOpen)

 54: {

 55: throw new InvalidOperationException("Session
closed before UOW end");

 56: }

57:

 58: if ( null !=
session.Transaction && session.Transaction.IsActive )

 59: {

 60: if (session.Transaction.WasCommitted
== false && session.Transaction.WasRolledBack
== false)

 61: session.Transaction.Rollback();

 62: }

 63: session.Close();

 64: }

65:

 66: #endregion

 67: }

L’oggetto implementa IDisposable, e ci permette di utilizzaro in questo modo:

 1: using (var
uow = NHUow.Open())

 2: {

 3: var
transaction = NHUow.CurrentSession.BeginTransaction();

 4: Customer
c = new Customer();

 5: c.Name
= "FELIX";

 6: c.AddressLine1
= c.AddressLine2 = "";

 7: c.City
= "XX";

 8: c.ZipCode
= "12060";

 9: NHUow.CurrentSession.Save(c);

 10: transaction.Commit();

 11: }

In pratica apro una unità di lavoro con using new… e, usciti dallo scope la uow si chiude. All’interno di questo scope, tutto il nostro codice potrà accedere alla session corrente usango la funzione statica NHUow.CurrentSession. I più attenti noteranno che la configurazione del session factory è fissa: questo è per semplificare la clase UOW, per renderla generale basta intervenire aggiungendo un SessionFactoryFactory, che UOW utilizzera per recuperare il session factory esterno.

Bene, se a questo punto lanciassimo lo unit test di prova, otterremmo la seguente eccezione:

No CurrentSessionContext configured (set the property current_session_context_class)!

Questo perchè il meccanismo di mantenimento delle sessioni di contesto di NH è configurabile, e noi non abbiamo specificato nulla. Come dice il messaggio di errore, bisogna aggiungere nel file di config la linea current_session_context_class ( linea 11 ):

 1: <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">

 2: <session-factory name="NHibernate.Test">

 3: <property name="connection.driver_class">NHibernate.Driver.SqlClientDriver</property>

 4: <property name="connection.connection_string">Server=.\SQLEXPRESS;initial
catalog=NHFROMSCRATCH;Integrated Security=SSPI</property>

 5: <property name="adonet.batch_size">10</property>

 6: <property name="show_sql">true</property>

 7: <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>

 8: <property name="use_outer_join">true</property>

 9: <property name="command_timeout">60</property>

 10: <property name="query.substitutions">true
1, false 0, yes 'Y', no 'N'</property>

 11: <property name="current_session_context_class">thread_static</property>

 12: <property name="proxyfactory.factory_class">NHibernate.ByteCode.LinFu.ProxyFactoryFactory,
NHibernate.ByteCode.LinFu</property>

 13: </session-factory>

 14: </hibernate-configuration>

Notate che non ho inserito un nome di classe, questo perchè ci sono degli shortcut per i context manager più usati. Tanto per elecare i vari possibili context manager:

NHibernate.Context.WebSessionContext – la sessione corrente è contenuta in HttpContext. L’alias è web.
NHibernate.Context.CallSessionContext - la sessione corrente è contenuta CallContext. L’alias è call.
NHibernate.Context.ThreadStaticSessionContext – la sessione corrente è nel context del thread. L’alias è thread_static.

Ovviamente, sempre nella filosofia della massima estendibilità, possiamo scrivere il nostro context manager.

Nei sorgenti di esempio, oltre alla classe Uow, c’è una classe di Unit Test NHFromScratch.Tests.Uow, che ne mostra l’utilizzo.

Felice Pollano Blog - hbm2net

Hbm2net & Db2hbm built on NH3

NHibernate de la ZERO Partea a 6-a: Utilizarea sesiunilor

Continuare la partea a 5-a

Mergi la partea 5

Descarca Sursa

NHibernate: Partire da ZERO Parte 6:Utilizzo delle sessioni

Continua da parte 5

Open Session: Pratiche da evitare

Torna alla parte 5

Download Sorgenti

Felice Pollano Blog - hbm2net

Hbm2net & Db2hbm built on NH3

NHibernate de la *ZERO* Partea a 6-a: Utilizarea sesiunilor

Continuare la partea a 5-a

Mergi la partea 5

Descarca Sursa

NHibernate: Partire da *ZERO* Parte 6:Utilizzo delle sessioni

Continua da parte 5

Open Session: Pratiche da evitare

Torna alla parte 5

Download Sorgenti

NHibernate de la ZERO Partea a 6-a: Utilizarea sesiunilor

NHibernate: Partire da ZERO Parte 6:Utilizzo delle sessioni