Rafy 领域实体框架设计 - 重构 ORM 中的 Sql 生成

前言

---

Rafy 领域实体框架作为一个使用领域驱动设计作为指导思想的开发框架，必然要处理领域实体到数据库表之间的映射，即包含了 ORM 的功能。由于在 09 年最初设计时，ORM 部分的设计并不是最重要的部分，那里 Rafy 的核心是产品线工程、模型驱动开发、界面生成等。所以当时，我们简单地采用了一个开源的小型 ORM 框架：《Lite ORM Library》。这个 ORM 框架可以生成比较简单的 Sql 语句，以处理一般性的情况。

随着不断使用，我们也不断对 ORM 的源码做了不少改动，让它在支持简单语句生成的同时，也支持让开发人员直接使用手动编写的 Sql 语句来查询领域实体。但是过程中，一直没有修改最核心的 Sql 语句生成模块。随着应用的不断深入，遇到的场景越来越多，需要生成复杂 Sql 语句的场景也越来越多。而这些场景如果还让开发人员自己去编写复杂 Sql 语句，不但框架的易用性下降，而且由于写了过多的 Sql 语句，还会让开发人员面向领域实体来开发的思想减弱。

这两周，我们对 Sql 语句生成模块实施了重构。与其说是重构，不如说重写，因为 90% Lite ORM 的类库都已经不再使用。但是又不得不面对对历史代码中接口的兼容性问题。接下来，将说明本次重构中的关键技术点。

 

旧代码讲解

---

最初采用的 Lite ORM 是一个轻量级的 ORM 框架，采用在实体对象上标记特性（Attribute）来声明实体的元数据，并使用链式接口来作为查询接口以方便开发人员使用。这是一个简单、易移植的 ORM 框架，对初次使用、设计 ORM 的同学来说，可以起到一个很好的借鉴作用。相关的设计，可以参考 Lite ORM 的原文章：《Lite ORM Library V2 》。

由于这几年我们已经对该框架做了大量的修改，所以很多接口已经与原框架不一致了。IQuery 作为描述查询的核心类型，被重命名为 IPropertyQuery，所有方法的参数也都直接面向 Rafy 实体的《托管属性》。但是在整体结构上，还是与原框架保持一致。例如，它还只是一个一维的结构：

/// <summary>
/// 使用托管属性进行查询的条件封装。
/// </summary>
public interface IPropertyQuery : IDirectlyConstrain
{
    /// <summary>
    /// 是否还没有任何语句
    /// </summary>
    bool IsEmpty { get; }

    /// <summary>
    /// 当前的查询是一个分页查询，并使用这个对象来描述分页的信息。
    /// </summary>
    PagingInfo PagingInfo { get; }

    /// <summary>
    /// 用于查询的 Where 条件。
    /// </summary>
    IConstraintGroup Where { get; set; }

    /// <summary>
    /// 对引用属性指定的表使用关联查询
    ///
    /// 调用此语句会生成相应的 INNER JOIN 语句，并把所有关联的数据在 SELECT 中加上。
    ///
    /// 注意！！！
    /// 目前不支持同时 Join 两个不同的引用属性，它们都引用同一个实体/表。
    /// </summary>
    /// <param name="property"></param>
    /// <param name="type">是否同时查询出相关的实体数据。</param>
    /// <param name="propertyOwner">
    /// 显式指定该引用属性对应的拥有类型。
    /// 一般使用在以下情况中：当引用属性定义在基类中，而当前正在对子类进行查询时。
    /// </param>
    /// <returns></returns>
    IPropertyQuery JoinRef(IRefProperty property, JoinRefType type = JoinRefType.JoinOnly, Type propertyOwner = null);

    /// <summary>
    /// 按照某个属性排序。
    ///
    /// 可以调用此方法多次来指定排序的优先级。
    /// </summary>
    /// <param name="property">按照此属性排序</param>
    /// <param name="direction">排序方向。</param>
    /// <returns></returns>
    IPropertyQuery OrderBy(IManagedProperty property, OrderDirection direction);

    //其它部分省略...
}

可以看到，该类型以一维的形式来描述了一个 Sql 查询的相关元素：Join 数据源、Where 条件、OrderBy 规则、分页信息。

只有其中的 Where 条件被设计为树型结构来处理相对复杂的 And、Or 连接的条件。

可以看到，虽然有 SqlWhereConstraint 来添加任意的 Sql 语句作为 Where 约束条件，但是这样的结构还是比较简单，不足以描述所有的 Sql。

 

重构方案

---

我们的目标是实现复杂 Sql 的生成，理论上需要支持所有能想到的 Sql 语句的生成。

初期方案其实很简单，就是使用解释器模式与访问器模式配合来重构底层代码。根据 Sql 的语法规定，构造 Sql 语法树节点中的相关类型，这样就可以用一棵树来解释任意的 Sql 语句；同时使用访问器模式来遍历某个具体 Sql 语法树。过程中还需要特别注意，尽量不要构造不必要的树节点，以增加垃圾回收器的压力。

在此初步方案上，还需要考虑：分层架构、组件间依赖、以及旧代码的兼容性设计。

以下是整个方案的分层设计：

SqlTree：核心的、可重用的 Sql 语法树层。定义了通用的 Sql 语法结构，并解决从语法树到 Sql 语句的转换、生成，以及屏蔽不同数据库间不同子句的生成规则。

EntityQuery：把 SqlTree 作为类库引用，同时整合领域实体、实体属性的设计。

Query Interface：以 IQuery 接口的方式提供给应用层。

Linq Query：为了给开发人员提供更易用的接口，需要提供 Linq 语法的支持。本层用于解析 Linq 表达式树，并生成最终的实体查询的对象。

Property Query：为了兼容旧的接口，该部分在提供旧接口的前提下，换为使用新的 IQuery 来实现。

Application：开发人员的应用层代码。可以使用最易用的 Linq、旧的 PropertyQuery，同时也可以直接使用 IQuery 接口来完成复杂查询。

 

组件详细设计

---

Sql 语法树

 

使用解释器模式设计，用于描述 Sql 查询语句。

所有树节点都从 SqlNode 继承，并拥有自己的属性来描述不同的节点位置。例如 SqlSelect 类型，代码如下：

/// <summary>
/// 表示一个 Sql 查询语句。
/// </summary>
class SqlSelect : SqlNode
{
    private IList _orderBy;

    public override SqlNodeType NodeType
    {
        get { return SqlNodeType.SqlSelect; }
    }

    /// <summary>
    /// 是否只查询数据的条数。
    ///
    /// 如果这个属性为真，那么不再需要使用 Selection。
    /// </summary>
    public bool IsCounting { get; set; }

    /// <summary>
    /// 是否需要查询不同的结果。
    /// </summary>
    public bool IsDistinct { get; set; }

    /// <summary>
    /// 如果指定此属性，表示需要查询的条数。
    /// </summary>
    public int? Top { get; set; }

    /// <summary>
    /// 要查询的内容。
    /// 如果本属性为空，表示要查询所有列。
    /// </summary>
    public SqlNode Selection { get; set; }

    /// <summary>
    /// 要查询的数据源。
    /// </summary>
    public SqlSource From { get; set; }

    /// <summary>
    /// 查询的过滤条件。
    /// </summary>
    public SqlConstraint Where { get; set; }

    /// <summary>
    /// 查询的排序规则。
    /// 可以指定多个排序条件，其中每一项都必须是一个 SqlOrderBy 对象。
    /// </summary>
    public IList OrderBy
    {
        get
        {
            if (_orderBy == null)
            {
                _orderBy = new ArrayList();
            }
            return _orderBy;
        }
        internal set { _orderBy = value; }
    }

    //...
}

 

Sql 生成器

 

使用访问器模式设计，用于遍历整个 Sql 语法树。以下是 SqlNodeVisitor 的代码：

/// <summary>
/// SqlNode 语法树的访问器
/// </summary>
abstract class SqlNodeVisitor
{
    protected SqlNode Visit(SqlNode node)
    {
        switch (node.NodeType)
        {
            case SqlNodeType.SqlLiteral:
                return this.VisitSqlLiteral(node as SqlLiteral);
            case SqlNodeType.SqlSelect:
                return this.VisitSqlSelect(node as SqlSelect);
            case SqlNodeType.SqlColumn:
                return this.VisitSqlColumn(node as SqlColumn);
            case SqlNodeType.SqlTable:
                return this.VisitSqlTable(node as SqlTable);
            case SqlNodeType.SqlColumnConstraint:
                return this.VisitSqlColumnConstraint(node as SqlColumnConstraint);
            case SqlNodeType.SqlBinaryConstraint:
                return this.VisitSqlBinaryConstraint(node as SqlBinaryConstraint);
            case SqlNodeType.SqlJoin:
                return this.VisitSqlJoin(node as SqlJoin);
            case SqlNodeType.SqlArray:
                return this.VisitSqlArray(node as SqlArray);
            case SqlNodeType.SqlSelectAll:
                return this.VisitSqlSelectAll(node as SqlSelectAll);
            case SqlNodeType.SqlColumnsComparisonConstraint:
                return this.VisitSqlColumnsComparisonConstraint(node as SqlColumnsComparisonConstraint);
            case SqlNodeType.SqlExistsConstraint:
                return this.VisitSqlExistsConstraint(node as SqlExistsConstraint);
            case SqlNodeType.SqlNotConstraint:
                return this.VisitSqlNotConstraint(node as SqlNotConstraint);
            case SqlNodeType.SqlSubSelect:
                return this.VisitSqlSubSelect(node as SqlSubSelect);
            default:
                break;
        }
        throw new NotImplementedException();
    }

    protected virtual SqlJoin VisitSqlJoin(SqlJoin sqlJoin)
    {
        this.Visit(sqlJoin.Left);
        this.Visit(sqlJoin.Right);
        this.Visit(sqlJoin.Condition);
        return sqlJoin;
    }

    protected virtual SqlBinaryConstraint VisitSqlBinaryConstraint(SqlBinaryConstraint node)
    {
        this.Visit(node.Left);
        this.Visit(node.Right);
        return node;
    }

    //...
}

 

基于实体的查询

1. IQuery 相关接口用于描述整个基于实体的查询。

例如，IColumnNode 表示一个列节点，其实是由一个实体属性来指定的：

namespace Rafy.Domain.ORM.Query
{
    /// <summary>
    /// 一个列节点
    /// </summary>
    public interface IColumnNode : IQueryNode
    {
        /// <summary>
        /// 本列属于指定的数据源
        /// </summary>
        INamedSource Owner { get; set; }

        /// <summary>
        /// 本属性对应一个实体的托管属性
        /// </summary>
        IManagedProperty Property { get; set; }

        /// <summary>
        /// 本属性在查询结果中使用的别名。
        /// </summary>
        string Alias { get; set; }
    }
}

 

2. EntityQuery 层中的类型实现了 IQuery 中对应的接口，并使用领域实体的相关 API 来实现从实体到表、实体属性到列的转换。同时，为了减少对象的数量，这些类型与 Sql 语法树的关系都使用继承，而不是关联。也就是说，它们直接从 SqlTree 对应的类型上继承下来，这样，在构造 EntityQuery 的同时，也构造好了底层的 Sql 语法树。

3. QueryFactory 封装了大量易用的 API 来构造 IQuery 接口。

 

使用示例

---

下面，就以几个典型的单元测试的相关代码来说明新的查询框架的使用方法：

使用 Linq 的数据层查询

public int LinqCountByBookName(string name)
{
    return this.FetchCount(r => r.DA_LinqCountByBookName(name));
}
private EntityList DA_LinqCountByBookName(string name)
{
    var q = this.CreateLinqQuery();
    q = q.Where(c => c.Book.Name == name);
    return this.QueryList(q);
}

 

使用 IQuery 的数据层查询

public int CountByBookName2(string name)
{
    return this.FetchCount(r => r.DA_CountByBookName2(name));
}
private EntityList DA_CountByBookName2(string name)
{
    var source = f.Table(this);
    var bookSource = f.Table<BookRepository>();
    var q = f.Query(
        from: f.Join(source, bookSource)
    );
    q.AddConstraintIf(Book.NameProperty, PropertyOperator.Equal, name);
    return this.QueryList(q);
}

可以看到，使用 IQuery 接口来查询，虽然灵活性最大、性能更好，但是相对于 Linq 来说会更加复杂。

 

使用 IQuery 来生成 Sql

[TestMethod]
public void ORM_TableQuery_InSubSelect()
{
    var f = QueryFactory.Instance;
    var articleSource = f.Table(RF.Concrete<ArticleRepository>());
    var userSource = f.Table(RF.Concrete<BlogUserRepository>());
    var query = f.Query(
        from: userSource,
        where: f.Constraint(
            column: userSource.Column(BlogUser.IdProperty),
            op: PropertyOperator.In,
            value: f.Query(
                selection: articleSource.Column(Article.UserIdProperty),
                from: articleSource,
                where: f.Constraint(articleSource.Column(Article.CreateDateProperty), DateTime.Today)
            )
        )
    );

    var generator = new SqlServerSqlGenerator { AutoQuota = false };
    f.Generate(generator, query);
    var sql = generator.Sql;

    Assert.IsTrue(sql.ToString() ==
@"SELECT *
FROM BlogUser
WHERE BlogUser.Id IN (
SELECT Article.UserId
FROM Article
WHERE Article.CreateDate = {0}
)");
    Assert.IsTrue(sql.Parameters.Count == 1);
    Assert.IsTrue(sql.Parameters[0].Equals(DateTime.Today));
}

 

使用 SqlTree 来生成 Sql

[TestMethod]
public void ORM_SqlTree_Select_InSubSelect()
{
    var select = new SqlSelect();
    var articleTable = new SqlTable { TableName = "Article" };
    var subSelect = new SqlSelect
    {
        Selection = new SqlColumn { Table = articleTable, ColumnName = "UserId" },
        From = articleTable,
        Where = new SqlColumnConstraint
        {
            Column = new SqlColumn { Table = articleTable, ColumnName = "CreateDate" },
            Operator = SqlColumnConstraintOperator.Equal,
            Value = DateTime.Today
        }
    };

    var userTable = new SqlTable { TableName = "User" };
    select.Selection = new SqlSelectAll();
    select.From = userTable;
    select.Where = new SqlColumnConstraint
    {
        Column = new SqlColumn { Table = userTable, ColumnName = "Id" },
        Operator = SqlColumnConstraintOperator.In,
        Value = subSelect
    };

    var generator = new SqlServerSqlGenerator { AutoQuota = false };
    generator.Generate(select);
    var sql = generator.Sql;
    Assert.IsTrue(sql.ToString() == @"SELECT *
FROM User
WHERE User.Id IN (
SELECT Article.UserId
FROM Article
WHERE Article.CreateDate = {0}
)");
    Assert.IsTrue(sql.Parameters.Count == 1);
    Assert.IsTrue(sql.Parameters[0].Equals(DateTime.Today));
}

 

框架下载

---

框架使用测试驱动的方法开发，在开发时是先编写相关的测试用例，再实现内部代码。重构的同时，我们为能想到的场景都编写了测试用例：

 

目前，框架版本也升级到了 2.23.2155。

有兴趣的同学，了解、下载最新的框架，请参考：《Rafy 领域实体框架发布！》。（框架目前不开源，但可免费使用。）