[Nhibernate]SchemaExport工具的使用（一）——通过映射文件修改数据表

NHibernate的hbm2dll提供SchemaExport工具：给定一个连接字符串和映射文件，不需输入其他东西就可以按照持久化类和映射文件自动生成数据库架构，现在SchemaExport工具还不是很强大，但是一般应用足够了，它还是一个相当原始的API还在不断改进。

SchemaExport工具就是把DDL脚本输出到标准输出，同时/或者执行DDL语句。SchemaExport工具提供了三个方法，分别是Drop()、Create()、Execute()，前两个方法实质是调用Execute()方法。通常使用Execute()方法来生成数据库架构的。

SchemaUpdate工具

在NHibernate2.0中新添加SchemaUpdate工具，可以用来更新数据库架构。但是我觉得没有什么作用，因为它不能Drop现有的表或列，也不能更新现有的列，只能添加新的表和列。如果我需要删除表或者列或者修改其中列，SchemaUpdate工具就显得无能为力了。

一个例子

现在数据访问测试层新建一SchemaExportFixture.cs文件用于测试。

     /// <summary>

     /// 描述：SchemaExport生成数据库架构操作类

     /// 创建人：wolfy

     /// 创建时间：2014-11-16

     /// </summary>

     public class SchemaExportFixture

     {

         private Configuration _cfg;

         public SchemaExportFixture()

         {

             _cfg = new Configuration();

             _cfg.Configure();

         }

         public void DropTest()

         {

             var export = new SchemaExport(_cfg);

             export.Drop(true, true);

         }

         public void CreateTest()

         {

             var export = new SchemaExport(_cfg);

             export.Create(true, true);

         }

         public void ExecuteTest()

         {

             var export = new SchemaExport(_cfg);

             export.Execute(true, true, false);

         }

     }

需要引入命名空间

测试Drop方法

方法描述

Drop(script, export)方法根据持久类和映射文件执行删除数据库架构。有两个参数，第一个为True就是把DDL语句输出到控制台，第二个为True就是根据持久类和映射文件执行删除数据库架构操作，经过调试可以发现Drop(script, export)方法其实质是执行了Execute(script, export, true, true)方法。

         //

         // 摘要:

         //     Run the schema creation script

         //

         // 参数:

         //   exportOutput:

         //     if non-null, the ddl will be written to this TextWriter.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         // 备注:

         //     This is a convenience method that calls NHibernate.Tool.hbm2ddl.SchemaExport.Execute(System.Boolean,System.Boolean,System.Boolean)

         //     and sets the justDrop parameter to false.

         public void Create(TextWriter exportOutput, bool execute);

         //

         // 摘要:

         //     Run the drop schema script

         //

         // 参数:

         //   useStdOut:

         //     true if the ddl should be outputted in the Console.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         // 备注:

         //     This is a convenience method that calls NHibernate.Tool.hbm2ddl.SchemaExport.Execute(System.Boolean,System.Boolean,System.Boolean)

         //     and sets the justDrop parameter to true.

         public void Drop(bool useStdOut, bool execute);

         //

         // 摘要:

         //     Run the drop schema script

         //

         // 参数:

         //   exportOutput:

         //     if non-null, the ddl will be written to this TextWriter.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         // 备注:

         //     This is a convenience method that calls NHibernate.Tool.hbm2ddl.SchemaExport.Execute(System.Action<System.String>,System.Boolean,System.Boolean,System.IO.TextWriter)

         //     and sets the justDrop parameter to true.

         public void Drop(TextWriter exportOutput, bool execute);

Drop

         public void DropTest()

         {

             var export = new SchemaExport(_cfg);

             export.Drop(true, true);

         }

生成的sql语句

测试Create方法

方法描述

Create(script,export)方法根据持久类和映射文件先删除架构后创建删除数据库架构。有两个参数，第一个为True就是把DDL语句输出到控制台，第二个为True就是根据持久类和映射文件先执行删除再执行创建操作，经过调试可以发现这个方法其实质是执行Execute(script,export, false, true)方法。

         // 摘要:

         //     Run the schema creation script

         //

         // 参数:

         //   scriptAction:

         //     an action that will be called for each line of the generated ddl.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         // 备注:

         //     This is a convenience method that calls NHibernate.Tool.hbm2ddl.SchemaExport.Execute(System.Boolean,System.Boolean,System.Boolean)

         //     and sets the justDrop parameter to false.

         public void Create(Action<string> scriptAction, bool execute);

         //

         // 摘要:

         //     Run the schema creation script

         //

         // 参数:

         //   useStdOut:

         //     true if the ddl should be outputted in the Console.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         // 备注:

         //     This is a convenience method that calls NHibernate.Tool.hbm2ddl.SchemaExport.Execute(System.Boolean,System.Boolean,System.Boolean)

         //     and sets the justDrop parameter to false.

         public void Create(bool useStdOut, bool execute);

         //

         // 摘要:

         //     Run the schema creation script

         //

         // 参数:

         //   exportOutput:

         //     if non-null, the ddl will be written to this TextWriter.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         // 备注:

         //     This is a convenience method that calls NHibernate.Tool.hbm2ddl.SchemaExport.Execute(System.Boolean,System.Boolean,System.Boolean)

         //     and sets the justDrop parameter to false.

         public void Create(TextWriter exportOutput, bool execute);

Create

         public void CreateTest()

         {

             var export = new SchemaExport(_cfg);

             export.Create(true, true);

         }

生成的sql语句

通过最后一条你也会发现，连视图也生成了。

测试Execute方法

方法描述

Execute(script, export, justDrop)方法根据持久类和映射文件先删除架构后再创建删除数据库架构。（nhibernate4.0中已经将第四个参数format去掉了）

有三个参数，第一个为True就是把DDL语句输出到控制台；

第二个为True就是根据持久类和映射文件在数据库中先执行删除再执行创建操作；

第三个为false表示不是仅仅执行Drop语句还执行创建操作，这个参数的不同就扩展了上面两个方法；

    public void Execute(Action<string> scriptAction, bool execute, bool justDrop);

         //

         // 摘要:

         //     Executes the Export of the Schema.

         //

         // 参数:

         //   useStdOut:

         //     true if the ddl should be outputted in the Console.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         //   justDrop:

         //     true if only the ddl to drop the Database objects should be executed.

         //

         // 备注:

         //     This method allows for both the drop and create ddl script to be executed.

         public void Execute(bool useStdOut, bool execute, bool justDrop);

         public void Execute(Action<string> scriptAction, bool execute, bool justDrop, TextWriter exportOutput);

         public void Execute(Action<string> scriptAction, bool execute, bool justDrop, IDbConnection connection, TextWriter exportOutput);

         //

         // 摘要:

         //     Executes the Export of the Schema in the given connection

         //

         // 参数:

         //   useStdOut:

         //     true if the ddl should be outputted in the Console.

         //

         //   execute:

         //     true if the ddl should be executed against the Database.

         //

         //   justDrop:

         //     true if only the ddl to drop the Database objects should be executed.

         //

         //   connection:

         //     The connection to use when executing the commands when export is true.  Must

         //     be an opened connection. The method doesn't close the connection.

         //

         //   exportOutput:

         //     The writer used to output the generated schema

         //

         // 备注:

         //     This method allows for both the drop and create ddl script to be executed.

         //      This overload is provided mainly to enable use of in memory databases. It

         //     does NOT close the given connection!

         public void Execute(bool useStdOut, bool execute, bool justDrop, IDbConnection connection, TextWriter exportOutput);

Execute

        public void ExecuteTest()

         {

             var export = new SchemaExport(_cfg);

             export.Execute(true, true, false);

         }

生成的sql语句

通过比较你会发现Execute和Create生成的sql语句很相似

测试Execute(Action<string> scriptAction, bool execute, bool justDrop, TextWriter exportOutput)方法

方法描述

根据持久类和映射文件先删除架构后创建删除数据库架构。有四个参数。

第一个为一个带一个字符串类型输入参数的委托方法。

第二个为true表示对数据库执行DDL。

第三个为true表示如果只有DDL删除数据库对象应该被执行。

第四个为一个TextWriter输出到一个TextWriter中。

         public void ExecuteOutTest()

         {

             var export = new SchemaExport(_cfg);

             StringBuilder sb=new StringBuilder();

             TextWriter tw=new StringWriter(sb);

             export.Execute(new Action<string>((string x) => { Console.Write(x); }), true, true,tw);

         }

测试

SchemaUpadte使用

原来的映射文件Product.hbm.xml。

 <?xml version="1.0" encoding="utf-8" ?>

 <hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="Wolfy.Shop.Domain"  namespace="Wolfy.Shop.Domain.Entities">

   <class name="Wolfy.Shop.Domain.Entities.Product,Wolfy.Shop.Domain" table="TB_Product">

     <id name="ProductID" column="ProductID" type="Guid" unsaved-value="null">

       <generator class="assigned" />

     </id>

     <property name="Name" column="Name" type="String"

               not-null="true" />

     <property name="Price" column="Price" type="decimal"

               not-null="true" />

     <!--多对多关系：product属于多个orders-->

     <bag name="Orders" generic="true" table="TB_OrderProduct" >

       <key column="ProductID" foreign-key="FK_TB_OrderProduct_TB_Product"/>

       <many-to-many  column="OrderID"   class="Wolfy.Shop.Domain.Entities.Order,Wolfy.Shop.Domain"

      foreign-key="FK_TB_OrderProduct_TB_Order"/>

     </bag>

   </class>

 </hibernate-mapping>

修改映射文件，添加一个库存量的字段。

 <?xml version="1.0" encoding="utf-8" ?>

 <hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" assembly="Wolfy.Shop.Domain"  namespace="Wolfy.Shop.Domain.Entities">

   <class name="Wolfy.Shop.Domain.Entities.Product,Wolfy.Shop.Domain" table="TB_Product">

     <id name="ProductID" column="ProductID" type="Guid" unsaved-value="null">

       <generator class="assigned" />

     </id>

     <property name="Name" column="Name" type="String"

               not-null="true" />

     <property name="Price" column="Price" type="decimal"

               not-null="true" />

     <!--库存-->

     <property name="ProductCount" column="ProductCount" type="int"

              not-null="true" />

     <!--多对多关系：product属于多个orders-->

     <bag name="Orders" generic="true" table="TB_OrderProduct" >

       <key column="ProductID" foreign-key="FK_TB_OrderProduct_TB_Product"/>

       <many-to-many  column="OrderID"   class="Wolfy.Shop.Domain.Entities.Order,Wolfy.Shop.Domain"

      foreign-key="FK_TB_OrderProduct_TB_Order"/>

     </bag>

   </class>

 </hibernate-mapping>

测试，在数据层添加一个类SchemaUpdateFixture

     /// <summary>

     /// 描述：SchemaExport修改数据库架构操作类

     /// 创建人：wolfy

     /// 创建时间：2014-11-16

     /// </summary>

     public class SchemaUpdateFixture

     {

         private Configuration _cfg;

         public SchemaUpdateFixture()

         {

             _cfg = new Configuration();

             _cfg.Configure();

             var export = new SchemaExport(_cfg);

             export.Execute(true, true, false);

         }

         public void UpdateTest()

         {

             _cfg = new Configuration();

             _cfg.Configure();

             var export = new SchemaUpdate(_cfg);

             export.Execute(true, true);

         }

     }

查看生成的数据表TB_Product

细心的你可能会发现，我们在修改过映射文件后并没有修改对应的持久化类。通过SchemaUpdate(_cfg)你就会发现，初始化该工具的时候只是加载对应的配置文件，跟持久化类并没关系，不过为了对应关系，还是在修改过映射文件后，将添加的或者删除的字段，在持久化类中修改一下，以免忘记，造成打错。

总结

本篇文章通过实例介绍NHibernate中提供的两个实用工具SchemaExport如何利用持久化类和映射文件生成数据库架构。本篇文章就介绍到这里。

参考文章：http://www.cnblogs.com/lyj/archive/2008/11/11/1331509.html