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等消費端使用；