# Dataway介紹

Dataway 是基于 DataQL 服務(wù)聚合能力，為應(yīng)用提供的一個(gè)接口配置工具。使得使用者無需開發(fā)任何代碼就配置一個(gè)滿足需求的接口。整個(gè)接口配置、測(cè)試、冒煙、發(fā)布。一站式都通過 Dataway 提供的 UI 界面完成。UI 會(huì)以 Jar 包方式提供并集成到應(yīng)用中并和應(yīng)用共享同一個(gè) http 端口，應(yīng)用無需單獨(dú)為 Dataway 開辟新的管理端口。

這種內(nèi)嵌集成方式模式的優(yōu)點(diǎn)是，可以使得大部分老項(xiàng)目都可以在無侵入的情況下直接應(yīng)用 Dataway。進(jìn)而改進(jìn)老項(xiàng)目的迭代效率，大大減少企業(yè)項(xiàng)目研發(fā)成本。

Dataway 工具化的提供 DataQL 配置能力。這種研發(fā)模式的變革使得，相當(dāng)多的需求開發(fā)場(chǎng)景只需要配置即可完成交付。從而避免了從數(shù)據(jù)存取到前端接口之間的一系列開發(fā)任務(wù)，例如：Mapper、BO、VO、DO、DAO、Service、Controller 統(tǒng)統(tǒng)不在需要。

Dataway 是 Hasor 生態(tài)中的一員，因此在 Spring 中使用 Dataway 首先要做的就是打通兩個(gè)生態(tài)。根據(jù)官方文檔中推薦的方式我們將 Hasor 和 Spring Boot 整合起來。這里是原文：https://www.hasor.net/web/extends/spring/for_boot.html

# 第一步：引入相關(guān)依賴

<dependency>

<groupId>net.hasor</groupId>

<artifactId>hasor-spring</artifactId>

<version>4.1.3</version>

</dependency>

<dependency>

<groupId>net.hasor</groupId>

<artifactId>hasor-dataway</artifactId>

<version>4.1.3-fix20200414</version><!-- 4.1.3 包存在UI資源缺失問題 -->

</dependency>

hasor-spring 負(fù)責(zé) Spring 和 Hasor 框架之間的整合。

hasor-dataway 是工作在 Hasor 之上，利用 hasor-spring 我們就可以使用 dataway了。

# 第二步：配置 Dataway，并初始化數(shù)據(jù)表

dataway 會(huì)提供一個(gè)界面讓我們配置接口，這一點(diǎn)類似 Swagger 只要jar包集成就可以實(shí)現(xiàn)接口配置。找到我們 springboot 項(xiàng)目的配置文件 application.properties

# 是否啟用 Dataway 功能（必選：默認(rèn)false）

HASOR_DATAQL_DATAWAY=true

# 是否開啟 Dataway 后臺(tái)管理界面（必選：默認(rèn)false）

HASOR_DATAQL_DATAWAY_ADMIN=true

# dataway  API工作路徑（可選，默認(rèn)：/api/）

HASOR_DATAQL_DATAWAY_API_URL=/api/

# dataway-ui 的工作路徑（可選，默認(rèn)：/interface-ui/）

HASOR_DATAQL_DATAWAY_UI_URL=/interface-ui/

# SQL執(zhí)行器方言設(shè)置（可選，建議設(shè)置）

HASOR_DATAQL_FX_PAGE_DIALECT=mysql

Dataway 一共涉及到 5個(gè)可以配置的配置項(xiàng)，但不是所有配置都是必須的。

其中 HASOR_DATAQL_DATAWAY、HASOR_DATAQL_DATAWAY_ADMIN 兩個(gè)配置是必須要打開的，默認(rèn)情況下 Datawaty 是不啟用的。

Dataway 需要兩個(gè)數(shù)據(jù)表才能工作，下面是這兩個(gè)數(shù)據(jù)表的簡表語句。下面這個(gè) 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 '狀態(tài)：0草稿，1發(fā)布，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 '接口的請(qǐng)求/響應(yīng)數(shù)據(jù)結(jié)構(gòu)',

`api_sample`      mediumtext       NULL                  COMMENT '請(qǐng)求/響應(yīng)/請(qǐng)求頭樣本數(shù)據(jù)',

`api_create_time` datetime     DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時(shí)間',

`api_gmt_time`    datetime     DEFAULT CURRENT_TIMESTAMP COMMENT '修改時(shí)間',

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 '狀態(tài)：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 '原始查詢腳本，僅當(dāng)類型為SQL時(shí)不同',

`pub_schema`      mediumtext       NULL                  COMMENT '接口的請(qǐng)求/響應(yīng)數(shù)據(jù)結(jié)構(gòu)',

`pub_sample`      mediumtext       NULL                  COMMENT '請(qǐng)求/響應(yīng)/請(qǐng)求頭樣本數(shù)據(jù)',

`pub_release_time`datetime     DEFAULT CURRENT_TIMESTAMP COMMENT '發(fā)布時(shí)間（下線不更新）',

PRIMARY KEY (`pub_id`)

) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4 COMMENT='Dataway API 發(fā)布?xì)v史。';

create index idx_interface_release on interface_release (pub_api_id);

第三步：配置數(shù)據(jù)源

作為 Spring Boot 項(xiàng)目有著自己完善的數(shù)據(jù)庫方面工具支持。我們這次采用 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>

然后增加數(shù)據(jù)源的配置

# 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

如果項(xiàng)目已經(jīng)集成了自己的數(shù)據(jù)源，那么可以忽略第三步。

# 第四步：把數(shù)據(jù)源設(shè)置到 Hasor 容器中

Spring Boot 和 Hasor 本是兩個(gè)獨(dú)立的容器框架，我們做整合之后為了使用 Dataway 的能力需要把 Spring 中的數(shù)據(jù)源設(shè)置到 Hasor 中。

首先新建一個(gè) Hasor 的 模塊，并且將其交給 Spring 管理。然后把數(shù)據(jù)源通過 Spring 注入進(jìn)來。

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

}

}

Hasor 啟動(dòng)的時(shí)候會(huì)調(diào)用 loadModule 方法，在這里再把 DataSource 設(shè)置到 Hasor 中。

# 第五步：在SprintBoot 中啟用 Hasor

@EnableHasor()

@EnableHasorWeb()

@SpringBootApplication(scanBasePackages = { "net.example.hasor" })

public class ExampleApplication {

public static void main(String[] args) {

SpringApplication.run(ExampleApplication.class, args);

}

}

這一步非常簡單，只需要在 Spring 啟動(dòng)類上增加兩個(gè)注解即可。

# 第六步：啟動(dòng)應(yīng)用

應(yīng)用在啟動(dòng)過程中會(huì)看到 Hasor Boot 的歡迎信息。

在后面的日志中還可以看到類似下面這些日志。

2020-04-14 13:52:59.696 [main] INFO  n.h.core.context.TemplateAppContext - loadModule class net.hasor.dataway.config.DatawayModule

2020-04-14 13:52:59.697 [main] INFO  n.hasor.dataway.config.DatawayModule - dataway api workAt /api/

2020-04-14 13:52:59.697 [main] INFO  n.h.c.e.AbstractEnvironment - var -> HASOR_DATAQL_DATAWAY_API_URL = /api/.

2020-04-14 13:52:59.704 [main] INFO  n.hasor.dataway.config.DatawayModule - dataway admin workAt /interface-ui/

2020-04-14 13:52:59.716 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[901d38f22faa419a8593bb349905ed0e] -> bindType ‘class net.hasor.dataway.web.ApiDetailController’ mappingTo: ‘[/interface-ui/api/api-detail]’.

2020-04-14 13:52:59.716 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[c6eb9f3b3d4c4c8d8a4f807435538172] -> bindType ‘class net.hasor.dataway.web.ApiHistoryListController’ mappingTo: ‘[/interface-ui/api/api-history]’.

2020-04-14 13:52:59.717 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[eb841dc72ad54023957233ef602c4327] -> bindType ‘class net.hasor.dataway.web.ApiInfoController’ mappingTo: ‘[/interface-ui/api/api-info]’.

2020-04-14 13:52:59.717 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[96aebb46265245459ae21d558e530921] -> bindType ‘class net.hasor.dataway.web.ApiListController’ mappingTo: ‘[/interface-ui/api/api-list]’.

2020-04-14 13:52:59.718 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[7467c07f160244df8f228321f6262d3d] -> bindType ‘class net.hasor.dataway.web.ApiHistoryGetController’ mappingTo: ‘[/interface-ui/api/get-history]’.

2020-04-14 13:52:59.719 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[97d8da5363c741ba99d87c073a344412] -> bindType ‘class net.hasor.dataway.web.DisableController’ mappingTo: ‘[/interface-ui/api/disable]’.

2020-04-14 13:52:59.720 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[8ddc3316ef2642dfa4395ca8ac0fff04] -> bindType ‘class net.hasor.dataway.web.SmokeController’ mappingTo: ‘[/interface-ui/api/smoke]’.

2020-04-14 13:52:59.720 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[cc06c5fb343b471aacedc58fb2fe7bf8] -> bindType ‘class net.hasor.dataway.web.SaveApiController’ mappingTo: ‘[/interface-ui/api/save-api]’.

2020-04-14 13:52:59.720 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[7915b2b1f89a4e73891edab0264c9bd4] -> bindType ‘class net.hasor.dataway.web.PublishController’ mappingTo: ‘[/interface-ui/api/publish]’.

2020-04-14 13:52:59.721 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[0cfa34586455414591bdc389bff23ccb] -> bindType ‘class net.hasor.dataway.web.PerformController’ mappingTo: ‘[/interface-ui/api/perform]’.

2020-04-14 13:52:59.721 [main] INFO  net.hasor.core.binder.ApiBinderWrap - mapingTo[37fe4af3e2994acb8deb72d21f02217c] -> bindType ‘class net.hasor.dataway.web.DeleteController’ mappingTo: ‘[/interface-ui/api/delete]’.

當(dāng)看到 “dataway api workAt /api/” 、 dataway admin workAt /interface

-ui/ 信息時(shí)，就可以確定 Dataway 的配置已經(jīng)生效了。

# 第七步：訪問接口管理頁面進(jìn)行接口配置

在瀏覽器中輸入 “http://127.0.0.1:8080/interface-ui/” 就可以看到期待已久的界面了。

# 第八步：新建一個(gè)接口

Dataway 提供了2中語言模式，我們可以使用強(qiáng)大的 DataQL 查詢語言，也可以直接使用 SQL 語言（在 Dataway 內(nèi)部 SQL 語言也會(huì)被轉(zhuǎn)換為 DataQL 的形式執(zhí)行。）

首先我們?cè)?SQL 模式下嘗試執(zhí)行一條 select 查詢，立刻就可以看到這條 SQL 的查詢結(jié)果。

同樣的方式我們使用 DataQL 的方式需要這樣寫：

var query = @@sql()<%

select * from interface_info

%>

return query()

其中 var query = @@sql()<% ... %> 是用來定義SQL外部代碼塊，并將這個(gè)定義存入 query 變量名中。<% %> 中間的就是 SQL 語句。

最后在 DataQL 中調(diào)用這個(gè)代碼塊，并返回查詢結(jié)果。

當(dāng)接口寫好之后就可以保存發(fā)布了，為了測(cè)試方便，我選用 GET 方式。

接口發(fā)布之后我們直接請(qǐng)求：http://127.0.0.1:8080/api/demos，就看到期待已久的接口返回值了。

# 總結(jié)

經(jīng)過上面的幾個(gè)步驟我們介紹了如何基于 Spring Boot 項(xiàng)目使用 Dataway 來簡單的配置接口。Dataway 的方式確實(shí)給人耳目一新，一個(gè)接口竟然可以如此簡單的配置出來無需開發(fā)任何一行代碼，也不需要做任何 Mapping 實(shí)體映射綁定。

作者：哈庫納 

地址：my.oschina.net/ta8210/blog/3234639