查看 代码示例

Yao 可以读取数据模型定义，实现数据迁移、元数据原子操作、元数据输入校验和元数据管理后台。元数据原子操作方法被映射为处理器(process)，支持模型间数据关系映射，可在数据流（Flow）和接口(API)中访问查询。如采用golang语言开发业务插件(Plugin)，可以使用 Package Gou 访问模型的各个方法, 后续将提供 NodeJS 等语言 SDK。一个数据模型对应数据库中的一张数据表, 通过 JSON 文件描述数据表结构，放置在models 目录中。使用 yao migrate 命令创建/更新数据表结构设计。

数据模型描述文件是以 小写英文字母 命名的 JSON 文本文件 <name>.mod.yao

{
  "name": "用户",
  "table": {},
  "columns": [],
  "indexes": [],
  "relations": {},
  "values": [],
  "option": {}
}

数据表格包含 name、comment 等字段，定义模型存储在数据库中的数据表名称、注释等信息。支持 MySQL, PostgreSQL、SQLite等 Xun Database 或第三方提供驱动的数据库。

{
  "table": {
    "name": "user",
    "comment": "用户表",
    "engine": "InnoDB"
  }
}

一个模型可以包含多个字段定义，每个字段定义包含 label、name、type、 validations 等信息。

{
  "columns": [
    { "label": "ID", "name": "id", "type": "ID" },
    {
      "label": "厂商",
      "name": "manu_id",
      "type": "bigInteger",
      "length": 50,
      "comment": "所属厂商",
      "nullable": true,
      "index": true,
      "validations": [
        {
          "method": "typeof",
          "args": ["integer"],
          "message": "{{input}}类型错误, {{label}}应为数字"
        },
        {
          "method": "min",
          "args": [0],
          "message": "{{label}}应大于0"
        }
      ]
    },
    {
      "label": "手机号",
      "name": "mobile",
      "type": "string",
      "length": 50,
      "comment": "手机号",
      "index": true,
      "crypt": "AES",
      "validations": [
        {
          "method": "typeof",
          "args": ["string"],
          "message": "{{input}}类型错误, {{label}}应该为字符串"
        },
        {
          "method": "pattern",
          "args": ["^1[3-9]\\d{9}$"],
          "message": "{{input}}格式错误"
        }
      ]
    }
  ]
}

一个字段可以包含多条校验规则，每条校验规则可以选用 min,max, pattern, typeof 等校验方法。

{
  "columns": [
    {
      "label": "手机号",
      "name": "mobile",
      "type": "string",
      "length": 50,
      "comment": "手机号",
      "index": true,
      "crypt": "AES",
      "validations": [
        {
          "method": "typeof",
          "args": ["string"],
          "message": "{{input}}类型错误, {{label}}应该为字符串"
        },
        {
          "method": "pattern",
          "args": ["^1[3-9]\\d{9}$"],
          "message": "{{input}}格式错误"
        }
      ]
    }
  ]
}

校验规则定义

当前支持 AES 和 PASSWORD 两种字段数值加密存储算法，其中 AES 仅支持 MySQL 数据库。

以下名称不能用于字段名称。

一个数据模型，可以包含多个索引。对于单一索引，推荐在字段定义时，使用 index 、 unique 和 primary 修饰符定义，对于复合索引或全文检索索引，在 indexes 中定义。

{
  "indexes": [
    {
      "comment": "厂商用户",
      "name": "manu_id_mobile_unique",
      "columns": ["manu_id", "mobile"],
      "type": "unique"
    },
    {
      "comment": "简历全文检索",
      "name": "resume_fulltext",
      "columns": ["resume"],
      "type": "fulltext"
    }
  ]
}

数据模型支持一对一、一对多两种关系映射，可以通过定义映射关系将多个数据模型关联，查询时使用with参数即可同时返回关联模型数据。

关联关系使用 [key:String]:Object Relation 数据结构定义 ( {"关联名称1":{}, "关联名称2":{}}, 关联名称为 小写英文字母 )

在模型文件 user.yao 中定义

Object Relation

数据模型 user 数据表结构如下:

数据模型 manu 数据表结构如下:

在查询用户数据时，可以同时列出厂商信息或可以按关联厂商进行查询，则可以在定义 user 数据模型时，设定与 manu 数据模型关系.

在模型文件 user.yao 中定义

{
  "name": "用户",
  "relations": {
    "manu": {
      "type": "hasOne",
      "model": "manu",
      "key": "id",
      "foreign": "manu_id",
      "query": { "select": ["short", "company"] }
    }
  }
}

说明

1.将关系映射类型指定为 hasOne

2.将关联模型 model 设置为 manu

3.将关联模型 key 设置为 id, 即：manu.id 引擎处理时，自动关联 manu 表的 id 字段。

4.将 foreign 设置为 manu_id, 即: user.manu_id 引擎处理时，将 manu.id 和 user.manu_id 关联

5.可以在 query 字段中，设置默认的查询条件，如指定读取的字段等。

引擎解析后的 SQL 为:

SELECT `user`.*,
  `manu`.`short` AS `user_manu_short`,
  `manu`.`company` AS `user_manu_company`,
  FROM `user` AS `user`
  LEFT JOIN `manu` as `user_manu` ON `user_manu`.`id` = `user`.`manu_id`

访问

在调用 process 查询时，传入 with 参数，即可同时返回厂商信息

GET  /api/user/find/1?with=manu&manu.select=id,short

数据模型 user 数据表结构如下:

数据模型 address 数据表结构如下:

对于类似一个用户有多个通信地址的业务场景，可以通过建立一对多的映射关系来实现。

在模型文件 user.yao 中定义

{
  "name": "用户",
  "relations": {
    "addresses": {
      "type": "hasMany",
      "model": "address",
      "key": "user_id",
      "foreign": "id",
      "query": {
        "select": ["location"],
        "limit": 20
      }
    }
  }
}

说明

1.将关系映射类型指定为 hasMany

2.将关联模型 model 设置为 address

3.将关联模型 key 设置为 user_id, 即：address.user_id 引擎处理时，自动关联 address 表的 user_id 字段。

4.将 foreign 设置为 id, 即: user.id 引擎处理时，将 user.id 和 address.user_id 关联

5.可以在 query 字段中，设置默认的查询条件，如指定读取的字段等。对于 hasMany 建议设置默认 limit 约束返回数据条目

对于 hasMany 类型关系映射，引擎将分两次查询。首次查询出主模型以及关联的 ID 列表，第二次根据 ID 列表，查询关联数据信息。

第一次查询：

SELECT `user`.* FROM `user` AS `user`

引擎处理结果，并读取 user.id

第二次查询:

SELECT  `address`.`user_id`, `address`.`location` FROM `address` AS `address`
  WHERE `address`.`user_id` IN (<user.id...>)

引擎处理结果，关联用户地址信息

访问

在调用 process 查询时，传入 with 参数，即可同时取得 addresses 的关联信息

GET  /api/user/find/1?with=addresses

在 option 中设定模型配置参数

{
  "name": "地址",
  "option": {
    "timestamps": true,
    "soft_deletes": true
  }
}

在模型关联关系定义和调用处理器时，通过 Object QueryParam 描述查询条件。

{
  "select": ["id", "name", "mobile", "status"],
  "withs": {
    "manu": {
      "query": {
        "select": ["name", "short_name", "status"]
      }
    },
    "addresses": {}
  },
  "wheres": [
    { "column": "status", "value": "enabled" },
    { "rel": "manu", "column": "status", "value": "enabled" },
    {
      "wheres": [
        { "column": "name", "value": "%张三%", "op": "like" },
        {
          "method": "orwhere",
          "column": "name",
          "value": "%李四%",
          "op": "like"
        }
      ]
    }
  ],
  "orders": [
    { "column": "id", "option": "desc" },
    { "rel": "manu", "column": "name" }
  ],
  "limit": 2
}

应用引擎将以上查询条件解析为如下 SQL :

SELECT
  `user`.`id`,`user`.`name`,`user`.`mobile`,`user`.`status`,
  `user_manu`.`name` AS `user_manu_name`,
  `user_manu`.`short_name` AS `user_manu_short_name` ,
  `user_manu`.`status` AS `user_manu_status`
FROM `user` AS `user`
LEFT JOIN `manu` AS `user_manu` ON `user_manu`.`id` = `user`.`manu_id`
WHERE  `user`.`status` = 'enabled'
AND `user_manu`.`status` = 'enabled'
AND (
   `user`.`name` like '%张三%' OR `user`.`name` like '%李四%'
)
ORDER BY `user`.`id` desc, `user_manu`.`name` asc
LIMIT 2

QueryParam

Object Where

Object Order

Object With