一、 建设原因及规划
随着业务需求的发展,信息化项目建设越来越复杂,越来越工程化。往往一个项目需要三五家公司、十来个项目组、上百人甚至上千人的规模来建设。而软件工程不同于其他项目,其有且只有一次生产(不像其他产业往往一个设计有多个产品,下次修改设计就可以生产新的型号。而设计只是留在纸上或头脑里的虚拟目标)。软件工程的最终成果就是代码。而目前的建设是设计人员只能梳理整体的框架结构,对于某一点的代码设计往往忽略不计。这就需要各个程序员依据自己的经验知识来控制。其某个很好的实现思路并不能被共享,或共性的相似问题不能统一交流沟通。作为文档存在的描述文件,往往因为上下文环境、需求理解不同而导致学习效果甚微。更有文档缺失等导致项目交接、运维成本提高,新人接手困难,无数次的讲解培训却收效甚微等等问题。
基于上述问题,依据cms系统,搭建一个开发者交流平台。并在此的基础上构建一种代码组合共享方式,采用源码示例、实际使用链接、输入参数描述、输出定义、算法描述等方式详细的描述开发组件的定义、使用规则及构建思路。
在上述基础上,提供系统搭建整体架构组件的说明文章。例如:异常处理机制、spring security二次封装、spring mvc 二次封装等。提高代码架构的构建思路、减少运维、交接、新人培训的成本等等。
二、 建设目标:
系统名称命名为开发组件管理系统,用于开发组件的管理和应用描述,相关应用反馈、需求收集等。达到组件及相关文档统一、系统化的管理、可视化的应用示例,向下兼容的升级模式。采用cms的基本概念和原理,以组件可视化开发为应用实例,搭建该系统。
其主要功能是:
通过结构化的方式描述开发组件,发布动态代码页面。
通过组件的方式实现cms基本功能,把组件的应用开发方式直观的描述出来。
随着开发组件的越来越丰富,功能越来越全面。可以实现页面系统开发完全配置化实现,从而减少开发工作量。
三、 系统需求分析
信息发布系统(cms):用cms平台作为开发组件发布、管理的平台。在cms系统中加入开发组件模版、架构模版的概念,用于规定上述问题的处理方案。
其具体功能为:
文章发布系统:发布信息并共享、供用户提出需求建议、应用反馈等功能。
模版管理系统:用于用户自定义模版、管理模版等。
示例部署系统:示例的热部署应用。
四、 页面设计
首页(着重处理)
发布文章页面(着重处理)
发布模版(后期处理)
保存:进行数据保存处理。
发布:生产相应源码和文件。成功后直接显示发布的文件。
五、 一期目标工作
1、数据库表格设计
2、公共服务处理:
保存
发布生成源码jsp文件。
图片服务上传图片(用于页面显示的)。
附件管理 上传提供一个服务,下载提供两个(一个是不受保护的,另一个是受保护的)。
附件下载列表组件
评论显示组件 查询内容对应的评论并显示处理(分页处理,分页采用ajax处理)
评论保存组件
html编辑器组件前期编辑文档引入图片显示就可以。