Dataway接口配置服务，去掉后台，从此告别Controller、Service、Mapping
原创Dataway接口配置服务，去掉后台，从此告别Controller、Service、Mapping
原创
博客（coder的自我修养）原文链接：http://www.imcoder.fun/archives/1591174066705
1、Dataway介绍
Dataway 是基于 DataQL 服务聚合能力，为应用提供的一个接口配置工具。使得使用者无需开发任何代码就配置一个满足需求的接口。 整个接口配置、测试、冒烟、发布。一站式都通过 Dataway 提供的 UI 界面完成。UI 会以 Jar 包方式提供并集成到应用中并和应用共享同一个 http 端口，应用无需单独为 Dataway 开辟新的管理端口。
这种内嵌集成方式模式的优点是，可以使得大部分老项目都可以在无侵入的情况下直接应用 Dataway。进而改进老项目的迭代效率，大大减少企业项目研发成本。
Dataway 工具化的提供 DataQL 配置能力。这种研发模式的变革使得，相当多的需求开发场景只需要配置即可完成交付。 从而避免了从数据存取到前端接口之间的一系列开发任务，例如：Mapper、BO、VO、DO、DAO、Service、Controller 统统不在需要。
2、SpringBoot整合
Dataway 是 Hasor 生态中的一员，使用 Dataway 第一步需要通过 hasor-spring 打通两个生态。
目前最新版本是4.1.8
maven依赖
<!-- hasor依赖 -->
<dependency>
<groupId>net.hasor</groupId>
<artifactId>hasor-spring</artifactId>
<version>4.1.8</version><!-- 查看最新版本：https://mvnrepository.com/artifact/net.hasor/hasor-spring -->
</dependency>
<dependency>
<groupId>net.hasor</groupId>
<artifactId>hasor-dataway</artifactId>
<version>4.1.8</version><!-- 查看最新版本：https://mvnrepository.com/artifact/net.hasor/hasor-dataway -->
</dependency>
<!-- 数据库依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>配置Dataway
在application.properties或者application.yml中添加Dataway的配置，示例配置如下
# 端口
server.port=8088
# 数据源
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/dataway?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
# 是否启用 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所需表
Dataway需要两张表 interface_info、interface_release 来存储相关接口信息，建表语句如下
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_option` 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 unique index idx_interface_info on interface_info (api_method, api_path);
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_option` 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);这些建表语句在hasor-dataway-xxx.jar中可以直接找到，如下图
初始化数据源
将 Spring 使用的数据源导入到 Hasor 环境供 Dataway 使用。
package fun.imcoder.cloud.dataway.hasor;
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.stereotype.Component;
import javax.annotation.Resource;
import javax.sql.DataSource;
@DimModule
@Component
public class HasorModule implements SpringModule {
@Resource
private DataSource dataSource;
@Override
public void loadModule(ApiBinder apiBinder) throws Throwable {
apiBinder.installModule(new JdbcModule(Level.Full, this.dataSource));
}
}启动工程
在SpringBoot工程的启动类上加上@EnableHasor和@EnableHasorWeb两个注解即可
package fun.imcoder.cloud.dataway;
import net.hasor.spring.boot.EnableHasor;
import net.hasor.spring.boot.EnableHasorWeb;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableHasor
@EnableHasorWeb
public class DatawayApplication {
public static void main(String[] args) {
SpringApplication.run(DatawayApplication.class, args);
}
}启动后出现如下日志信息说明整合成功
3、配置接口
项目启动完成后，我们就可以访问接口配置页面了，接口地址：http://127.0.0.1:8088/interface-ui/#/
页面如下
上如中我已经新建好了一个接口，下面我们再来新建一个接口，点解 +New 如下图所示
我们新建接口 /api/user/list做为用户列表查询接口，sql模式我们选择SQL，在接口编写去填写最简单的sql查询语句 select * from user 然后点击执行，如下图所示
可以看到我们已经得到了想要的接口，然后我们点击保存、冒烟测试最后发布就成功配置了一个接口，发布之后，我们用postman来测试一下接口
可以看到，接口可以正常访问，用DataQL的方式也很简单如下
// 声明一个 SQL
var dataSet = @@sql() <%
select * from user;
%>
// 执行这个 SQL，并返回结果
return dataSet();4、SQL参数化
// 类似mybatis写法
var dataSet = @@sql(userId) <%
select * from user where user_id = #{userId};
%>
// 执行这个 SQL，并返回结果
return dataSet(${userId});
可以看到数据返回正常
5、结果转换
// 类似mybatis写法
var dataSet = @@sql(userId) <%
select * from user where user_id = #{userId};
%>
// 执行这个 SQL，返回结果并进行结果转换
return dataSet(${userId}) => [
{
"userId":user_id,
"userName":user_name
}
];
是不是很简单，只需要进行简单的配置就可以完成一个接口的编写，省去了大量的Controller、Service、Mapping代码，这里只是分享一个简单的接口通过配置发布，后续回更新更多关于Dataway的文章。
欢迎关注我的公众号：coder的自我修养
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。