查看 代码示例

数据流(Flow)用来编排数据查询逻辑，支持使用 JavaScript 脚本处理各查询节点结果，可以作为处理 (process) 来使用，引用方式为 flows.<数据流名称> 。

数据流描述文件是以 小写英文字母 + .flow.yao 扩展名命名的 JSON 文本文件, <name>.flow.yao; 结果处理脚本文件是以 数据流名称 + . + 脚本名称 + .js 扩展名，命名的 JavaScript 脚本文件 <name>.<script>.js 。

数据流编排文档，由基础信息、查询节点和输出结果构成。

{
  "label": "最新信息",
  "version": "1.0.0",
  "description": "最新信息",
  "nodes": [],
  "output": {}
}

{
  "nodes": [
    {
      "name": "manus",
      "process": "models.manu.get",
      "args": [
        {
          "select": ["id", "name", "short_name"],
          "limit": 20,
          "orders": [{ "column": "created_at", "option": "desc" }],
          "wheres": [
            { "column": "status", "value": "enabled" },
            { "column": "name", "value": "{{$in.0}}", "op": "like" }
          ]
        }
      ],
      "script": "rank",
      "outs": ["{{$out.manus}}", "{{$out.manu_ids}}"]
    }
  ]
}

一个数据流编排(Flow)可以有多个查询节点, 每个查询节点，可以调用一个处理器(process), 可以指定结果处理脚本和返回值，在查询节点用可以引用上下文信息。 Object Node 数据结构

{
  "output": {
    "foo": "{{$in}}",
    "bar": {
      "node1": "{{$res.node1.0}}",
      "node2": "{{$res.node2.0}}",
      "node3": "{{$res.node3}}"
    },
    "data": "{{$res}}",
    "ping": "pong"
  }
}

可以根据业务需要，自由定义数据流(Flow)的输出结果。 可以使用 {{$in}} 引用数据流(Flow)调用时传入的参数、使用 {{$res}} 引用各个查询节点返回值。

数据流(Flow)可以在全局引用传参({{$in}})和 各查询节点返回值 {{$res}}。查询节点内 outs 数组中，可以引用处理器 (process) 的返回值 {{out}}。

{
  "label": "最新信息",
  "version": "1.0.0",
  "description": "最新信息",
  "nodes": [
    {
      "name": "manus",
      "process": "models.manu.get",
      "args": [
        {
          "select": ["id", "name", "short_name"],
          "limit": 20,
          "orders": [{ "column": "created_at", "option": "desc" }],
          "wheres": [
            { "column": "status", "value": "enabled" },
            { "column": "name", "value": "{{$in.0}}", "op": "like" }
          ]
        }
      ],
      "script": "rank",
      "outs": ["{{$out.manus}}", "{{$out.manu_ids}}"]
    },
    {
      "name": "github",
      "process": "plugins.user.github",
      "args": [
        "{{$res.users.0}}",
        "{{$res.manus}}",
        "{{$in.0}}",
        "{{$in.1}}",
        "{{$in.2}}",
        "{{hello(:$res.users, 'id', 0.618, 10)}}",
        "foo",
        1
      ]
    }
  ],
  "output": {
    "params": "{{$in}}",
    "data": {
      "manus": "{{$res.manus.0}}",
      "github": "{{$res.github}}"
    }
  }
}

可以在 nodes[n].args, nodes[n].outs, output 中使用 Helper 函数。调用方法为 {{method(args...)}} 参数表支持使用变量 写法为 :$res.node1, 字符串使用单引号 '，例如: {{hello(:$res.users, 'id', 0.618, 10)}}

Helper 函数表

查询节点支持使用 JavaScript 脚本对处理器(process)返回值处理，main() 函数传入数据流(Flow)参数表、当前查询节点 process 返回值和查询节点返回值映射表。返回值可以使用 $out 变量引用。

处理脚本成功运行，{{$out}} 变量将更新为脚本返回值数值。

数据流(Flow) 可以作为处理，在其他数据流(Flow)或服务接口(API)中调用。处理器引用方式为 flows.数据流名称

{
  "nodes": [
    {
      "name": "github",
      "process": "flows.github",
      "args": ["{{$in.1}}", "{{$in.2}}", "foo", 1],
      "script": "count",
      "outs": ["$out.args", "$out.plugin"]
    }
  ]
}

{
  "path": "/latest/:day",
  "method": "GET",
  "process": "flows.latest",
  "in": ["$param.day"],
  "out": {
    "status": 200,
    "type": "application/json"
  }
}

新建models/category.mod.yao写入以下代码:

执行命令 yao migrate -n category在数据库中可以看到生成了对应的数据表和数据

编写flows/category.flow.yao写入以下代码:

执行yao run flows.category可以看到控制台有以下输出:

[
  {
    "children": [
      {
        "children": [],
        "id": 2,
        "label": "二级分类",
        "name": "二级分类",
        "parent_id": 1,
        "value": 2
      }
    ],
    "id": 1,
    "label": "一级分类",
    "name": "一级分类",
    "parent_id": null,
    "value": 1
  }
]