官方文檔地址:https://www.hasor.net/web/dataway/about.html
Dataway的demo地址:https://github.com/Guofucheng0822/spring-boot-demo/tree/master/project-hasor-dataway
Dataway 是基於 DataQL 服務聚合能力,爲應用提供的一個接口配置工具。使得使用者無需開發任何代碼就配置一個滿足需求的接口。整個接口配置、測試、冒煙、發佈。一站式都通過 Dataway 提供的 UI 界面完成。UI 會以 Jar 包方式提供並集成到應用中並和應用共享同一個 http 端口,應用無需單獨爲 Dataway 開闢新的管理端口。
這種內嵌集成方式模式的優點是,可以使得大部分老項目都可以在無侵入的情況下直接應用 Dataway。進而改進老項目的迭代效率,大大減少企業項目研發成本。
Dataway 工具化的提供 DataQL 配置能力。這種研發模式的變革使得,相當多的需求開發場景只需要配置即可完成交付。從而避免了從數據存取到前端接口之間的一系列開發任務,例如:Mapper、BO、VO、DO、DAO、Service、Controller 統統不在需要。
Dataway 是 Hasor 生態中的一員,使用 Dataway 第一步需要通過 hasor-spring 打通兩個生態。hasor-spring 負責 Spring 和 Hasor 框架之間的整合。hasor-dataway 是工作在 Hasor 之上,利用 hasor-spring 我們就可以使用 dataway了。
<!-- dataway-->
<!-- hasor-spring 負責 Spring 和 Hasor 框架之間的整合。-->
<dependency>
<groupId>net.hasor</groupId>
<artifactId>hasor-spring</artifactId>
<version>4.1.3</version>
</dependency>
<!-- hasor-dataway 是工作在 Hasor 之上,利用 hasor-spring 我們就可以使用 dataway了-->
<dependency>
<groupId>net.hasor</groupId>
<artifactId>hasor-dataway</artifactId>
<version>4.1.3-fix20200414</version><!-- 4.1.3 包存在UI資源缺失問題 -->
</dependency>
dataway 會提供一個界面讓我們配置接口,這一點類似 Swagger 只要jar包集成就可以實現接口配置。找到我們 springboot 項目的配置文件 application.properties
#-----------------------------Dataway相關配置----------------------------------------------------
# 是否啓用 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
Dataway 一共涉及到 5個可以配置的配置項,但不是所有配置都是必須的。
其中 HASOR_DATAQL_DATAWAY、HASOR_DATAQL_DATAWAY_ADMIN 兩個配置是必須要打開的,默認情況下 Datawaty 是不啓用的。
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);
作爲 Spring Boot 項目有着自己完善的數據庫方面工具支持。我們這次採用 druid + mysql + spring-boot-starter-jdbc 的方式。
<!--數據庫相關配置-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.19</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>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
#-----------------------------數據源相關配置----------------------------------------------------
# db
spring.datasource.url=jdbc:mysql://192.168.18.128:3306/test
spring.datasource.username=root
spring.datasource.password=123456
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
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));
}
}
Hasor 啓動的時候會調用 loadModule 方法,在這裏再把 DataSource 設置到 Hasor 中。
@EnableHasor() // 在Spring 中啓用 Hasor
@EnableHasorWeb() // 將 hasor-web 配置到 Spring 環境中,Dataway 的 UI 是通過 hasor-web 提供服務。
@SpringBootApplication
public class DatawayApplication {
public static void main(String[] args) {
SpringApplication.run(DatawayApplication.class, args);
}
}
在啓動日誌中看到下列信息輸出就表示 Dataway 已經可以正常訪問了。
2020-05-02 10:16:04.264 INFO 1236 --- [ost-startStop-1] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.dataway.config.DatawayModule
2020-05-02 10:16:04.264 INFO 1236 --- [ost-startStop-1] net.hasor.dataway.config.DatawayModule : dataway api workAt /api/
2020-05-02 10:16:04.264 INFO 1236 --- [ost-startStop-1] n.h.c.environment.AbstractEnvironment : var -> HASOR_DATAQL_DATAWAY_API_URL = /api/.
2020-05-02 10:16:04.271 INFO 1236 --- [ost-startStop-1] net.hasor.dataway.config.DatawayModule : dataway admin workAt /interface-ui/
此時訪問:http://<yourIP>:<yourProt>/interface-ui/ 就可以看到配置頁面了。