In questo Post / articolo, cercherò di mostrare passo per passo come creare una prima bozza di DataAccess utilizzando NHibernate con FluentNH per la configurazione e per elminare la produzione di quei “fastidiosi” file xml di configurazione dei mapping.
A seguire altri post sullo stesso argomento che mostreranno via via mapping più complessi.
Partiamo con la modellazione delle classi con cui vogliamo lavorare, partendo con un esempio semplicissimo con una sola tabella “USER”
Come prima cosa vediamo di seguire il pattern repository per l’accesso ai dati sfruttando i Generics, creiamo la nostra entità di dominio
1: public class User
2: {
3: public virtual int Id { get; set; }
4: public virtual string Name { get; set; }
5: public virtual string SurName { get; set; }
6: }
creiamo l’interfaccia generica IRepository<T, idT> nel progetto di DataAccess e l’interfaccia specifica IUserRepository e la classe concreta che andremo (in seguito) ad implementare per interrogare il Database all’interno del progetto contenente le entità.
1: namespace DataAccess
2: {
3: public interface IRepository<T, idT>
4: {
5: T GetById(idT id);
6: idT Add(T entity);
7: void Delete(T entity);
8: }
9: }
1: namespace Domain.Repositories
2: {
3: public interface IUserRepository : IRepository<User, int>
4: {
5: }
6:
7: public class UserRepository : IUserRepository
8: {
9: private ISession session;
10:
11: public UserRepository(ISession session)
12: {
13: this.session = session;
14: }
15:
16: public User GetById(int id)
17: {
18: throw new System.NotImplementedException();
19: }
20:
21: public int Add(User entity)
22: {
23: throw new System.NotImplementedException();
24: }
25:
26: public void Delete(User id)
27: {
28: throw new System.NotImplementedException();
29: }
30: }
31: }
Le ultime cose che mancano sono:
- Un file di configurazione per dire a NH che driver utilizzare per l’accesso ai dati e alcune informazioni di configurazione: Anche per questo tipo di configurazione ci affideremo a fluent.NHibernate che mette a disposizione una fluent per configurare NH senza troppe linee di codice
- Il mapping dell’entità creata con l’entità logica sul database.
Configurazione Database:
1: var cfg = new SQLiteConfiguration().InMemory().ShowSql();
2: PersistenceModel model = new PersistenceModel();
3: model.addMappingsFromAssembly(Assembly.GetAssembly(typeof(User)));
4: sessionSource = new SessionSource(cfg.ToProperties(), model);
E il mapping dichiarativo utilizzando flluent-Nhibernate:
1: public class UserMap : ClassMap<User>
2: {
3: public UserMap()
4: {
5: WithTable("Users");
6: Id(x => x.Id);
7: Map(x => x.Name);
8: Map(x => x.SurName);
9: }
10: }
La classe di mapping è abbastanza semplice, bisogna estendere la classe ClassMap<T> dove T è l’entità che stiamo mappando e nel costruttore, grazie all’uso di un bel po’ di Lambda e fluent interfaces, desciviamo il mapping, dicendogli che:
- La tabella su cui viene mappata l’entità è la tabella “users”
- La property Id della nostra entità rappresenta la chiave primaria della tabella (per convenzione, se non specifico nulla, il nome dell’entità e il nome della colonna sono gli stessi) salvata in una colonna “Id”.
- Le property Name e Surname sono mappate rispettivamente sulle colonne “Name” e “SurName” della tabella.
Faccio qui contento un mio amico / collega (roberto valenti) e procedo con scrivere un po’ di test per controllare che tutto sia predisposto correttamente.
Abbiamo quindi una prima configurazione del nostro layer di persistenza, sa dove dover andare a persistere i nostri dati grazie al file xml, sa che tipi di dati andrò a persistere (le nostre entità) e sa anche, tramite il nostro mapping, come persistere questi dati sul datasource. Vediamo di testare subito se tutto il lavoro di configurazione funziona. In fase di Setup del test, costruiamo un Configuration, che ci servirà per recuperare la ISession per interrogare i dati sulla sorgente dati. Verifichiamo che con la configurazione data, è possibile generare lo schema del database conoscendo i mapping, e se successivamente verifichiamo di essere in grado ad effettuare un inserimeno di uno User e successivamente recuperarlo sempre tramite la session.L’unico test che abbiamo implementato è quello di smoke, trovato girovagando per i blog mi sembrava un buon metodo per controllare che la configurazione sia andata senza nessun problema e lo schema sia stato generato correttamente.
1: [TestFixture]
2: public class MappingFixtures
3: {
4: private Configuration config;
5:
6: [SetUp]
7: public void Context()
8: {
9: var cfg = new SQLiteConfiguration()
10: .ShowSql()
11: .ConnectionString.Is( "Data Source=nhibernate.db;Version=3");
12: PersistenceModel model = new PersistenceModel();
13: model.addMappingsFromAssembly(Assembly.GetAssembly(typeof(User)));
14: config = cfg.ConfigureProperties(new Configuration());
15: model.Configure(config);
16: SchemaExport export = new SchemaExport(config);
17: export.Execute(false, true, false, false);
18: }
19:
20: [Test]
21: public void smoke()
22: {
23: // pass if config is OK and schema have been created
24: Assert.IsTrue(true);
25: }
26: }
Scriviamo ora i test per il salvataggio dell’entità.
1: [Test]
2: public void UserShouldBeAddedToDb()
3: {
4: User u = new User();
5: u.Name = "Gianluca";
6: u.SurName = "Gravina";
7: ISessionFactory factory = config.BuildSessionFactory();
8: ISession session = factory.OpenSession();
9: IUserRepository repo = new UserRepository(session);
10: int x = repo.Add(u);
11: Assert.IsTrue(x != 0);
12: }
Come da Red Green, il test non passerà, andiamo quindi a scrivere il metodo per fare passare il test.
1: public int Add(User entity)
2: {
3: return (int)session.Save(entity);
4: }
Facciamo la stessa cosa con la GetById e con la Delete, scriviamo i test, ma prima aggiungiamo una GetAll ai repository in modo da recuperare tutte le entità di un certo tipo:
1: public IList<User> GetAll()
2: {
3: return session.CreateCriteria(typeof (User)).List<User>();
4: }
ed ecco i test:
1: [Test]
2: public void CanRetrieveUsersFromDataBase()
3: {
4: ISession session = config.BuildSessionFactory().OpenSession();
5: UserRepository repo = new UserRepository(session);
6: User u = repo.GetById(1);
7: Assert.IsNotNull(u);
8: Debug.WriteLine(u.Name + " " + u.SurName);
9: }
10:
11: [Test]
12: public void CanDeleteUsersFromDataBase()
13: {
14: ISession session = config.BuildSessionFactory().OpenSession();
15: UserRepository repo = new UserRepository(session);
16: int x = repo.GetAll().Count;
17: User u = repo.GetById(1);
18: repo.Delete(u);
19: session.Flush();
20: int y = repo.GetAll().Count;
21: Assert.IsTrue(x-y==1);
22: }
e le relative implementazioni:
1: public User GetById(int id)
2: {
3: return session.Load<User>(id);
4: }
5:
6: public void Delete(User entity)
7: {
8: session.Delete(entity);
9: }
e con questo abbiamo (più o meno) finito.
Abbiamo configurato mapping e datasource con FluentInterface di Nhibernate, abbiamo creato le classi Repository per l’interrogazione del datasource e abbiamo testato che tutto funziona.
References: