1.简介
来自官网的描述：
- 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 整合起来。
2.使用
2.1 依赖
SpringBoot版本：2.5.0 【这里只贴出主要的依赖】
<!--hasor核心依赖--> <dependency> <groupId>net.hasor</groupId> <artifactId>hasor-spring</artifactId> <version>4.2.5</version> </dependency> <dependency> <groupId>net.hasor</groupId> <artifactId>hasor-dataway</artifactId> <version>4.2.5</version> </dependency> <!--p6spy 打印执行的SQL语句--> <dependency> <groupId>com.github.gavlyukovskiy</groupId> <artifactId>p6spy-spring-boot-starter</artifactId> <version>1.7.1</version> </dependency> <!--数据库相关--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>org.postgresql</groupId> <artifactId>postgresql</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>com.jdbc</groupId> <artifactId>greenplum</artifactId> <version>5.1.4</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.10</version> </dependency>
2.2 配置
【问题一】：接口显示的中文乱码。
【解决一】：配置servlet.encoding.charset和servlet.encoding.force
server: port: 8088 servlet: encoding: charset: utf-8 force: true spring: application: name: dataWay-demo # 数据源配置 datasource: url: jdbc:pivotal:greenplum://xxx.xx.xxx.xxx:2345;DatabaseName=gpdb username: gpadmin password: gpadmin driver-class-name: com.pivotal.jdbc.GreenplumDriver type: com.alibaba.druid.pool.DruidDataSource druid: initial-size: 3 min-idle: 3 max-active: 10 max-wait: 60000 stat-view-servlet: login-username: admin login-password: admin # p6spy配置 decorator: datasource: p6spy: logging: slf4j log-file: syp.log log-format: executionTime:%(executionTime) | sql:%(sqlSingleLine) # dataWay核心配置 # 启用 Dataway 功能（默认不启用） HASOR_DATAQL_DATAWAY: true # 开启 ui 管理功能（注意生产环境必须要设置为 false，否则会造成严重的生产安全事故） HASOR_DATAQL_DATAWAY_ADMIN: true # （可选）API工作路径 HASOR_DATAQL_DATAWAY_API_URL: /api/ # （可选）ui 的工作路径，只有开启 ui 管理功能后才有效 HASOR_DATAQL_DATAWAY_UI_URL: /interface-ui/
2.3 数据初始化
以下是MySQL数据库的初始化SQL：
CREATE TABLE interface_info ( api_id varchar(64) NOT NULL COMMENT 'ID', api_method varchar(12) NOT NULL COMMENT 'HttpMethod：GET、PUT、POST', api_path varchar(512) NOT NULL COMMENT '拦截路径', api_status varchar(4) NOT NULL COMMENT '状态：-1-删除, 0-草稿，1-发布，2-有变更，3-禁用', api_comment varchar(255) NOT NULL COMMENT '注释', api_type varchar(24) NOT NULL COMMENT '脚本类型：SQL、DataQL', api_script mediumtext NOT NULL COMMENT '查询脚本：xxxxxxx', api_schema mediumtext NOT NULL COMMENT '接口的请求/响应数据结构', api_sample mediumtext NOT NULL COMMENT '请求/响应/请求头样本数据', api_option mediumtext NOT NULL COMMENT '扩展配置信息', api_create_time varchar(32) NOT NULL COMMENT '创建时间', api_gmt_time varchar(32) NOT NULL COMMENT '修改时间', PRIMARY KEY (api_id), UNIQUE KEY uk_interface_info (api_path) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='Dataway 中的API'; CREATE TABLE interface_release ( pub_id varchar(64) NOT NULL COMMENT 'Publish ID', pub_api_id varchar(64) 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 varchar(4) NOT NULL COMMENT '状态：-1-删除, 0-草稿，1-发布，2-有变更，3-禁用', pub_comment varchar(255) NOT NULL COMMENT '注释', 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 NOT NULL COMMENT '接口的请求/响应数据结构', pub_sample mediumtext NOT NULL COMMENT '请求/响应/请求头样本数据', pub_option mediumtext NOT NULL COMMENT '扩展配置信息', pub_release_time varchar(32) NOT NULL COMMENT '发布时间（下线不更新）', PRIMARY KEY (pub_id), KEY idx_interface_release_api (pub_api_id), KEY idx_interface_release_path (pub_path) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='Dataway API 发布历史。'; create index idx_interface_release on interface_release (pub_api_id);
【问题二】：> 1071 - Specified key was too long; max key length is 767 bytes
【解决二】：解决：调整相应字段的长度。也可以参考这篇 博文 解决问题。
这里再提供一下GreenPlum数据库的初始化SQL：
CREATE TABLE interface_info ( api_id VARCHAR ( 64 ) NOT NULL CONSTRAINT pk_interface_info PRIMARY KEY, api_method VARCHAR ( 12 ) NOT NULL, api_path VARCHAR ( 512 ) NOT NULL, api_status VARCHAR ( 4 ) NOT NULL, api_comment VARCHAR ( 255 ) NOT NULL, api_type VARCHAR ( 24 ) NOT NULL, api_script TEXT NOT NULL, api_schema TEXT NOT NULL, api_sample TEXT NOT NULL, api_option TEXT NOT NULL, api_create_time VARCHAR ( 32 ) NOT NULL, api_gmt_time VARCHAR ( 32 ) NOT NULL ) DISTRIBUTED BY ( api_id ); CREATE UNIQUE INDEX uk_interface_info ON interface_info ( api_id, api_path ); COMMENT ON TABLE interface_info IS 'Dataway 中的API'; COMMENT ON COLUMN interface_info.api_id IS 'ID'; COMMENT ON COLUMN interface_info.api_method IS 'HttpMethod：GET、PUT、POST'; COMMENT ON COLUMN interface_info.api_path IS '拦截路径'; COMMENT ON COLUMN interface_info.api_status IS '状态：-1-删除, 0-草稿，1-发布，2-有变更，3-禁用'; COMMENT ON COLUMN interface_info.api_comment IS '注释'; COMMENT ON COLUMN interface_info.api_type IS '脚本类型：SQL、DataQL'; COMMENT ON COLUMN interface_info.api_script IS '查询脚本：xxxxxxx'; COMMENT ON COLUMN interface_info.api_schema IS '接口的请求/响应数据结构'; COMMENT ON COLUMN interface_info.api_sample IS '请求/响应/请求头样本数据'; COMMENT ON COLUMN interface_info.api_option IS '扩展配置信息'; COMMENT ON COLUMN interface_info.api_create_time IS '创建时间'; COMMENT ON COLUMN interface_info.api_gmt_time IS '修改时间'; CREATE TABLE interface_release ( pub_id VARCHAR ( 64 ) NOT NULL CONSTRAINT pk_interface_release PRIMARY KEY, pub_api_id VARCHAR ( 64 ) NOT NULL, pub_method VARCHAR ( 12 ) NOT NULL, pub_path VARCHAR ( 512 ) NOT NULL, pub_status VARCHAR ( 4 ) NOT NULL, pub_comment VARCHAR ( 255 ) NOT NULL, pub_type VARCHAR ( 24 ) NOT NULL, pub_script TEXT NOT NULL, pub_script_ori TEXT NOT NULL, pub_schema TEXT NOT NULL, pub_sample TEXT NOT NULL, pub_option TEXT NOT NULL, pub_release_time VARCHAR ( 32 ) NOT NULL ) DISTRIBUTED BY ( pub_id ); COMMENT ON TABLE interface_release IS 'Dataway API 发布记录'; COMMENT ON COLUMN interface_release.pub_id IS 'Publish ID'; COMMENT ON COLUMN interface_release.pub_api_id IS '所属API ID'; COMMENT ON COLUMN interface_release.pub_method IS 'HttpMethod：GET、PUT、POST'; COMMENT ON COLUMN interface_release.pub_path IS '拦截路径'; COMMENT ON COLUMN interface_release.pub_status IS '状态：-1-删除, 0-草稿，1-发布，2-有变更，3-禁用'; COMMENT ON COLUMN interface_release.pub_comment IS '注释'; COMMENT ON COLUMN interface_release.pub_type IS '脚本类型：SQL、DataQL'; COMMENT ON COLUMN interface_release.pub_script IS '查询脚本：xxxxxxx'; COMMENT ON COLUMN interface_release.pub_script_ori IS '原始查询脚本，仅当类型为SQL时不同'; COMMENT ON COLUMN interface_release.pub_schema IS '接口的请求/响应数据结构'; COMMENT ON COLUMN interface_release.pub_sample IS '请求/响应/请求头样本数据'; COMMENT ON COLUMN interface_release.pub_option IS '扩展配置信息'; COMMENT ON COLUMN interface_release.pub_release_time IS '发布时间（下线不更新）'; CREATE INDEX idx_interface_release_api ON interface_release ( pub_api_id ); CREATE INDEX idx_interface_release_path ON interface_release ( pub_path );
2.4 数据源初始化
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 { apiBinder.installModule(new JdbcModule(Level.Full, this.dataSource)); } }
2.5 启动类添加注解
两个注解 @EnableHasor() 和 @EnableHasorWeb()
@EnableHasor() @EnableHasorWeb() @SpringBootApplication(scanBasePackages = { "net.example.hasor" }) public class ExampleApplication { public static void main(String[] args) { SpringApplication.run(ExampleApplication.class, args); } }
应用在启动过程中会看到 Hasor Boot 的欢迎信息。
3.测试
根据配置的 ui 工作路径 http://localhost:8088/interface-ui/ 访问前端，账号密码均为 admin：
页面简单说明【大家用一下就会了】：
Dataway 提供了2中语言模式，可以使用强大的 DataQL 查询语言，也可以直接使用 SQL 语言（在 Dataway 内部 SQL 语言也会被转换为 DataQL 的形式执行。）添加一个DataQL并测试：
这里只是简单入门，接口开发要结合业务进行定制，Dataway的应用场景也要考虑好，DataQL及SQL相关开发具体可查看官方文档【DataQL 聚合查询引擎 SQL执行器】
最后放几个有用的连接：
