KOP—IDE开发环境模块化需求说明
1. 模块设计背景
基于IED的项目发展和功能扩展,采用模块化的程序构造实现程序设计和开发。基于项目的功能和需求分析,在IDE中实现模块化的基本方式有两种:基于配置文件的模块化系统和基于包管理的模块化系统。
1.1 基于配置文件的模块化系统
(主要公司开发人员对现有功能进行补充和扩展)
基于配置文件的模块化系统先要确定系统中可进行配置的区域模块,在IDE中我们将软件功能分为基本的功能区和工作区。基本功能区主要包含软件的基础构建功能如注册、登录、个人中心、项目管理,工作区根据项目中内容的不同显示不同的内容和操作。根据工作区的不确定性那么主要的配置文件和模块话将集中在工作区。
1.1.1 工作区模块化分析
工作区作为单页的功能页面内,根据工作取的性质,将工作区分为上下两部。
1.1.1.1 头部区域(headarea)
头部区域原则上不做配置用来显示软件Logo、软件名称、当前登录用户信息等内容
1.1.1.2 设计区区域(designarea)
设计区根据项目内容加载相应的子区域内容和操作,根据项目结构默认我们将设计区分为6个子区域:工具栏,左侧区,中间区,右侧区,中下区,状态区。基于可配置的要求我们将每个区域设置部分接口用于配置和操作区域内容。
1.1.1.2.1 工具栏区域(toolbararea)
工具栏用于集中显示对内容区的操作功能。可通过配置文件替换或附加新的功能在工具栏上,并根据工具栏功能按钮特性,状态显示功能,
- 1.1.1.2.1 左侧区(projectarea)
项目管理区用于显示项目内容树形列表。可通过配置文件对项目区右键和树形结构上的节点进行配置。
- 1.1.1.2.1 中间区(editarea)
中间区域用户显示项目内容,可通过配置文件增加新的选项卡以及选项卡内容。并设置区域事件监听,在内容发生更改触发监听事件。
- 1.1.1.2.1 右侧区(propertyarea)
可通过配置文件增加或替换区内容。
- 1.1.1.2.1 中下区(contentarea)
可通过配置文件增加或替换区内容。
1.1.1.2.1 状态区域(statearea) 显示当前区域状体和统计,可通过配置文件附件新的功能在状态区域。
1.1.2 数据 API
1.1.2.1 项目管理API
|接口|说明| |----|----| |添加项目节点|添加项目内容节点| |删除项目内容|删除选中的项目内容|
1.1.2.2 本体数据管理 API
|接口|说明| |----|----| |新建类|在当前打开的本体中新建类| |新建子类|在当前打开的本体中新建子类| |新建属性|在当前打开的本体中新建属性| |新建实例|在当前打开的本体中新建实例| |等等|
1.1.3 模块 API
1.1.4 基本配置文件
系统配置公共配置文件,用户区域划分,区域功能配置等 格式由XML或Json
例如:
<page>
<design>
<toolbararea>
工具栏配置
</toolbararea>
<panle>
<projectarea>
</projectarea>
<editarea>
</editarea>
<propertyarea>
<propertyarea>
</panle>
<statearea>
</statearea>
</desgin>
</page>
1.2 基于包管理的模块化系统
(主要由第三方开发者对产品现有模块进行扩展)
基于包管理的模块化系统主要是由IDE提供一系列接口,和规范(主要用于规范如何接入模块功能),第三方的开发者通过IDE接口生成新的模块并发布到IDE的公共组件库中由其他用户安装扩展空能使用,或者直接上传至之际空间直接在IDE中运行插件。
- 1.2.1 IDE可操作数据接口
- 1.2.2 规范
- 1.2.1 插件管理中心
- 1.2.1 上传插件
- 1.2.1 直接运行插件
- 1.2.1 发布插件至插件库