使用 ORM 给系统的某些实体引入一个父类

需要在一个已经在运行中的系统中引入一个(新增的)父类的情况很常见。

假设在这个系统中我们原先就已经使用了 ORM 框架,而使用的 ORM 框架可能支持继承映射特性。继承映射大致有三种方式:

  • TPH:Table Per Hierarchy
  • TPT:Table Per Type
  • TPC:Table Per Concrete Type

如何在这几种方式中进行选择?对于一个已经在运行的系统来说,其中有一个重要因素需要考虑:怎么减少对数据库模型(Schema)的修改?

显然,使用 TPC 方式对数据库模型(Schema)的影响最小。

不要小看这一点。有人说,SQL 数据库之所以取得巨大的成功,是因为它提供了一个标准的集成机制。往往很多代码、系统都是和 SQL 数据库模型耦合在一起的,对数据库 Schema 的修改往往牵一发而动全身。对于已经在使用的系统,重构还是一小步一小步地来好一些。下面我们就先看看怎么用 TPC 的方式来搞吧。

我们假设现在系统中有两个类,一个是 Store(门店),一个是 Agency(代理)。

其中 Store 的代码如下:

using System;

namespace NHibernateTest.Domain.Model
{
    public class Store
    {
        public Store ()
        {
        }

        public virtual int StoreId { get; set; }
        public virtual string StoreName { get; set; }
        public virtual string Location { get; set; }
            
    }
}

另外一个类 Agency 的代码如下:

using System;

namespace NHibernateTest.Domain.Model
{
    public class Agency
    {
        public Agency ()
        {
        }

        public virtual int AgencyId { get; set; }
        public virtual string AgencyName { get; set; }
        public virtual string Location { get; set; }            
    }
}

假设我们的系统的使用了 NHiberante 作为 ORM 框架。Store 的 OR 映射文件:

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" 
                   assembly="NHibernateTest" 
                   namespace="NHibernateTest.Domain.Model">
  
  <class name="Store" table="Stores">
    <id name="StoreId" column="Id">
      <generator class="native" />
    </id>

    <property name="StoreName" />

    <property name="Location" />

  </class>
  
</hibernate-mapping>

Agency 的映射文件如下:

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" 
                   assembly="NHibernateTest" 
                   namespace="NHibernateTest.Domain.Model">
  
  <class name="Agency" table="Agencies">
    <id name="AgencyId" column="Id">
      <generator class="native" />
    </id>

    <property name="AgencyName" />

    <property name="Location" />

  </class>
  
</hibernate-mapping>

现在,我们发现需要引入一个父类 Organization(组织)。

至于为什么要引入?这里不多解释,请自行脑补吧。

如果使用 TPC 方式,对代码的修改非常简单。

Organization 的代码:

using System;

namespace NHibernateTest.Domain.Model
{
    public abstract class Organization
    {
        static Random rand = new Random ();

        public static int   NextOrganizationId ()
        {
            return rand.Next ();
        }

        public Organization ()
        {
        }

        public virtual int OrganizationId { get; set; }

        public virtual string Name { get; set; }

        public virtual string Location { get; set; }

    }
}

对 Store 的修改如下:

using System;

namespace NHibernateTest.Domain.Model
{
    public class Store : Organization
    {
        public Store ()
        {
        }

        //      public virtual int StoreId { get; set; }
        //
        //      public virtual string StoreName { get; set; }
        //
        //      public virtual string Location { get; set; }

        public virtual int StoreId { 
            get { return OrganizationId; }
            set { OrganizationId = value; }
        }

        public virtual string StoreName { 
            get { return Name; }
            set { Name = value; } 
        }
            
    }
}


对 Agency 的修改如下:

using System;

namespace NHibernateTest.Domain.Model
{
    public class Agency : Organization
    {
        public Agency ()
        {
        }

        //      public virtual int AgencyId { get; set; }
        //
        //      public virtual string AgencyName { get; set; }
        //
        //      public virtual string Location { get; set; }

        public virtual int AgencyId {
            get{ return OrganizationId; }
            set{ OrganizationId = value; }
        }

        public virtual string AgencyName {
            get { return Name; } 
            set { Name = value; } 
        }
            
    }
}


原来 Store 和 Agency 的映射文件可以干掉了。新的 Organization 的映射文件如下:

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" 
                   assembly="NHibernateTest" 
                   namespace="NHibernateTest.Domain.Model">
  
  <class name="Organization" abstract="true">
    <id name="OrganizationId" column="Id">
      <generator class="assigned" />
    </id>

    <union-subclass name="Agency"
        table="Agencies">

      <property name="Name" column="AgencyName"/>

      <property name="Location" />

    </union-subclass>

    <union-subclass name="Store"
        table="Stores">

      <property name="Name" column="StoreName"/>

      <property name="Location" />

    </union-subclass>


  </class>
  
</hibernate-mapping>

测试代码片段如下:

        public static void TestOrgs ()
        {

            using (ISession session = _sessionFactory.OpenSession ())
            using (ITransaction transaction = session.BeginTransaction ()) {

                Store s = new Store ();
                //***********
                s.OrganizationId = Organization.NextOrganizationId ();
                //
                s.StoreName = Guid.NewGuid ().ToString ();
                s.Location = Guid.NewGuid ().ToString ();
                session.Save (s);

                Agency a = new Agency ();
                //***********
                a.OrganizationId = Organization.NextOrganizationId ();
                //
                a.AgencyName = Guid.NewGuid ().ToString ();
                a.Location = Guid.NewGuid ().ToString ();
                session.Save (a);

                transaction.Commit ();
            }

        }

上面假设原来 Store 和 Agency 两个实体在数据库中的主键列名都是 Id,分别映射到代码中 StoreId 和 AgencyId。这种情况下,我们看看使用 TPC 方式为它们引入一个共同的父类,我们做了哪些修改:

  • 修改了 Id 的产生机制。

    这里出于演示的目的,将 Organization(Store 和 Agency)的 Id 改成了 assigned 方式,并在 Organization 的代码中写了一个演示性的 Id 生成方法 NextOrganizationId(随机产生一个整数作为 Id,不要用在正式的生产代码中)。其实还有其他的 Id 产生机制可以选的;

  • 新增了一个 Organization 抽象父类。将 Store 和 Agency 概念相同的属性提升到这个父类中;

  • 修改了 Store 和 Agency 的代码,让它们分别继承 Organization,并将它们原有的一些属性访问操作委托给父类实现。

除此之外,就没有别的了。特别需要注意的是:数据库 Schema 可能几乎没有做修改。这里说可能几乎,是因为:原来的 Id 产生器是 native 的,而对不同的底层数据库来着,native 的实现机制可能是不一样的。比如 MS SQL Server 和 MySQL 默认是使用了自增类型的字段。这时候就需要把 Id 字段的自增属性去掉。

当然,这里说的只是数据库的 Schema (几乎)不变,但是系统遗留的已有数据(Store 和 Agency)可能存在 Id 冲突,所以数据迁移还是要做的。

还有,如果原来的(Store 和 Agency 对应的)两个数据表中,Id 的字段名不是 Id,而是 StoreId 和 AgencyId,那 Schema 可能就需要改了。

以上是使用 NHiberante 举例,EF 应该也差不多。关于 EF 的继承映射支持,可以自行 Google。也可以看看这篇文章:
http://www.cnblogs.com/oppoic/p/ef_tph_tpt_tpc_inheritance.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容