概要设计说明书（学习模板）

【智慧学习建设】概要设计说明书智慧学习建设管理系统包含基础信息管理系统，数据字典管理，组织机构管理系统。它根据项目需求规格说明书以及其他前期文档中的功能需求和非功能需求，进行系统的总体设计。此设计说明书从系统详细设计的角度明确了本项目的业务类型、功能范围、业务端系统的接口和业务处理模式，使系统开发人员和产品管理人员能够进一步明确本次项目所开发的产品的功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。a、描述系统产生的背景，包括：b、需开发的软件系统的名称，和英文缩写（可选），项目编号（可选）；c、列出此项目的任务提出者、开发者d、软件系统应用范围、用户。列出本文件中用到的专门术语、术语定义、外文首字母组词的原词组。也可用附件说明。或放到本文件的最后。无描述本文档的主要读者，以及这些读者在阅读时的阅读重点与建议。可用列表的方式列出。如表：预期读者阅读重点项目经理功能完整性，模块设计符合性部门直接领导文件规范性高层领导文件对系统描述的可用性以及价值开发人员功能的实现测试人员功能流程列出有关的参考资料，如：a、本项目经核准的计划任务书或合同、上级机关的批文；b、不属于本项目的其他已发表的文件；c、本文件中各处引用的文件、资料、包括所要用到的软件开发标准；d、列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2.1.1设计约束<包括（1）需求约束。从需求文档（如《用户需求说明书》和《软件需求规格说明书》）中提取需求约束，例如：本系统应当遵循的标准或规范软件、硬件环境（包括运行环境和开发环境）的约束接口/协议的约束用户界面的约束软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。>建设智慧学习建设信息管理系统，以XXX组织和XXX信息为基础，实现XXX组织生活线上线下同步开展，为流动XXX正常参与组织生活提供了可靠、便捷的通道，为上级领导随时随地获取组织生活的落实情况提供完整、有效、准确的信息，督促各组织的组织生活认真贯彻落实；提供XXX费收缴、在线培训、在线互动、在线学习等功能，全面提升XXX的积极性和主动性；提供XXX代表、换届选举、XXX务公开等功能，真实记录XXX代表、换届选举的工作情况，督促XXX代表认真履行自己的工作职责，督促换届选举工作的正常进行。开发原则：1）先进性，系统遵循面向对象技术，组件化技术，便于升级以及扩展；实用性，系统满足学习建设需求原则，注重实用与操作便捷，一切从用户需求出发贴身定做，界面设计美观友好标准性，系统建立有统一的数据接口与规范，实现数据格式的标准化，在信息收集，处理，汇总中建立了统一的数据接口，确保各种信息的录入与利用开放性，系统设计考虑一定的开放性保证各层次之间数据互用实现数据多样化选择安全性，XXX数据极为重要，为保证数据的安全性，其查询，修改等操作必须经过相应的授权才能进行，系统配置用户管理权限专门用于用户角色管理来保证数据的保密与安全，由系统管理员按照用户的管理需求，分配多种级别的权限，相应权限的用户，只能在其允许的范围内，实现数据的检索或维护操作可靠性，智慧学习建设系统承担着XXX信息，XXX费缴纳数据以及上下级信息交互沟通的渠道，所以必须要求系统安全可靠的运行，在系统操作时，将确保在意外故障或重负载情况下的稳定性。要做好数据入库的审核工作，做好数据的备份工作。扩展性，系统软硬件应具有扩充升级的余地，保护以往的投资，能够适应网络及计算机技术的迅猛发展和需求不断变化，使系统中的信息资源具有长期维护使用能力，是系统的升级和维护更加方便，考虑到用户在管理水和信息技术应用水进一步提高之后会对系统的性能和功能提出新的需求，系统建设要充分考虑扩展以便满足发展的需要可移植性，采用J2EE体系系统设计，保障系统能跨不同台进行移植系统设计考虑到有些老XXX未必会习惯使用现代互联网技术，所以有些数据可采用线下操作，再由相应的管理员进行补录，如线下投票选举，缴费2.1.2设计策略<根据产品的需求与发展战略，确定设计策略（DesignStrategy）。例如：扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施。复用策略。说明本系统在当前以及将来的复用策略。折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时－空”效率折衷，复杂性与实用性折衷。>系统开发基于java流行技术架构，技术资源丰富，开发人员也好配备，同时基于java的跨台运行特性，无需专门配备特定的台省掉人力物力，采用流行的权威的架构体系，对于以后扩展升级，技术整合都有着很好的帮助。系统应当采用标准的mvc三层格式，在其他不同的业务逻辑需求开发可直接沿用而不用重新搭建架构系统系统保存有所有XXX的基础数据，存在其他系统需求使用相关数据的可能性，可考虑提取出基础数据自成模块，以标准的形式预留接口提供给其他系统使用2.1.3设计实现<本系统所采用的技术以及该技术的说明>系统后台整体设计采用J2EE技术以及SpringMVC三层架构：J2EE是一套全然不同于传统应用开发的技术架构，包含许多组件，主要可简化且规范应用系统的开发与部署，进而提高可移植性、安全与再用价值；MVC方式的三层架构，保证系统的灵活高效，是一种架构型的模式,本身不引入新功能,只是帮助我们将开发的代码结构,组织的更加合理，1.Model(模型)数据模型,提供要展示的数据2.View(视图)负责进行模型的展示,一般就是我们见到的用户界面3.Controller(控制器)接收用户请求,进行处理SpringMVC是SpringWebMVC的简称，SpringMVC就是Spring框架提供的模块，SpringMVC对MVC流程进行了封装，屏蔽掉很多底层代码，开放出接口，让开发者可以更加轻松快捷的完成基于MVC模式的Web开发;它的核心组件为：DispatcherServlet:前端控制器,用来过滤客户端发送过来,想要进行逻辑处理的请求。

2.Controller/Headler:控制器/处理器。

3.HandlerMapping:处理器映射器。

4.HandlerAdaptor:处理器适配器。

5.ViewResolver:视图解析器。数据库持久层架构Mybatis：是一款优秀的持久层框架，它支持定制化SQL、存储过程以及高级映射。MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。MyBatis可以使用简单的XML或注解来配置和映射原生信息，将接口和Java的POJOs(PlainOrdinaryJavaObject,普通的Java对象)映射成数据库中的记录。Mybatis的功能架构分为三层：1.API接口层：提供给外部使用的接口API，开发人员通过这些本地API来操纵数据库。接口层一接收到调用请求就会调用数据处理层来完成具体的数据处理。2.数据处理层：负责具体的SQL查找、SQL解析、SQL执行和执行结果映射处理等。它主要的目的是根据调用的请求完成一次数据库操作。3.基础支撑层：负责最基础的功能支撑，包括连接管理、事务管理、配置加载和缓存处理，这些都是共用的东西，将他们抽取出来作为最基础的组件。为上层的数据处理层提供最基础的支撑3）前端技术：html/javascript/css/jquery1.html超级文本标记语言，它单纯是用来储存结构化的文本信息，它的编码格式是一个以.html结尾的文件2.CSS：是层叠样式表，英文全称：CascadingStyleSheets，是一种用来表现HTML（标准通用标记语言的一个应用）或XML（标准通用标记语言的一个子集）等文件样式的计算机语言。CSS不仅可以静态地修饰网页，还可以配合各种脚本语言动态地对网页各元素进行格式化。3.JavaScript：JavaScript一种直译式脚本语言，是一种动态类型、弱类型、基于原型的语言，内置支持类型。它的解释器被称为JavaScript引擎，为浏览器的一部分，广泛用于客户端的脚本语言，最早是在HTML网页上使用，用来给HTML网页增加动态功能。4.jQuery是一个快速、简洁的JavaScript框架，是继Prototype之后又一个优秀的JavaScript代码库（或JavaScript框架）。jQuery设计的宗旨是“writeLess，DoMore”，即倡导写更少的代码，做更多的事情。它封装JavaScript常用的功能代码，提供一种简便的JavaScript设计模式，优化HTML文档操作、事件处理、动画设计和Ajax交互。5.Ajax即“Asynchronous

Javascript

And

XML”（异步JavaScript和XML），是指一种创建交互式网页应用的网页开发技术。Ajax=异步

JavaScript

和XML或者是HTML（标准通用标记语言的子集）。Ajax是一种用于创建快速动态网页的技术。Ajax是一种在无需重新加载整个网页的情况下，能够更新部分网页的技术。通过在后台与服务器进行少量数据交换，Ajax可以使网页实现异步更新。这意味着可以在不重新加载整个网页的情况下，对网页的某部分进行更新简要地说明本系统的设计所要达到的目标、愿景。市智慧学习建设着力推进学习建设工作的信息化建设和网络建设，围绕学习建设管理信息化加强纵向业务应用系统的开发建设，同时结合各室的实际业务需求并在许可的条件下，实现系统的横向数据共享或对接，实现全XXX信息资源整合、信息共享和安全高效、有效服务业务的开展，扎实提高组织部门信息化水和业务处理效率。简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。<描述系统的台架构设计，如主机、网络等>说明本系统的总体设计思路和处理流程，尽量使用图表的形式，并辅以必要的文字说明。分析台基于业务数据进行数据映射与融合，整体架构基于大数据分析框架设计，并通过模块化，设计进行内部解耦，将数据收集，导入及分析功能，业务数据收集工作通过异步导入方式实，底层技术实现：前端主要提供：前端主要提供restapi供产品台进行数据获取，中台服务逻辑层springMVC作为应用构建及对外接口发布，持久层主要采用mybatis进行数据存储说明本系统对制作购买或复用的原因分析。用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。具体描述每一功能模块的结构，<对模块1等模块中各子模块之间用功能逻辑图加以说明，并对子模块之间的关系加以说明>功能逻辑图例样：模块的名称定义和需求规格说明书中的功能需求描述中的功能模块名一一对应。可分子目录列分别<对模块1、模块2等模块的功能进行结构，技术实现，逻辑处理说明>。用一览表及框图的形式说明模块性质分类，列出哪些模块需要自主开发，哪些模块可以复用，哪些模块需要采购等。一览表样例如下：模块名称模块实现类型模块一自主开发模块二复用模块三采购…………本条用一张如下的矩阵图说明各项功能需求的实现同各块程序模块的分配关系，本表可用需求跟踪距阵替代：程序1程序2……程序m功能需求1√功能需求2√……功能需求n√√说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。任何一个系统都不可避免地会有一些不足，需要有人不断地对其进行改进，因此才会不断的增加工作量。本系统也不例外，由于时间和数据有限，本系统还有以下不足之处，有待于进一步的改进说明与用户接口的输入输出关系，以及将向用户接口提供的命令和它们的语法结构，以及软件的回答信息。用户输入uasename与password以及其他验证如验证码，前端对password加密传入后台，在后台通过shiro权限管理插件去获取相应的用户登入信息，并解密password判断信息的对等性，如通过则记录用户登入信息，并以json数据形式返回前台说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系、协议要求等。对外接口统一使用http协议，对于需登入接口使用token形式存储用户信息在后台通过shiro权限管理插件去获取相应的用户登入信息，并以json数据形式返回，对于无需登入的信息获取则在后台放开请求连接权限说明本系统之内的各个系统元素（各层模块、子程序、公用程序等）之间的接口的安排，包括设计用关系、输入输出要求、语法结构等。后台返回JSON对象，前台页面对JSON对象进行解析并展示。各模块之间采用函数调用、参数传递、返回值的方式进行信息传递说明界面总体布和风格设计。用户界面：在用户界面部分，根据需求分析的结果，用户需要一个用户友善界面。在界面设计上，应做到简单明了，易于操作，并且要注意带界面的布，应突出的显示重要以及出错信息。总的来说，系统的用户界面应做到可靠性、简单性、易学习和使用可以在本文说明也可以单独使用数据库设计说明书描述（1）需求分析：需求收集和分析，得到用数据字典描述的数据需求，用数据流图描述的处理需求。（2）概念结构设计：对需求进行综合、归纳和抽象，形成一个独立于具体DBMS的概念模型（E-R图）（3）逻辑结构设计：将概念结构转换为某个DBMS所支持的数据模型，并对其进行优化。（4）物理结构设计：为逻辑数据模型选取一个最适合应用环境的物理结构（包括存储结构和存取方法）。（5）数据库实施：运用DBMS提供的数据语言及其宿主语言，根据逻辑设计和物理设计的结构建立数据库，编制与调试应用程序，组织数据入库，并进行试运行。（6）数据库运行和维护:数据库应用系统经过试运行后即可投入正式运行，在数据库系统运行过程中必须不断地对其进行评价、调整与修改。给出系统数据库的设计原则。1、数据库表名命名规范采用26个英文字母(区分大小写)加上下划线'_'组成;命名简洁明确,多个单词用下划线'_'分隔;例如：user_login表前缀'user_'可以有效的把相同关系的表显示在一起;2、数据库表字段名命名规范采用26个英文字母(区分大小写)加上下划线'_'组成;命名简洁明确,多个单词用下划线'_'分隔;例如：user_login表字段user_id,user_name,pass_word,eamil,tickit,status,mobile,add_time;每个表中必须有自增主键,add_time(默认系统时间)表与表之间的相关联字段名称要求尽可能的相同;3、数据库表字段类型规范用尽量少的存储空间来存数一个字段的数据;例如：能使用int就不要使用varchar、char,能用varchar(16)就不要使用varchar(256);IP地址最好使用int类型;固定长度的类型最好使用char,例如：邮编;能使用tinyint就不要使用smallint,int;最好给每个字段一个默认值,最好不能为null;4、数据库表索引规范命名简洁明确,例如：user_login表user_name字段的索引应为user_name_index唯一索引;为每个表创建一个主键索引;为每个表创建合理的索引;建立复合索引请慎重;5、简单熟悉数据库范式第一范式(1NF)：字段值具有原子性,不能再分(所有关系型数据库系统都满足第一范式);例如：姓名字段,其中姓和名是一个整体,如果区分姓和名那么必须设立两个独立字段;第二范式(2NF)：一个表必须有主键,即每行数据都能被唯一的区分;备注：必须先满足第一范式;第三范式(3NF)：一个表中不能包涵其他相关表中非关键字段的信息,即数据表不能有沉余字段;备注：必须先满足第二范式;简单介绍一些数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性。数据库使用mysql5.7版本，MongoDB数据存储类型联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。数据库命名规范采用26个英文字母(区分大小写)和0-9的自然数(经常不需要)加上下划线'_'组成;命名简洁明确(长度不能超过30个字符);例如：user,stat,log,也可以wifi_user,wifi_stat,wifi_log给数据库加个前缀;除非是备份数据库可以加0-9的自然数：user_db_20151210;1.原始单据与实体之间的关系可以是一对一、一对多、多对多的关系。在一般情况下，它们是一对一的关系：即一张原始单据对应且只对应一个实体。在特殊情况下，它们可能是一对多或多对一的关系，即一张原始单证对应多个实体，或多张原始单证对应一个实体。这里的实体可以理解为基本表。明确这种对应关系后，对我们设计录入界面大有好处。2.主键与外键一般而言，一个实体不能既无主键又无外键。在E—R图中,处于叶子部位的实体,可以定义主键，也可以不定义主键(因为它无子孙),但必须要有外键(因为它有父亲)。主键与外键的设计，在全数据库的设计中，占有重要地位。当全数据库的设计完成以后，有个美国数据库设计专家说：“键，到处都是键，除了键之外，什么也没有”，这就是他的数据库设计经验之谈，也反映了他对信息系统核心(数据模型)的高度抽象思想。因为：主键是实体的高度抽象，主键与外键的配对，表示实体之间的连接。3.基本表的性质基本表与中间表、临时表不同，因为它具有如下四个特性：(1)原子性。基本表中的字段是不可再分解的。(2)原始性。基本表中的记录是原始数据（基础数据）的记录。(3)演绎性。由基本表与代码表中的数据，可以派生出所有的输出数据。(4)稳定性。基本表的结构是相对稳定的，表中的记录是要长期保存的。理解基本表的性质后，在设计数据库时，就能将基本表与中间表、临时表区分开来。4.范式标准基本表及其字段之间的关系,应尽量满足第三范式。但是，满足第三范式的数据库设计，往往不是最好的设计。为了提高数据库的运行效率，常常需要降低范式标准：适当增加冗余，达到以空间换时间的目的。数据库设计人员根据需求文档，利用数据建模技术来描述逻辑数据库结构。要求使用PowerDesigner或Visio创建数据库PDM模型。此处只需列出PDM模型名称。描述整个逻辑数据模型是如何被转换为数据文件（物理模式）。文件结构类型在这里应清楚的体现。描述数据库的备份和恢复策略。用一览表的方式说明出错的类型，以及每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。例如：错误分类子项及其编码错误名称错误代码备注数据库错误连接连接超时100001001连接断开100001002数据库本身错误代码数据库本身错误代码100002+数据库错误代码TCP连接错误连接连接超时101001001连接断开101001002其它TCP连接错误(socket自身错误代码)101002+socket错误代码配置信息错误未配置输入参数102001未配置输出参数102002程序在运行时主要会出现两种错误：1、由于输入信息，或无法满足要求时产生的错误，称之为软错误。2、由于其他问题，如网络传输超时等，产生的问题，成为硬错误。对于软错误，须在各项检查判断及输入数据验证模块由数据进行数据分析判断错误类型，再生成相应的错误提示语句，送到输出模块中。对于硬错误，可在出错的相应模块中输出简单的出错语句，并将程序重置。返回输入阶段。出错信息必须给出相应的出错原因说明故障出现后可能采取的变通措施，包括：a．后备技术说明准备采用的后图示技术，当原始系统数据万一丢失