data-factory
介绍
为大规模微服务构建而创建的业务模拟数据生成平台,属于天画项目中的基础产品。本项目依托于API管理和领域模型管理对
数据模拟和数据mock功能做深度实现和扩展。力图提供一个通用的数据构建和使用平台,本项目也顺带实现了API管理,模型管理的功能。
所以在此项目中进行集中管理比较有利于发挥企业数据模型的价值,为研发效能和企业提供一定竞争力。
适用于如下场景:
- 支持API First 理念,提供web界面和plantUML导入的方式管理API(HTTP,REST,DUBBO)
- 提供业务领域模型驱动,数据表结构模型驱动管理可视化功能(plantUML,web界面)
- 平台对各个相关服务领域的数据源进行聚合,同时基于业务模型帮助构建大规模大数据量的仿真业务数据。
- 在分布式微服务等架构落地的同时提供真正的高并发大数据量的实战数据环境
- 基于前后端接口数据协议进行数据mock,包括返回值和入参模型
- 基于业务数据模型构建大数据平台所需的大量仿真数据
- 在线接口调试,将构建的数据直接与微服务的接口进行绑定调试
- 为测试平台提供mock数据,比如联调期间mock下游依赖或者写单元测试的时候动态mock下游依赖
软件架构-1.0
- 功能架构图
- 数据模型图
- 应用流程图
- 部署架构图
- 应用架构图
软件架构-2.0
- 技术架构
- 应用架构
安装教程(2.0)
- 克隆本项目到工作空间
- 通过doc/sql/datafactory-db2.0.sql 文件中的sql脚本初始化
- 克隆https://gitee.com/codergit.com/javautils 工具类,并install coderman-utils(1.0.5版本)
- 修改start-local项目中的application.properties的数据库链接配置
- 后端项目启动: start-local Application springboot应用
- 前端项目启动(需要安装nodejs): 在cmd或者终端下到/webmanager目录,输入node server启动前端,访问链接:http://localhost:3000
界面展示
-
首页
-
API界面
-
业务模型管理
-
表模型管理
-
数据源管理
-
接口出参mock
-
模型后缀配置
重点api(2.0)
- 前后端接口联调时接口的数据mock返回: http://localhost:8090/apimock?apiSign=&successData=
- api接口入参mock: http://localhost:8090/api/reqmock
- api接口出参mock: http://localhost:8090/api/respmock
内置数据源列表(2.0)
BankFunction
银行卡号生成
CardNumberFunction
身份证号生成
PinYinFunction
汉字转拼音,提取首字母
RandomNumFunc
随机N位整数
RandomFloatFunc/RandomDoubleFunc
随机浮点数
TelPhoneFunc
电话
TelPhoneFunc
邮箱
ChineseNameFunc
中文姓名(内置数据文件)
PassWordFunction
随机N位密码
UUidFunc
uuid
SnowflakeIdFunc
snowflakeId
CurrentTimeFunc
当前时间戳
DateFunc
日期(年月日)
DateTimeFunc
时间(年月日 时分秒)
CommentFunc
一段评论(内置数据文件)
OneEnWordFunc
随机英文名单词(内置数据文件)
函数式客户端开发架构
函数服务设计
将内置函数实现与内置随机数据文件迁移到client工程,core工程只通过接口依赖client端函数和实现
因此core的迭代和开发不受随机函数的迭代开发影响。随机函数在客户端可以通过下面的步骤进行开发并可快速集成到core中
client端无需感知core端变化,因此服务设计上更加灵活。同时通过接口和门面模式将client与core进行隔离,达到高内聚低耦合的特性。
二次开发场景
这里的开发场景有三种,方便集成不同场景形态的数据源内容
-
针对于内置函数
类似于随机数,时间函数等都相当于无中生有的数据内容。二次开发步骤如下:
- 定义数据源编码
- 实现client模块中的Function接口
- 通过web页面注册到数据源中
-
针对于文件类的内置函数
类似于中国的百家姓和名称,通过数据文件提供数据源。二次开发步骤如下:
- 定义数据源编码,文件名
- 实现client模块中的Function接口
- 实现InnerParseService接口解析文件内容
- 通过web页面注册到数据源中
-
把指定的文件当做一种数据源,按照一定格式解析后可以被使用
此类场景适用于文件是多个属性的,类似于特定的数据集,目前没完全开发完。
版本发布
1.0.0-SNAPSHOT
本次发版为基本雏形版本,内容:
- 数据源增删改查
- 内置多个基本随机数据函数
- 初步工程架构定型(api依赖core,core依赖client)
- 内部核心模块解耦,方便二次开发
- 生成随机数据的核心功能完成
- 生成数据的依赖数据源全面打通(自定义数据源,NACOS,内置数据源,spring boot api)
2.0.0-SNAPSHOT
本次发版在1.0的基础上进行全面升级,主要内容如下:
- 支持将dubbo 查询api作为数据源接入
- 支持将springboot,cloud数据源接入
- 代码重构,支持复杂数据模型和大批量数据生成
- 基于百度Amis前端低代码框架,增加可视化管理界面
- 支持自定义数据集加载(数据加载,数据属性绑定,大文件映射,excel加载,txt加载,json加载)
- 调整工程模块,适应项目需求
- 管理api模型,领域模型,数据库模型,数据库表字段,实现生命周期全管理
- 使用field DSL Rule支持复杂对象参数和模型,返回结果的构建
- 实现http接口,dubbo接口,service方法的返回参数和入参模型的数据mock
- 相对1.0版本来说增加了几个常用的内置数据源
- 支持复杂对象关联数据生成
参与贡献
- Fork 本仓库
- 新建 Feat_xxx 分支
- 提交代码
- 新建 Pull Request
特技
- 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
- Gitee 官方博客 blog.gitee.com
- 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
-
GVP 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
- Gitee 官方提供的使用手册 https://gitee.com/help
- Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/