数据接口服务系统方案设计.docx

数据接口服务系统方案设计 描述系统的应用、数据和技术等设计。 整体架构 整体上，从业务、应用、数据和技术层，形成总体架构如下： 技术设计方面，采用如下技术集合，用来支持各个功能的设计和实现。一些主要的技术会在后续技术框架章节中做展开描述。 我们选型技术最根本的理念是继承于Unix，每项技术或工具只做一件事，但做到最好。 本系统是典型的Web应用，主要遵从传统的浏览器/服务端的分层结构，一般分为界面展示层、应用服务层和存储持久层，采用主流的开发语言及基于此的成熟开发框架。框架中归集主流的技术，也会涉及到具体的产品列示，作为技术备选或参照，不一定就是必选。 后端主要开发和构建技术采用Java体系的Spring生态，主要基于SpringMVC/SpringBoot/SpringCloud几个体系。基本页面视图采用beetle的模板技术，数据持久层采用MyBatis，可配置式地连接后台主流结构化或非关系型的数据库，并且通过MyBatis技术进行原始SQL的封装，作为服务生成和调用的中间介质，应用层可以采用容器技术和基于SpringCloud的微服务技术，配合nacos做微服务的底层网关与服务自动化发现和调度，采用Maven进行后端自动化构建。 界面展示层属于前端技术领域，主要选型HTML5/CSS3，JavaScript（ES6），Bootstrap等最基本页面技术，适当采用TypeScript等更规范的Javascript编写，融入React的虚拟化DOM生态，并选型统一设计的现代化组件库（比如Fusion），采用node和webpack等做分离，进行前端页面的独立开发、测试和自动化构建。 应用服务层属于中间业务逻辑和响应处理，采用如Tomcat等Web服务，也可能会涉及一些专属的应用服务，来处理特殊语言或者性能。配合SpringCloud的微服务体系，底层采用Nacos作为网关、路由和服务发现、自动化注册、微服务提供等主要选型。 存储持久层属于后台数据服务的处理，主流关系型数据库可以采用Oracle、MySQL,非关系型的Spark SQL与HIVE等，MyBatis和ORM等框架负责持久层的模型解析。 功能设计 功能规划 通过时间轴主线的梳理，系统包含了数据服务需求处理、数据可视建模，SQL脚本生成，SQL代码编辑，数据接口服务生成，数据接口服务注册，数据接口服务维护，数据接口服务监控，也包含数据应用的配套、日常或常规工作。主要有：模板管理、组织人员、权限控制等。 对功能模块做出统一规划，作为未来主要的菜单或界面挂接依据，对功能的优先程度和复杂程度做出评估，利于指导具体的开发策略。 模块命名做简要规范，在符合客户需求的原始命名基础之上，一般具备动词，一级模块动词在后面，形成主谓结构，二级模块动词一般在前面，形成动宾结构。允许有例外。 系统大类 功能分类 模块 描述 业务大类 可视数据建模 模型资产查询 　 建模模板维护 　 建模模板查询 　 建模模板预览 　 数据源配置维护 　 数据源配置查询 　 读取元数据接口 　 建模画板 　 数据源对象导航 　 图例面板 　 对象选取 　 自动布局 　 缩放 缩略图 对象属性调整 　 复制、剪切、移除或粘贴 　 手动模型实体关系关联 　 自动模型实体关系关联 　 字段函数、计算列和过滤条件 　 建模历史操作回退 　 模型资产维护 　 　 SQL脚本生成 解析SQL脚本 　 数据预览 　 　 　 　 　 SQL代码编辑 SQL代码查询 　 SQL模板查询 　 SQL模板预览 　 SQL代码编辑窗 　 自动格式化 　 语法高亮 　 智能语法语义联想 　 语法检查提示 　 一般文本编辑 　 代码历史操作回退 　 　 　 数据接口服务生成 数据接口服务生成 　 　 　 数据接口服务注册 数据接口服务注册 　 　 　 数据接口服务维护 数据接口服务查询 　 数据接口服务详情查看 　 数据接口服务维护 　 数据接口服务退役 　 数据接口调用 　 数据接口版本管理 　 数据接口日志管理 　 　 　 数据接口服务监控 数据接口服务监控（总体） 　 数据接口服务监控（详细） 　 数据接口服务预警 　 数据接口服务历史追溯 　 小计 管理大类 系统管理 用户管理 　 组织管理 　 角色管理 　 菜单管理 审计日志 　 系统监控 　 总体和配套 总体导航 　 总览 　 全局检索 　 用户登录、注销、维护 　 　 小计 接口大类 接口消费 数据资产接口 　 权限配置中心接口 　 统一认证接口 　 　 接口提供 数据服务 　 API元数据 　 运维统计数据 　 　 功能规划以组件理念，考虑高内聚和低耦合，对于业务需求的支持有映射关系。 应用架构设计 采用现在主流的前后端分离技术，在逻辑上分为视图层、控制