NHibernate Howto:五分钟内开始第一个NHibernate项目

这篇文章会提供一个简单的NHibernate的StarterKits.让读者能够在5分钟内运行出第一个NHibernate程序.但是,要令大家失望的是,即是我已经有一些NHibernate的经验了.也不能在5分钟内从无到有得构建出这个项目来.这个项目虽然很小但是已经基本上五脏俱全了,只不过有点发育不全而已.

首先介绍本项目的基本情况:这个项目将以一个在线购物的系统为例子.作为第一个NHibernate项目,这个解决方案包括两个项目:HowToNH和HowToNH.UnitTest.其中HowToNH是产品代码,HowToNH.UnitTest是测试代码.为了把精力集中在如何使用NHibernate上,我们将尽可能地使用单元测试的方式来验证代码,而不是写一个界面 然后人工看结果.

第一步:新建第一个项目HowToNH

第二步:引用NHibernate.dll,Iesi.Collections.dll,Castle.Core.dll,Castle.DynamicProxy2.dll和log4net.dll 为什么需要引用这么多dll.作为第一个项目 先不要管这么多了 都引用就OK了.NHibernate下载请到:http://www.hibernate.org

第三步:在HowToNH中新建文件夹POCO,POCO是Plain Old C# Object简称。是POJO的翻版.

第四步:在POCO中新建class Product 代码如下:

using System; namespace HowToNH.POCO { public class Product { public virtual long Id { get; set; } public virtual string Name { get; set; } public virtual double Price { get; set; } public virtual double Discount { get; set; } public virtual DateTime ProducedOn { get; set; } public virtual DateTime ExpiredOn { get; set; } } }

这个代码 除了每个property都标记为virtual有点怪异以外,就是一个很普通的class了.现在给他一个专有术语叫实体(Entity).(不是每一个被存储的对象都可以成为实体,所以要小心这个概念).

第五步:在POCO文件夹下给实体Product写映射文件:Product.hbm.xml 文件的内容如下:

<?xml version="1.0" encoding="utf-8" ?> <hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="HowToNH" namespace="HowToNH.POCO"> <class name="Product" table="HowToNH_PRODUCT"> <id name="Id" column ="Id" unsaved-value="0"> <generator class ="native"/> </id> <property name ="Name" column ="NAME" length="64" not-null="true"/> <property name="Price" column ="PRICE" not-null="true"/> <property name ="Discount" column ="DISCOUNT" not-null="true"/> <property name ="ProducedOn" column ="PRODUCEDON" not-null ="true"/> <property name ="ExpiredOn" column ="EXPIREDON" not-null ="true"/> </class> </hibernate-mapping>

注意事项:VS中选中这个文件,点属性 然后修改其属性.将Build Action修改为Embedded Resource. 这样这个文件就会被作为资源文件编译到程序集中. 抓图如下:

第六步:编写辅助代码用于启用NHibernate. 在HowToNH项目下新建class NHibernateHelper 代码如下:

using NHibernate; using NHibernate.Cfg ; namespace HowToNH { public class NHibernateHelper { private static ISessionFactory _factory; private static ISession _session; static NHibernateHelper() { _factory = new Configuration().Configure().BuildSessionFactory(); } public static ISession CurrentSession { get { if (null == _session || !_session.IsOpen) { _session = _factory.OpenSession(); } return _session; } } } }

第七步:编写配置文件让NHibernate连接到数据库. 在HowToNH下新建xml文件.命名为:hibernate.cfg.xml 文件内容如下:

<?xml version="1.0" encoding="utf-8" ?> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2"> <session-factory> <property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property> <property name="connection.provider">NHibernate.Connection.DriverConnectionProvider</property> <property name="connection.connection_string">Server=(local);initial catalog=OnlineMall;user=sa;password=P@ssw0rd</property> <property name="show_sql">true</property> <property name="hbm2ddl.auto">create</property> <mapping assembly="HowToNH" /> </session-factory> </hibernate-configuration>   

这个文件也需要修改属性,不过这次不是修改Build Action 而是Copy to Output Directory 修改为Copy Always.

第七步半:这是一个可选项,那就是用log4net输出日志. 推荐使用(本次我们不关注它).只需要新建一个log4net.xml文件就可以了 内容如下:

<?xml version="1.0" encoding="utf-8" ?> <log4net> <root> <!--如果只需要看看Sql设置INFO就够了，如果你要调试可以设置为DEBUG或ALL--> <priority value="ALL" /> <appender-ref ref="rollingFile" /> <appender-ref ref="ConsoleAppender"/> </root> <!--<logger name="ApplicationInfoLog"> <level value="INFO" /> <appender-ref ref="rollingFile1" /> </logger>--> <appender name="rollingFile" type="log4net.Appender.RollingFileAppender,log4net" > <param name="File" value="log.txt" /> <param name="AppendToFile" value="false" /> <param name="RollingStyle" value="Date" /> <param name="DatePattern" value="yyyy.MM.dd" /> <param name="StaticLogFileName" value="true" /> <layout type="log4net.Layout.PatternLayout,log4net"> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] <%X{auth}> - %m%n" /> </layout> </appender> <appender name="rollingFile1" type="log4net.Appender.RollingFileAppender,log4net" > <param name="File" value="log1.txt" /> <param name="AppendToFile" value="false" /> <param name="RollingStyle" value="Date" /> <param name="DatePattern" value="yyyy.MM.dd" /> <param name="StaticLogFileName" value="true" /> <layout type="log4net.Layout.PatternLayout,log4net"> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] <%X{auth}> - %m%n" /> </layout> </appender> <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender"> <target value="Console.Output" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender> </log4net>

这个文件也要修改Copy to Output Directory 为Copy Always.

---

第八步:新建一个项目HowToNH.UnitTest.添加对HowToNH已经NHibernate.dll NUnit的引用.

第九步:写测试代码.新建类ProductUT.代码内容如下:

using System; using NHibernate; using NUnit.Framework; using HowToNH.POCO; namespace HowToNH.UnitTest { [TestFixture] public class ProductUT { [Test] public void SaveProduct() { Product pd = new Product(); pd.Name = "Howto NHibernate"; pd.Price = 10; pd.Discount = 0.8; pd.ProducedOn = DateTime.Today.AddDays(-100); pd.ExpiredOn = DateTime.Today.AddDays(100); ISession s = NHibernateHelper.CurrentSession; s.BeginTransaction(); s.Save(pd); s.Transaction.Commit(); s.Close(); Assert.IsTrue(pd.Id > 0); } } }

第十步:新建数据库.启动SQL Server Management Studio或者其他的客户端工具. 新建一个数据库OnlineMall.

第十一步:运行ProductUT这个单元测试代码.如果看到绿色 你的第一个NHibernate就成功了!

 

说明:你很可能需要修改hibernate.cfg.xml才能运行本程序.在hibernate.cfg.xml中:<property name="connection.connection_string">Server=(local);initial catalog=OnlineMall;user=sa;password=P@ssw0rd</property>

这条配置很重要.它指定了数据库服务器,数据库名称,用户名和密码.如果你的配置和我的不一样,请首先修改然后再运行.

 

 

最后说明:所有的代码都可以通过svn到 svn://www.svnhost.cn/HowToNH获取