在 Spring Boot 中使用 Dataway 配置数据查询接口
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 整合起来。
第一步:引入相关依赖
hasor-spring 负责 Spring 和 Hasor 框架之间的整合。hasor-dataway 是工作在 Hasor 之上,利用 hasor-spring 我们就可以使用 dataway 了。
第二步:配置 Dataway,并初始化数据表
dataway 会提供一个界面让我们配置接口,这一点类似 Swagger 只要 jar 包集成就可以实现接口配置。找到我们 springboot 项目的配置文件 application.properties
Dataway 一共涉及到 5 个可以配置的配置项,但不是所有配置都是必须的。
其中 HASOR_DATAQL_DATAWAY、HASOR_DATAQL_DATAWAY_ADMIN 两个配置是必须要打开的,默认情况下 Datawaty 是不启用的。
Dataway 需要两个数据表才能工作,下面是这两个数据表的简表语句。下面这个 SQL 可以在 dataway 的依赖 jar 包中 “META-INF/hasor-framework/mysql” 目录下面找到,建表语句是用 mysql 语法写的。
第三步:配置数据源
作为 Spring Boot 项目有着自己完善的数据库方面工具支持。我们这次采用 druid + mysql + spring-boot-starter-jdbc 的方式。
首先引入依赖
然后增加数据源的配置
如果项目已经集成了自己的数据源,那么可以忽略第三步。
第四步:把数据源设置到 Hasor 容器中
Spring Boot 和 Hasor 本是两个独立的容器框架,我们做整合之后为了使用 Dataway 的能力需要把 Spring 中的数据源设置到 Hasor 中。
首先新建一个 Hasor 的 模块,并且将其交给 Spring 管理。然后把数据源通过 Spring 注入进来。
Hasor 启动的时候会调用 loadModule 方法,在这里再把 DataSource 设置到 Hasor 中。
第五步:在 SprintBoot 中启用 Hasor
这一步非常简单,只需要在 Spring 启动类上增加两个注解即可。
第六步:启动应用
应用在启动过程中会看到 Hasor Boot 的欢迎信息
在后面的日志中还可以看到类似下面这些日志。
当看到 “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 的形式执行。)
同样的方式我们使用 DataQL 的方式需要这样写:
其中 var query = @@sql()<% ... %> 是用来定义 SQL 外部代码块,并将这个定义存入 query 变量名中。 <% %> 中间的就是 SQL 语句。
最后在 DataQL 中调用这个代码块,并返回查询结果。
当接口写好之后就可以保存发布了,为了测试方便,我选用 GET 方式。
接口发布之后我们直接请求:http://127.0.0.1:8080/api/demos,就看到期待已久的接口返回值了。
最后总结
经过上面的几个步骤我们介绍了如何基于 Spring Boot 项目使用 Dataway 来简单的配置接口。Dataway 的方式确实给人耳目一新,一个接口竟然可以如此简单的配置出来无需开发任何一行代码,也不需要做任何 Mapping 实体映射绑定
评论