新技术 了解一下:Dataway让SpringBoot不在需要Controller、Service、DAO、Mapper了

网友投稿 1281 2022-05-30

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

第一步:引入相关依赖

net.hasor hasor-spring 4.1.3 net.hasor hasor-dataway 4.1.3-fix20200414

1

2

3

4

5

6

7

8

9

10

hasor-spring 负责 Spring 和 Hasor 框架之间的整合。

hasor-dataway 是工作在 Hasor 之上,利用 hasor-spring 我们就可以使用 dataway了。

第二步:配置 Dataway,并初始化数据表

dataway 会提供一个界面让我们配置接口,这一点类似 Swagger 只要jar包集成就可以实现接口配置。找到我们 springboot 项目的配置文件 application.yml

# 是否启用 Dataway 功能(必选:默认false) HASOR_DATAQL_DATAWAY: true # 是否开启 Dataway 后台管理界面(必选:默认false) HASOR_DATAQL_DATAWAY_ADMIN: true # dataway API工作路径(可选,默认:/api/) HASOR_DATAQL_DATAWAY_API_URL: /api/ # SQL执行器方言设置(可选,建议设置) HASOR_DATAQL_FX_PAGE_DIALECT: mysql

1

2

3

4

5

6

7

8

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);

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

第三步:配置数据源

作为 Spring Boot 项目有着自己完善的数据库方面工具支持。我们这次采用 druid + mysql + spring-boot-starter-jdbc 的方式。

首先引入依赖

mysql mysql-connector-java 5.1.30 com.alibaba druid 1.1.21 org.springframework.boot spring-boot-starter-jdbc com.alibaba druid-spring-boot-starter 1.1.10

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

然后增加数据源的配置

spring: datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://XXXXXXXX:3306/demo username: root password: 123456 druid: initial-size: 3 min-idle: 3 max-active: 10 max-wait: 60 stat-view-servlet: login-username: admin login-password: admin filter: stat: log-slow-sql: true slow-sql-millis: 1

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

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

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)); } }

1

2

3

4

5

6

7

8

9

10

11

12

Hasor 启动的时候会调用 loadModule 方法,在这里再把 DataSource 设置到 Hasor 中。

第五步:在SprintBoot 中启用 Hasor

@EnableHasor @EnableHasorWeb @SpringBootApplication(scanBasePackages = {"com.dateway.demo"}) //主启动类的包名 public class DataweyDemoApplication { public static void main(String[] args) { SpringApplication.run(DataweyDemoApplication.class, args); } }

1

2

3

4

5

6

7

8

9

10

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

第六步:启动应用

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

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

2020-04-28 10:12:29.740 INFO 2240 --- [ main] net.hasor.core.Hasor : runMode at Full ,runPath at E:\Work\JavaPros\datawayDemo 2020-04-28 10:12:29.749 INFO 2240 --- [ main] n.h.c.setting.StandardContextSettings : addConfig '/META-INF/hasor-framework/core-hconfig.xml' in 'jar:file:/D:/maven-repository/net/hasor/hasor-core/4.1.3/hasor-core-4.1.3.jar!/META-INF/hasor.schemas' 2020-04-28 10:12:29.752 INFO 2240 --- [ main] n.h.c.setting.StandardContextSettings : addConfig '/META-INF/hasor-framework/dataway-hconfig.xml' in 'jar:file:/D:/maven-repository/net/hasor/hasor-dataway/4.1.3-fix20200414/hasor-dataway-4.1.3-fix20200414.jar!/META-INF/hasor.schemas' 2020-04-28 10:12:29.754 INFO 2240 --- [ main] n.h.c.setting.StandardContextSettings : addConfig '/META-INF/hasor-framework/web-hconfig.xml' in 'jar:file:/D:/maven-repository/net/hasor/hasor-web/4.1.3/hasor-web-4.1.3.jar!/META-INF/hasor.schemas' 2020-04-28 10:12:29.755 INFO 2240 --- [ main] n.h.c.setting.StandardContextSettings : addConfig '/META-INF/hasor-framework/db-hconfig.xml' in 'jar:file:/D:/maven-repository/net/hasor/hasor-db/4.1.3/hasor-db-4.1.3.jar!/META-INF/hasor.schemas' 2020-04-28 10:12:29.757 INFO 2240 --- [ main] n.h.c.setting.StandardContextSettings : addConfig '/META-INF/hasor-framework/dataql-hconfig.xml' in 'jar:file:/D:/maven-repository/net/hasor/hasor-dataql/4.1.3/hasor-dataql-4.1.3.jar!/META-INF/hasor.schemas' 2020-04-28 10:12:29.759 INFO 2240 --- [ main] n.h.c.setting.StandardContextSettings : addConfig '/META-INF/hasor-framework/dataql-fx-hconfig.xml' in 'jar:file:/D:/maven-repository/net/hasor/hasor-dataql-fx/4.1.3/hasor-dataql-fx-4.1.3.jar!/META-INF/hasor.schemas' 2020-04-28 10:12:29.805 INFO 2240 --- [ main] n.h.c.environment.AbstractEnvironment : loadPackages = com.*, net.*, net.hasor.*, net.hasor.dataql.*, net.hasor.dataql.fx.*, net.hasor.dataway.*, net.hasor.db.*, net.hasor.web.*, org.* 2020-04-28 10:12:29.961 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.dataway.config.DatawayModule 2020-04-28 10:12:29.961 INFO 2240 --- [ main] net.hasor.dataway.config.DatawayModule : dataway api workAt /api/ 2020-04-28 10:12:29.961 INFO 2240 --- [ main] n.h.c.environment.AbstractEnvironment : var -> HASOR_DATAQL_DATAWAY_API_URL = /api/. 2020-04-28 10:12:29.968 INFO 2240 --- [ main] net.hasor.dataway.config.DatawayModule : dataway admin workAt /interface-ui/ 2020-04-28 10:12:29.981 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[74c3d58fbe4045a895490a03e543ce79] -> bindType ‘class net.hasor.dataway.web.ApiDetailController’ mappingTo: ‘[/interface-ui/api/api-detail]’. 2020-04-28 10:12:29.981 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[d6c1e24f85a745a491421f9567d87795] -> bindType ‘class net.hasor.dataway.web.ApiHistoryListController’ mappingTo: ‘[/interface-ui/api/api-history]’. 2020-04-28 10:12:29.982 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[8ece156bac9e47e68daa8952d46a8f9a] -> bindType ‘class net.hasor.dataway.web.ApiInfoController’ mappingTo: ‘[/interface-ui/api/api-info]’. 2020-04-28 10:12:29.983 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[97f5b045139b43d693e33f3abe2e11f5] -> bindType ‘class net.hasor.dataway.web.ApiListController’ mappingTo: ‘[/interface-ui/api/api-list]’. 2020-04-28 10:12:29.984 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[83ae308211bc4770951721d9516488d7] -> bindType ‘class net.hasor.dataway.web.ApiHistoryGetController’ mappingTo: ‘[/interface-ui/api/get-history]’. 2020-04-28 10:12:29.986 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[fb80b638d40045049eb1ae33136c9232] -> bindType ‘class net.hasor.dataway.web.DisableController’ mappingTo: ‘[/interface-ui/api/disable]’. 2020-04-28 10:12:29.987 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[44324f1380d64d3ba9294d639711a66e] -> bindType ‘class net.hasor.dataway.web.SmokeController’ mappingTo: ‘[/interface-ui/api/smoke]’. 2020-04-28 10:12:29.987 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[2a85562609c549e0a8b4dc3074494b9a] -> bindType ‘class net.hasor.dataway.web.SaveApiController’ mappingTo: ‘[/interface-ui/api/save-api]’. 2020-04-28 10:12:29.988 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[ba6ed1ad708f4e84ab5c81bab974d647] -> bindType ‘class net.hasor.dataway.web.PublishController’ mappingTo: ‘[/interface-ui/api/publish]’. 2020-04-28 10:12:29.988 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[75665744d3ca40728bc511e15408999d] -> bindType ‘class net.hasor.dataway.web.PerformController’ mappingTo: ‘[/interface-ui/api/perform]’. 2020-04-28 10:12:29.989 INFO 2240 --- [ main] net.hasor.core.binder.ApiBinderWrap : mapingTo[f62b4b9c30984183871836f88c74085b] -> bindType ‘class net.hasor.dataway.web.DeleteController’ mappingTo: ‘[/interface-ui/api/delete]’. 2020-04-28 10:12:29.992 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.web.render.RenderWebPlugin 2020-04-28 10:12:29.992 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.core.exts.startup.StartupModule 2020-04-28 10:12:29.993 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.core.exts.aop.AopModule 2020-04-28 10:12:29.995 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.dataql.fx.FxModule 2020-04-28 10:12:29.998 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class com.dateway.demo.component.ExampleModule 2020-04-28 10:12:29.999 INFO 2240 --- [ main] n.h.core.context.TemplateAppContext : installModule ->net.hasor.db.JdbcModule@6fbb4061 2020-04-28 10:12:30.004 INFO 2240 --- [ main] n.hasor.core.context.TemplateAppContext : loadModule class net.hasor.spring.boot.BasicHasorConfiguration$$Lambda4/901852282 2020-04-28 10:12:30.031 INFO 2240 --- [ main] net.hasor.dataway.config.DatawayModule : dataway dbMapping MySQL to default 2020-04-28 10:12:30.033 INFO 2240 --- [ main] net.hasor.web.render.RenderWebPlugin : RenderPlugin init -> useLayout=false, layoutPath=/layout, templatePath=/templates, placeholder=content_placeholder, defaultLayout=default.html 2020-04-28 10:12:30.044 INFO 2240 --- [sor-EventPool-1] n.hasor.core.context.TemplateAppContext : Hasor StartCompleted! 2020-04-28 10:12:30.085 INFO 2240 --- [ main] net.hasor.web.startup.RuntimeListener : ServletContext Attribut is net.hasor.core.AppContext 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.ApiDetailController’ mappingTo: ‘/interface-ui/api/api-detail’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.ApiHistoryListController’ mappingTo: ‘/interface-ui/api/api-history’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.ApiInfoController’ mappingTo: ‘/interface-ui/api/api-info’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.ApiListController’ mappingTo: ‘/interface-ui/api/api-list’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.ApiHistoryGetController’ mappingTo: ‘/interface-ui/api/get-history’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.DisableController’ mappingTo: ‘/interface-ui/api/disable’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.SmokeController’ mappingTo: ‘/interface-ui/api/smoke’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.SaveApiController’ mappingTo: ‘/interface-ui/api/save-api’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.PublishController’ mappingTo: ‘/interface-ui/api/publish’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.PerformController’ mappingTo: ‘/interface-ui/api/perform’. 2020-04-28 10:12:30.091 INFO 2240 --- [ main] net.hasor.web.invoker.InvokerContext : mapingTo -> type ‘class net.hasor.dataway.web.DeleteController’ mappingTo: ‘/interface-ui/api/delete’.

1

2

3

4

新技术 了解一下:Dataway让SpringBoot不在需要Controller、Service、DAO、Mapper了

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

当看到 “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 的形式执行。)

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

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

当接口写好之后就可以保存发布了,为了测试方便,我选用 GET 方式。

接口发布之后我们直接请求:http://127.0.0.1:8080/api/sysInfo,就看到期待已久的接口返回值了。

最后总结

经过上面的几个步骤我们介绍了如何基于 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

Spring Spring Boot

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:我是怎么把博客粉丝转到公众号的
下一篇:机器学习中文资源概览
相关文章