Spring Boot 和Dataway实现

喜欢ヅ旅行 2023-03-14 10:59 25阅读 0赞

**一、介绍**  
  依托 DataQL 服务聚合能力，为应用提供一个 UI 界面。并以 jar 包的方式集成到应用中。 通过 Dataway 可以直接在界面上配置和发布接口。

这种模式的革新使得开发一个接口不必在编写任何形式的代码，只需要配置一条 DataQL 查询即可完成满足前端对接口的需求。 从而避免了从数据库到前端之间一系列的开发配置任务，例如：Mapper、DO、DAO、Service、Controller 统统不在需要。

Dataway特意采用了 jar包集成的方式发布，这使得任意的老项目都可以无侵入的集成 Dataway。 直接改进老项目的迭代效率，大大减少企业项目研发成本。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70]

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

如上图所示 Dataway 在开发模式上提供了巨大的便捷。虽然工作流程中标识了由后端开发来配置 DataQL 接口，但这主要是出于考虑接口责任人。 但在实际工作中根据实际情况需要，配置接口的人员可以是产品研发生命周期中任意一名角色。

*  Dataway 官方手册：[https://www.hasor.net/web/dataway/about.html][https_www.hasor.net_web_dataway_about.html]
 *  Dataway OSC 项目地址：[https://www.oschina.net/p/dataway][https_www.oschina.net_p_dataway]
 *  DataQL 手册地址：[https://www.hasor.net/web/dataql/what\_is\_dataql.html][https_www.hasor.net_web_dataql_what_is_dataql.html]
 *  Hasor 项目的首页：[https://www.hasor.net/web/index.html][https_www.hasor.net_web_index.html]

**二、实现**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70 1]  
如下图所示：生成接口  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70 2]  
测试接口查询  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70 3]  
依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.0.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.xxxx</groupId>
        <artifactId>dataway</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>dataway</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.30</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>net.hasor</groupId>
                <artifactId>hasor-spring</artifactId>
                <version>4.1.6</version>
            </dependency>
            <dependency>
                <groupId>net.hasor</groupId>
                <artifactId>hasor-dataway</artifactId>
                <version>4.1.6</version>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

配置

# 是否启用 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
    
    
    # db
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/znkf_new
    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

代码

package com.xxxx.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()      // 在Spring 中启用 Hasor
    @EnableHasorWeb()   // 将 hasor-web 配置到 Spring 环境中，Dataway 的 UI 是通过 hasor-web 提供服务。
    public class DatawayApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(DatawayApplication.class, args);
        }
    
    }

package com.xxxx.dataway;
    
    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.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    import javax.sql.DataSource;
    
    
    @DimModule
    @Component
    public class ExampleModule implements SpringModule { 
    
        @Autowired
        private DataSource dataSource;
    
        @Override
        public void loadModule(ApiBinder apiBinder) throws Throwable { 
            // .DataSource form Spring boot into Hasor
            apiBinder.installModule(new JdbcModule(Level.Full, this.dataSource));
            // .custom DataQL
            //apiBinder.tryCast(QueryApiBinder.class).loadUdfSource(apiBinder.findClass(DimUdfSource.class));
            //apiBinder.tryCast(QueryApiBinder.class).bindFragment("sql", SqlFragment.class);
        }
    }

sql

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70]: /images/20230312/136a20194f7240b684e33000baff8f25.png
[https_www.hasor.net_web_dataway_about.html]: https://www.hasor.net/web/dataway/about.html
[https_www.oschina.net_p_dataway]: https://www.oschina.net/p/dataway
[https_www.hasor.net_web_dataql_what_is_dataql.html]: https://www.hasor.net/web/dataql/what_is_dataql.html
[https_www.hasor.net_web_index.html]: https://www.hasor.net/web/index.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70 1]: /images/20230312/5e52486faa714e92947ff2470cfbe94e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70 2]: /images/20230312/8e0fcaa899e74b759cd4156bf6741f5d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDQ3MzAx_size_16_color_FFFFFF_t_70 3]: /images/20230312/e782d993072341e9ac654c8776255af5.png