TangYuan之Node设计

TangYuan之Node设计

---

1. 什么是Node

说起Node，也就是节点，大家可能首先想到的是XML的中的节点，那本文就从XML中的节点说起。我们先来看一张图：

图片示例1：

上图中是一段简单的XML代码，其中标记了3个颜色不同的方框，其中，红色的代表是一个元素节点，蓝色的代表是一个属性节点，紫色的代表是一个文本节点。在xml中几乎所有的内容，都可以用节点(Node)来描述。我们可以参考org.w3c.dom.Node。而TangYuan中的Node(节点)又是什么呢？和XML中的节点有什么关系呢？下面我们来看两个示例：

图片示例2：

在示例2中，红色的代表是一个<selectOne>节点，蓝色的代表是一个<SqlTextNode>节点，我们再来看一个示例：

图片示例3：

在示例3中，红色的代表是一个<selectSet>节点，紫色的代表是一个<if>节点，蓝色的代表是一个<SqlTextNode>节点。

通过上面两个示例，大家可能有一些概念了，其实TangYuan中的节点是以XML节点为基础，抽象出来的一种具有特定功能的逻辑节点。比如<selectSet>就代表一个基本SelectSet服务，<if>节点就代表为将执行一个条件判断等等。那么在TangYuan中定义了多少逻辑节点呢？我们来看下面这张图：

图4:

在上述图中，我们看到所有的节点都直接或间接的实现了TangYuanNode这个接口。而这么多的TangYuan节点，究竟是都是做什么用的呢？

节点名称	用途及说明
SelectSetNode	代表一个基本SelectSet服务
SelectOneNode	代表一个基本SelectOne服务
SelectVarNode	代表一个基本SelectVar服务
UpdateNode	代表一个基本Update服务
InsertNode	代表一个基本Insert服务
DeleteNode	代表一个基本Delete服务
ServiceNode	代表一个SQL组合服务
InternalSelectSetNode	代表一个内部SelectSet服务
InternalSelectOneNode	代表一个内部SelectOne服务
InternalSelectVarNode	代表一个内部SelectVar服务
InternalUpdateNode	代表一个内部Update服务
InternalInsertNode	代表一个内部Insert服务
InternalDeleteNode	代表一个内部Delete服务
IfNode	代表一个逻辑判断操作
ForEachNode	代表一个循环迭代操作
LogNode	代表日志输出操作
ReturnNode	代表结果返回
ExceptionNode	代表异常判断
CallNode	代表服务调用
SqlTextNode	代表sql文本节点
MixedNode	代表混合节点

2. node的关系

了解了节点的定义和用途，我们再来研究一下节点之间的关系。比如之前的图片示例3，其涉及的节点是如何组织和关联的，下面让我们参照之前的类关系图，再结合源码来分析一下：

AbstractSqlNode

public abstract class AbstractSqlNode implements TangYuanNode {

    protected TangYuanNode          sqlNode;

    ...
}

SelectSetNode

public class SelectSetNode extends AbstractSqlNode {
    ....
}

IfNode

public class IfNode implements TangYuanNode {

    private TangYuanNode    sqlNode;

    private List<IfNode>    elseIfList;

    ....
}

MixedNode

public class MixedNode implements TangYuanNode {

    private List<TangYuanNode> contents;

    public MixedNode(List<TangYuanNode> contents) {
        this.contents = contents;
    }

    ....
}

SqlTextNode

public class SqlTextNode implements TangYuanNode {

    protected String            originalText    = null;

    public SqlTextNode(String text) {
        this.originalText = text;
        ...
    }
}

那么对于图片示例3内存中节点间的关系可用如下伪代码表示:

new SelectOneNode(){
    sqlNode = new MixedNode(){
        contents = [
            new SqlTextNode(){originalText = 'SELECT * FROM user WHERE 1=1';}, 
            new IfNode(){
                test = "user_id != null",
                sqlNode = new SqlTextNode(){originalText = 'AND user_id = #{user_id}';}
            }
        ];
    }
}

3. node的执行

接下来我们来看一下节点是如何执行的。 在TangYuan中调用一个服务，其重要的一步就是执行其所对应的节点。对于图片示例3中的<SelectSetNode>，其执行流程如何呢？之前我们介绍过所有的节点都实现了TangYuanNode这个接口：

public interface TangYuanNode {
    boolean execute(ServiceContext context, Object arg) throws Throwable;
}

此接口只有一个方法，就是execute方法，也就是说所有调用操作都将从此方法开始。

时序图：

上图中详细的给我们展现出节点的具体执行流程，从最外层的<SelectSetNode>节点开始，逐层调用其内部节点的execute方法,从而完成节点的执行。

4. node的解析

前面我们说到了Node的定义，相互之间的关系，以及执行的流程，最后我们反过来看一下TangYuan是如何解析Node的.

图5：

#

到此，本文的内容就结束了，感兴趣的朋友可以关注TangYuan项目。

• QQ群：518522232 *请备注关注的项目
• 邮箱：xson_org@126.com
• 项目地址: https://github.com/xsonorg/tangyuan