给自己挖坑——DateWay

参考文章

官方手册

官方博客

填坑

---

目录

• 简介
• 使用
  • 1. 引入相关依赖
  • 2. 配置 Dataway，并初始化数据表
  • 3. 配置数据源
  • 4. 把数据源设置到 Hasor 容器中
  • 5. 在SprintBoot 中启用 Hasor
  • 6. 启动应用
  • 7. 访问接口管理页
  • 8. 新建一个接口
  • 9. 测试接口
  • 10. 创建一个测试接口
• 3. 拓展
  • 1. DateQL引擎

简介

---

依托 DataQL 服务聚合能力，为应用提供一个 UI 界面。并以 jar 包的方式集成到应用中。 通过 Dataway 可以直接在界面上配置和发布接口。而不需要写代码。

使用

---

1. 引入相关依赖

---

<dependency>
    <groupId>net.hasor</groupId>
    <artifactId>hasor-spring</artifactId>
    <version>4.1.4</version>
</dependency>
<dependency>
    <groupId>net.hasor</groupId>
    <artifactId>hasor-dataway</artifactId>
    <version>4.1.4</version><!-- 4.1.4 包存在UI资源缺失问题 -->
</dependency>

hasor-spring 负责 Spring 和 Hasor 框架之间的整合。hasor-dataway 是工作在 Hasor 之上，利用 hasor-spring 我们就可以使用 dataway了。

2. 配置 Dataway，并初始化数据表

---

1. Spring配置文件
   
   dataway 会提供一个界面让我们配置接口，这一点类似 Swagger 只要jar包集成就可以实现接口配置。找到我们 springboot 项目的配置文件 application.properties

# 是否启用 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

1. 在数据库创建数据表

Dataway 需要两个数据表才能工作，下面是这两个数据表的简表语句。下面这个 SQL 可以在 dataway的依赖 jar 包中 “META-INF/hasor-framework/mysql” 目录下面找到，建表语句是用 mysql 语法写的。

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);

3. 配置数据源

---

作为 Spring Boot 项目有着自己完善的数据库方面工具支持。我们这次采用 druid + mysql + spring-boot-starter-jdbc 的方式

首先引入依赖

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.30</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.21</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.10</version>
</dependency>

然后增加数据源的配置

# db
spring.datasource.url=jdbc:mysql://xxxxxxx:3306/example
spring.datasource.username=xxxxx
spring.datasource.password=xxxxx
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.type:com.alibaba.druid.pool.DruidDataSource
# druid
spring.datasource.druid.initial-size=3
spring.datasource.druid.min-idle=3
spring.datasource.druid.max-active=10
spring.datasource.druid.max-wait=60000
spring.datasource.druid.stat-view-servlet.login-username=admin
spring.datasource.druid.stat-view-servlet.login-password=admin
spring.datasource.druid.filter.stat.log-slow-sql=true
spring.datasource.druid.filter.stat.slow-sql-millis=1

如果项目已经集成了自己的数据源，那么可以忽略第三步。

4. 把数据源设置到 Hasor 容器中

Spring Boot 和 Hasor 本是两个独立的容器框架，我们做整合之后为了使用 Dataway 的能力需要把 Spring 中的数据源设置到 Hasor 中。

首先新建一个 Hasor 的 模块，并且将其交给 Spring 管理。然后把数据源通过 Spring 注入进来。

@DimModule
@Component
public class ExampleModule implements SpringModule {
    @Autowired
    private DataSource dataSource = null;

    @Override
    public void loadModule(ApiBinder apiBinder) throws Throwable {
        // .DataSource form Spring boot into Hasor
        apiBinder.installModule(new JdbcModule(Level.Full, this.dataSource));
    }
}

5. 在SprintBoot 中启用 Hasor

@EnableHasor()
@EnableHasorWeb()
@SpringBootApplication()
public class ExampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }
}

这一步非常简单，只需要在 Spring 启动类上增加两个注解即可。

6. 启动应用

---

1. 在启动的时候会看到两个图标

当看到2020-06-10 08:46:05.374 INFO 14480 --- [main] net.hasor.dataway.config.DatawayModule:dataway api workAt /api/时，可以认为启动成功。

7. 访问接口管理页

---

浏览器输入http://127.0.0.1:8080/interface-ui/#/进入界面。

8. 新建一个接口

1. 点击New
   
   

2. 在下方窗口中输入sql语句

3. 后续操作

右边的四个按钮分别是保存，运行，冒烟测试，发布。

首先点击运行，然后下方会有返回的数据：

修改发布的url地址

如果测试无误，可以点击保存，然后进行冒烟测试，测试成功则可以点击发布，将接口发布出去。

9. 测试接口

在浏览器地址栏输入上一步设置的路径

会出现返回结果。

10. 创建一个测试接口

1. 点击New

1. 修改url地址，并将请求类型设置为get

1. 编辑mysql语句

在sql语句中使用url中的参数需要改成#{参数名称}。

1. 添加测试参数

在Parameters中添加的测试数据就是访问url时，后面添加的参数，可以在3中直接使用。

1. 点击运行

1. 保存，冒烟测试，发布

此时状态已经更新

1. 浏览器访问

数据返回正常。

---

POST类型没有测试

3. 拓展

1. DateQL引擎

1. 语法
   1. 注释：单行注释为//``,多行注释为/* ... */`
      
      和java一样的。
   2. DataQL 会把这些字符识别为空白字符：(空格)、\t、\n、\r、\f
   3. 关键字

关键字	含义
if	条件语句
else	用在条件语句之后
return	三大退出指令之一，终止当前过程的执行并正常退出到上一个执行过程中
exit	三大退出指令之一，终止所有后续指令的执行并正常退出
throw	三大退出指令之一，终止所有后续指令的执行并抛出异常
var	执行一个查询动作，并把查询结果保存到临时变量中
run	仅仅执行查询动作，不保留查询的结果
hint	写在 DataQL 查询语句的最前面，用于设置一些执行选项参数
import	将另外一个 DataQL 查询导入并作为一个 Udf 形式存在、或直接导入一个 Udf 到当前查询中
as	与 import 关键字配合使用，用作将导入的 Udf 命名为一个本地变量名
true	真
false	假
null	空值

  4. 分隔符

分隔符	含义
（）	函数入参的圈定，表达式中的计算项提取权
{}	用来定义复合语句
[]	对数据通过下标方式取值
，	不同参数的分割
：	对象键值对
；	语句的结束，DataQL 会自动推断语句结束，因此语句结束分割符并不是必须的

  5. 运算符

1. 类型系统

DataQL 是弱类型定义的查询语言，在DataQL 中所有数据都会被归结到有限的几种类型上。无需定义数据类型结构，在弱类型系统中编写查询会非常方便，它去掉了繁杂的类型定义。

  1. 布尔类型

var bool = true;

  2. 集合

格式：[…]

空集合：[]

多维集合：[[…],[…]]

  3. 对象

格式：{“k1”: … ,”k2”: …}

空对象：{}

多层结构：{“k1”: { … }, “k2”: { … } }

  4. UDF

外部Udf：外部的 Udf 被引入之后，通常以标识符形式表示它。

DataQL 中书写的 lambda 表达方式为：var foo = () -> { /* 代码块 / }

外部代码片段：var a = @@xxx() <% / 外部代码块 */ %>

  5. JSON

DataQL 可以直接表达 Json 数据（Json 的 Key 必须通过双引号或单引号形式包裹起来）

1. 取值和赋值

官方文档什么的没提过返回一个网页的操作，所以应该只能作为后台使用。填坑成功。