Dataway-0代码基于数据表生成API_v0.0.4

文件名称	版本号	作者	qq	版本
Dataway-0代码基于数据表生成API	v0.0.4	学生宫布	8416837	SpringBoot 2.2.2 Hasor 4.1.4

介绍

本技术基于Dataway

Dataway简介：Dataway 基于DataQL

Dataway基于DataQL的服务聚合能力，为应用提供接口配置，使得开发者0代码配置一个满足需求的接口。 整个接口配置、测试、冒烟、发布，都通过 Dataway 提供的 UI 界面完成。UI 会以 Jar 包方式提供并集成到应用中并和应用共享同一个 http 端口，应用无需单独为 Dataway 开辟新的管理端口。

内嵌集成模式使得大部分老项目可以在无侵入的情况下直接应用 Dataway，进而改进老项目的迭代效率，大大降低企业项目研发成本。

惊喜：BO、VO、DO、Mapper|DAO、Service、Controller 统统不需要。

优势

• 集成简单，引入项目，10分钟内即可使用；
• 与springBoot完美合体；
• 与其它spring项目也能很好集合，但是我暂时还没实践过；
• 数据聚合：‘和 GraphQL 相同，这是设计 DataQL 的初衷。将数据库和服务等多个结果进行汇聚然后返回给前端，这是 DataQL 的使命。 Dataway 使这一过程变得更加简单高效’。—— DataQL

待研究：支持多数据源方面、API-条件过滤、传递参数方面、服务聚合、自动生成API文档

架构图

准备

代码

• 首先准备一个springBoot项目
• 它的启动类增加新的注解：

@EnableHasor
@EnableHasorWeb

嵌入工作

• 依赖
  引入hasor依赖

<!-- https://mvnrepository.com/artifact/net.hasor/hasor-dataway -->
        <dependency>
            <groupId>net.hasor</groupId>
            <artifactId>hasor-dataway</artifactId>
            <version>4.1.4</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/net.hasor/hasor-dataway -->
        <dependency>
            <groupId>net.hasor</groupId>
            <artifactId>hasor-spring</artifactId>
            <version>4.1.4</version>
        </dependency>

若需要hasor全部技术栈，请引入：

		<dependency>
            <groupId>net.hasor</groupId>
            <artifactId>hasor-all</artifactId>
            <version>RELEASE</version>
        </dependency>

• 配置文件

# 是否启用 Dataway 功能（必选：默认false）
HASOR_DATAQL_DATAWAY: true

# 是否开启 Dataway 后台管理界面（必选：默认false）
HASOR_DATAQL_DATAWAY_ADMIN: true

# dataway  API工作路径（可选，默认：/api/）
HASOR_DATAQL_DATAWAY_API_URL: /api/

# dataway-ui 的工作路径（可选，默认：/interface-ui/）
HASOR_DATAQL_DATAWAY_UI_URL: /interface-ui/

# SQL执行器方言设置（可选，建议设置）
HASOR_DATAQL_FX_PAGE_DIALECT: mysql

• 配置 - 让hasor管理数据源

package test.config;

import net.hasor.core.ApiBinder;
import net.hasor.core.DimModule;
import net.hasor.db.JdbcModule;
import net.hasor.db.Level;
import net.hasor.spring.SpringModule;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.sql.DataSource;

/**
 * 功能：
 *
 * @author: cc
 * @qq: 8416837
 * @date: 2020/5/4 14:17
 */
@DimModule
@Component
public class ExampleModule implements SpringModule {
	@Autowired
	private DataSource dataSource = null;

	@Override
	public void loadModule(ApiBinder apiBinder) throws Throwable {
//		将spring的dataSource交给hasor
		apiBinder.installModule(new JdbcModule(Level.Full, this.dataSource));
	}
}

建基础表

见下文

启动

启动成功，访问地址：http://127.0.0.1:8106/interface-ui/

访问成功，但是报了个错：

Caused by: java.sql.SQLSyntaxErrorException: Table 'blade.interface_info' doesn't exist

看来，Dataway 需要基础数据表才能工作，建表sql如下：

CREATE TABLE `interface_info` (
    `api_id`          int(11)      NOT NULL AUTO_INCREMENT   COMMENT 'ID',
    `api_method`      varchar(12)  NOT NULL                  COMMENT 'HttpMethod：GET、PUT、POST',
    `api_path`        varchar(512) NOT NULL                  COMMENT '拦截路径',
    `api_status`      int(2)       NOT NULL                  COMMENT '状态：0草稿，1发布，2有变更，3禁用',
    `api_comment`     varchar(255)     NULL                  COMMENT '注释',
    `api_type`        varchar(24)  NOT NULL                  COMMENT '脚本类型：SQL、DataQL',
    `api_script`      mediumtext   NOT NULL                  COMMENT '查询脚本：xxxxxxx',
    `api_schema`      mediumtext       NULL                  COMMENT '接口的请求/响应数据结构',
    `api_sample`      mediumtext       NULL                  COMMENT '请求/响应/请求头样本数据',
    `api_create_time` datetime     DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
    `api_gmt_time`    datetime     DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
    PRIMARY KEY (`api_id`)
) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4 COMMENT='Dataway 中的API';
 
CREATE TABLE `interface_release` (
    `pub_id`          int(11)      NOT NULL AUTO_INCREMENT   COMMENT 'Publish ID',
    `pub_api_id`      int(11)      NOT NULL                  COMMENT '所属API ID',
    `pub_method`      varchar(12)  NOT NULL                  COMMENT 'HttpMethod：GET、PUT、POST',
    `pub_path`        varchar(512) NOT NULL                  COMMENT '拦截路径',
    `pub_status`      int(2)       NOT NULL                  COMMENT '状态：0有效，1无效（可能被下线）',
    `pub_type`        varchar(24)  NOT NULL                  COMMENT '脚本类型：SQL、DataQL',
    `pub_script`      mediumtext   NOT NULL                  COMMENT '查询脚本：xxxxxxx',
    `pub_script_ori`  mediumtext   NOT NULL                  COMMENT '原始查询脚本，仅当类型为SQL时不同',
    `pub_schema`      mediumtext       NULL                  COMMENT '接口的请求/响应数据结构',
    `pub_sample`      mediumtext       NULL                  COMMENT '请求/响应/请求头样本数据',
    `pub_release_time`datetime     DEFAULT CURRENT_TIMESTAMP COMMENT '发布时间（下线不更新）',
    PRIMARY KEY (`pub_id`)
) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4 COMMENT='Dataway API 发布历史。';
 
create index idx_interface_release on interface_release (pub_api_id);

如果mysql版本低于5.5，则将CURRENT_TIMESTAMP 改为NULL
建表、索引后，重启。

创建API

有两种方式写sql：普通sql、DataQL

普通sql式

普通sql在底层也是转换成DataQL

• 按步骤配置，然后保存
  

选择接口列表：

发布接口：

get接口比较方便，curl http://127.0.0.1:8106/api/user执行调用：
调用成功：

• 再增加一个联表查询接口：
  

调用成功：

DataQL式

• 简单配置，调试：
  DataQL：

var query = @@sql()<%
    SELECT ROLE.ROLE_NAME AS name,GROUP_CONCAT(MENU.NAME) AS menuName FROM BLADE_ROLE ROLE LEFT JOIN BLADE_ROLE_MENU ROLE_MENU ON ROLE.ID = ROLE_MENU.ROLE_ID
LEFT JOIN BLADE_MENU MENU ON MENU.ID = ROLE_MENU.MENU_ID 
GROUP BY ROLE.ROLE_NAME
%>
return query()

该请求是POST请求，使用http客户端工具调用成功：

• 传递参数
  DataQL:

return ${name} + '-' + ${age};

参数：

{
  "name": "Shanks",
  "age": 13
}

执行结果：

{
  "success": true,
  "message": "OK",
  "code": 0,
  "lifeCycleTime": 1,
  "executionTime": 0,
  // value: 返回的数据
  "value": "Shanks-13"
}

0代码API的使用

在项目嵌入权限插件，就可以使用了。
提供给移动端、PC端以及开放API等消费端使用；