SpringBoot三十五：整合Dataway

最新推荐文章于 2023-08-01 14:46:04 发布

阅读量4k

点赞数 3

分类专栏： # SpringBoot 文章标签： spring boot spring java

本文链接：https://blog.csdn.net/weixin_45730091/article/details/106570753

版权

SpringBoot 专栏收录该内容

48 篇文章 9 订阅

订阅专栏

文章目录

Dataway介绍

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

这种内嵌集成方式模式的优点是，可以使得大部分老项目都可以在无侵入的情况下直接应用 Dataway。进而改进老项目的迭代效率，大大减少企业项目研发成本。

Dataway 工具化的提供 DataQL 配置能力。这种研发模式的变革使得，相当多的需求开发场景只需要配置即可完成交付。从而避免了从数据存取到前端接口之间的一系列开发任务，例如：Mapper、BO、VO、DO、DAO、Service、Controller 统统不在需要。

Dataway 是 Hasor 生态中的一员，因此在 Spring 中使用 Dataway 首先要做的就是打通两个生态。根据官方文档中推荐的方式我们将 Hasor 和 Spring Boot 整合起来。这里是原文：https://www.hasor.net/web/extends/spring/for_boot.html

第一步：引入相关依赖

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

第二步：配置 Dataway，并初始化数据表

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

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>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>druid</artifactId>
	<version>1.1.21</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://localhost:3306/javakf_test1?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.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

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

第四步：把数据源设置到 Hasor 容器中

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

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

@DimModule
@Component
public class DatawayModule 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 中。

第五步：在SprintBoot 中启用 Hasor

@EnableHasor()
@EnableHasorWeb()
@SpringBootApplication(scanBasePackages = { "cn.com.javakf.dataway" })
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}

}

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

第六步：启动应用

应用在启动过程中会看到 Hasor Boot 的欢迎信息

 _    _                        ____              _
| |  | |                      |  _ \            | |
| |__| | __ _ ___  ___  _ __  | |_) | ___   ___ | |_
|  __  |/ _` / __|/ _ \| '__| |  _ < / _ \ / _ \| __|
| |  | | (_| \__ \ (_) | |    | |_) | (_) | (_) | |_
|_|  |_|\__,_|___/\___/|_|    |____/ \___/ \___/ \__|

在后面的日志中还可以看到类似下面这些日志。

2020-06-05 16:16:25.973  INFO 13000 --- [           main] net.hasor.dataway.config.DatawayModule   : dataway api workAt /api/
2020-06-05 16:16:25.974  INFO 13000 --- [           main] n.h.c.environment.AbstractEnvironment    : var -> HASOR_DATAQL_DATAWAY_API_URL = /api/.
2020-06-05 16:16:25.983  INFO 13000 --- [           main] net.hasor.dataway.config.DatawayModule   : dataway self isolation ->net.hasor.dataway.config.DatawayModule
2020-06-05 16:16:25.986  INFO 13000 --- [           main] net.hasor.dataway.config.DatawayModule   : dataway admin workAt /interface-ui/
2020-06-05 16:16:25.999  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[54790db8a3bc4ff7bde0454ddbc68791] -> bindType 'class net.hasor.dataway.web.ApiDetailController' mappingTo: '[/interface-ui/api/api-detail]'.
2020-06-05 16:16:26.000  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[3868a79a79584668828b82970c657454] -> bindType 'class net.hasor.dataway.web.ApiHistoryListController' mappingTo: '[/interface-ui/api/api-history]'.
2020-06-05 16:16:26.000  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[8b6a44698e644b3ab4cb9a57bbe8a928] -> bindType 'class net.hasor.dataway.web.ApiInfoController' mappingTo: '[/interface-ui/api/api-info]'.
2020-06-05 16:16:26.001  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[c4c17f1a3fc94a8793336fb4ee19907c] -> bindType 'class net.hasor.dataway.web.ApiListController' mappingTo: '[/interface-ui/api/api-list]'.
2020-06-05 16:16:26.001  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[74580b0ecd3d4cbdb99612322dbc0836] -> bindType 'class net.hasor.dataway.web.ApiHistoryGetController' mappingTo: '[/interface-ui/api/get-history]'.
2020-06-05 16:16:26.005  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[49556cd6b6b3439992d4f7e24541e3a2] -> bindType 'class net.hasor.dataway.web.DisableController' mappingTo: '[/interface-ui/api/disable]'.
2020-06-05 16:16:26.006  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[e884cf6f7760432f9b7bdf82d8567e25] -> bindType 'class net.hasor.dataway.web.SmokeController' mappingTo: '[/interface-ui/api/smoke]'.
2020-06-05 16:16:26.007  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[4c7dd96f388043c8899ef006a8a9da7a] -> bindType 'class net.hasor.dataway.web.SaveApiController' mappingTo: '[/interface-ui/api/save-api]'.
2020-06-05 16:16:26.008  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[ba000a8dda8242228787e042d17675e0] -> bindType 'class net.hasor.dataway.web.PublishController' mappingTo: '[/interface-ui/api/publish]'.
2020-06-05 16:16:26.009  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[420123f03de04c038ebcb6f72cadefb4] -> bindType 'class net.hasor.dataway.web.PerformController' mappingTo: '[/interface-ui/api/perform]'.
2020-06-05 16:16:26.010  INFO 13000 --- [           main] net.hasor.core.binder.ApiBinderWrap      : mapingTo[a27a930c0b06441990330fd1ccd5d0da] -> bindType 'class net.hasor.dataway.web.DeleteController' mappingTo: '[/interface-ui/api/delete]'.

当看到 “dataway api workAt /api/” 、 dataway admin workAt /interface-ui/ 信息时，就可以确定 Dataway 的配置已经生效了。

第七步：访问接口管理页面进行接口配置

在浏览器中输入：http://127.0.0.1:8080/interface-ui/ 就可以看到期待已久的界面了。
在这里插入图片描述

第八步：新建一个接口

Dataway 提供了2中语言模式，我们可以使用强大的 DataQL 查询语言，也可以直接使用 SQL 语言（在 Dataway 内部 SQL 语言也会被转换为 DataQL 的形式执行。）
在这里插入图片描述
首先我们在 SQL 模式下尝试执行一条 select 查询，立刻就可以看到这条 SQL 的查询结果。

同样的方式我们使用 DataQL 的方式需要这样写：

var query = @@sql()<%
    select * from interface_info
%>
return query()

其中 var query = @@sql()<% ... %> 是用来定义SQL外部代码块，并将这个定义存入 query 变量名中。<% %> 中间的就是 SQL 语句。

最后在 DataQL 中调用这个代码块，并返回查询结果。

当接口写好之后就可以保存发布了，为了测试方便，我选用 GET 方式。
在这里插入图片描述
接口发布之后我们直接请求：http://127.0.0.1:8080/api/demos，就看到期待已久的接口返回值了。

最后总结

经过上面的几个步骤我们介绍了如何基于 Spring Boot 项目使用 Dataway 来简单的配置接口。Dataway 的方式确实给人耳目一新，一个接口竟然可以如此简单的配置出来无需开发任何一行代码，也不需要做任何 Mapping 实体映射绑定。

最后放几个有用的连接：

Dataway 官方手册：https://www.hasor.net/web/dataway/about.html
Dataway 在 OSC 上的项目地址：https://www.oschina.net/p/dataway
DataQL 手册地址：https://www.hasor.net/web/dataql/what_is_dataql.html
Hasor 项目的首页：https://www.hasor.net/web/index.html

原文链接：https://my.oschina.net/ta8210/blog/3234639

测试请求参数及数据响应格式

通常前后端连调时，都要对接一下接口。在这个过程中前后端会确定请求参数的个数和格式，以及数据响应的个数和格式。

比如根据用户名称模糊查询相关用户列表。在这个场景中设定一个请求参数，姑且叫它 userName把。然后返回一个列表，列表中是符合条件的用户信息。

为了这个场景我们首先需要定义前后端交互数据接口
请求：
userName : String
响应：
rootData：Array[UserInfo]
UserInfo：{
     user_id   : Integer,
     user_name : String,
     user_sex  : String
}

在 Dataway 中首先我们新建一个接口，并且给接口取好名字和备注。
在这里插入图片描述
紧接着我们在 Dataway 的页面中定义前端请求参数。

在编写SQL 之前我们先在 DataQL 上编写一段 JSON 通过这个 JSON 来模拟数据输出的结果。

接下来我们编写数据库查询然后返回我们在数据库中的数据，为了演示这个功能我在数据库中先创建了一张表并且初始化了一些数据。

CREATE TABLE `user_info` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(128) DEFAULT NULL,
  `sex` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4

在这里插入图片描述
接下来我编写一段 SQL 查询这个表，并且在返回 mock 的数据的前面先尝试执行SQL返回数据。

可以看到数据已经如我们预期的输出了出来，在这里 DataQL 的执行是按照顺序进行的。当遇到 return 指令的时，后续的查询将不会被执行。

接着把数据库返回的结果做一下格式转换，让其按照我们要求的格式返回数据。官方手册这一部分的内容在这里：https://www.hasor.net/web/dataql/grammar/convert.html#
在这里插入图片描述
最后一部分，在 SQL 查询中使用我们预先定义好的 userName 来进行模糊匹配。首先 SQL 语句需要有所改写：

select * from user_info
   =>
select * from user_info where like `name` like #{userName} <- 类似 Mybatis 的写法，带参数的SQL 用 #{...}

SQL 中参数名已经确定好了，接下来改写一下定义 SQL 查询这一部分声明一个参数。这就好比定义方法的参数一样。

var query= @@sql(userName)<%   <-- 增加参数定义
    select * from user_info where `name` like #{userName}
%>

最后将前端传入的请求参数，在执行用户查询的时候将其传进去即可。在 DataQL 查询中要想获得 Paramerers 面板中定义的参数需要通过 ${ … } 形式获取。这部分内容在官方手册上也有介绍在这里：https://www.hasor.net/web/dataql/grammar/params.html
在这里插入图片描述
这样一来我们就可以通过前端传入 '%xxxx%' 这样的形式的参数就可以完成模糊匹配查询了。

有心的同学可能想问如何能让前端避免传 % 这样的字符？如果传了就默认加上，不传就默认查询全部。

实现这个需求其实有很多办法，这篇文章主要讲解的是前后端传参数传递，因此我们选用数据库拼接字符串的方式来实现。

我们可以利用数据库的字符串连接功能把 % 拼接的事情交给数据库： concat('%',#{userName},'%')
另外还可以通过 DataQL 的方式。

然后我们在请求参数上输入模糊匹配的信息执行查询就可以得到结果了。
在这里插入图片描述
这一次我们采用 Post 方式来请求接口。为了模拟 Post 我们需要请出 PostMan 这个神器。

代码托管：springboot_dataway

关注

3
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot三十五：整合Dataway

Dataway介绍Dataway 是基于 DataQL 服务聚合能力，为应用提供的一个接口配置工具。使得使用者无需开发任何代码就配置一个满足需求的接口。整个接口配置、测试、冒烟、发布。一站式都通过 Dataway 提供的 UI 界面完成。UI 会以 Jar 包方式提供并集成到应用中并和应用共享同一个 http 端口，应用无需单独为 Dataway 开辟新的管理端口。这种内嵌集成方式模式的优点是，可以使得大部分老项目都可以在无侵入的情况下直接应用 Dataway。进而改进老项目的迭代效率，大大减少企业项目
复制链接

扫一扫