JAVA框架需求规格说明书

JAVA框架需求规格说明书Ver1.0 需求规格说明书项目名称:项目编号:第4页共18页修改记录修订号：作者：日期:简要说明：目录1. 项目概述 51.1. 目标 51.2. 项目范围 52. 需求说明 52.1. 功能权限 52.1.1. 用户管理 52.1.1.1. 用户注册 62.1.1.2. 添加用户 62.1.1.3. 删除用户 62.1.1.4. 修改用户 62.1.1.5. 分配用户组 62.1.1.6. 分配角色 62.1.1.7. 设置所属机构 62.1.1.8. 查询用户 62.1.2. 角色管理 62.1.2.1. 添加角色 72.1.2.2. 修改角色 72.1.2.3. 删除角色 72.1.2.4. 分配用户 72.1.2.5. 设置权限 72.1.2.6. 角色查询 72.1.3. 用户组管理 72.1.3.1. 添加用户组 72.1.3.2. 修改用户组 72.1.3.3. 删除用户组 82.1.3.4. 设置角色 82.1.3.5. 分配用户 82.1.4. 菜单权限管理 82.1.4.1. 树形菜单展示 82.1.4.2. 添加菜单 82.1.4.3. 编辑菜单 82.1.4.4. 删除菜单 82.1.4.5. 功能权限管理 82.1.5. 功能权限管理 92.1.5.1. 添加功能 92.1.5.2. 修改功能 92.1.5.3. 删除功能 92.1.5.4. 功能列表 92.1.5.5. 设置角色 92.1.6. 组织机构管理 92.1.6.1. 树形展示 92.1.6.2. 添加机构 92.1.6.3. 修改结构 102.1.6.4. 删除机构 102.1.6.5. 管理用户 102.2. 日志管理 102.2.1. 用户登录日志 102.2.2. 数据对象操作监控日志 103. 非功能性需求 113.1. 性能要求 113.2. 安全性要求 113.3. 系统友好性 123.4. 扩展性 133.5. 可实现性 133.6. 支持主流浏览器 134. 集成和接口 134.1. 外部接口 134.2. 内部接口 144.3. 硬件接口 144.4. 通信接口 145. 约束和限制条件 145.1. 约束性条件 145.2. 限制性条件 146. 运行环境需求 146.1. 硬件需求 146.2. 第三方软件需求 156.3. 网络需求 156.4. 可维护性 156.5. 可转移/转换性 156.6. 警告 166.7. 其他需求 166.8. 数据库 166.9. 操作 166.10. 场合适应性需求 177. 附录 17PAGE第13页共18页项目概述目标完善丰富框架公共基础功能；搭建开发平台，提供功能更加完备的开发工具，细化开发规范；构建运维平台，提供数据分析、运行监控、数据安全等基础服务；扩展运行平台，为项目提供统一权限、流程引擎、服务调度、规则管理等公共组件。项目范围数据库数据库主框架合作伙伴第三方系统应用服务器监控平台基础架构/服务总线灾备方案安全方案部署方案移动应用商业智能企业门户工作流消息服务规则引擎统计报表硬件接口可视建模定制界面增量生成维护平台运行平台开发平台外部应用与合作伙伴WebServices需求说明功能权限用户管理用户注册提供统一的用户注册界面，需要输入邮箱和密码，并通过邮箱验证后注册成功。添加用户添加新用户，需保存邮箱、密码、是否有效等基本信息。删除用户逻辑删除用户数据，数据状态置为已删除，用户同时失效。修改用户管理员可以从后台修改用户基本信息、状态、密码等内容，当状态置为无效时不能登录。分配用户组为用户设置所属用户组，一个用户可以归属多个用户组，用户组以列表形式展示。分配角色为用户设置所属用户组，一个用户可以归属多个角色，角色以列表形式展示。设置所属机构为用户设置所属机构，机构以属性结构展示，已归属的应该有标识。查询用户按用户名、姓名、邮箱、状态、机构、角色、用户组等信息筛选用户，展示用户基础信息、角色信息、所属机构、用户组等信息。角色管理添加角色新增角色，填写角色名称、描述、状态、是否默认角色等。如果设置为默认角色，则系统所有用户默认拥有此角色的所有功能。修改角色修改角色基本信息，包括角色名称、描述、状态等。删除角色逻辑删除角色信息，状态置为已删除。分配用户为角色批量分配用户。统一使用用户选择器设置。设置权限为角色设置系统权限。系统权限包括菜单和功能。角色查询根据角色名称、状态筛选角色信息。用户组管理添加用户组新增用户组，填写名称、描述、状态等。修改用户组修改用户组，填写名称、描述、状态等。删除用户组逻辑删除用户组信息，状态置为已删除。设置角色为用户组设置拥有的角色。分配用户为用户组批量添加用户。菜单权限管理树形菜单展示以树形结构展现菜单，右键菜单节点，显示添加子节点、删除、刷新功能，点击菜单节点，显示菜单编辑页面以及下级节点的排序界面。添加菜单新增菜单，填写中文名称、英文名称、样式图标、URL、描述、状态等信息。一级菜单还应具有“左侧菜单样式”、“默认打开页面”两个属性，供页面自定义使用。编辑菜单编辑菜单信息。删除菜单逻辑删除菜单信息，状态置为已删除。功能权限管理管理该菜单节点拥有的功能操作。可以从该界面添加、修改、删除该菜单节点的功能操作。包括功能名称、操作链接、状态等信息。功能权限管理添加功能为菜单添加功能操作，填写中英文名称、URL、状态等信息。修改功能修改功能信息。删除功能逻辑删除功能操作，状态置为已删除。功能列表以列表方式展示所有系统功能，需要显示其所属菜单、URL等信息。设置角色为功能设置角色。组织机构管理树形展示以树形结构展示组织机构，右键显示增加节点、删除节点、刷新等功能，单击查看并可编辑机构详情，并显示该机构下的用户列表，可以添加和删除新用户。添加机构新增机构，填写机构编码、名称、简称、类型、状态等信息。修改结构修改机构信息。删除机构逻辑删除机构信息，状态置为已删除。管理用户添加和删除机构下的用户，并为该机构下的用户排序。日志管理对系统日志进行统一记录和管理。用户登录日志详细记录用户登录信息，包括登录成功或失败状态、登录成功的登录时间、用户ID、IP地址、用户浏览器、操作系统、登出时间等。可以按照以上信息筛选登录日志。定期删除1年前登录日志。数据对象操作监控日志详细记录数据库对象的操作记录。输入名称字段类型输入源精度是否必填有效值备注类别代码字符系统赋予50类别名称字符手动输入50是类别说明字符手动输入200否加工输入数据的有效性检查：存储前对客户类别的编码进行排重确认；操作的顺序：删除前确认该客户类别未被使用；响应：对于删除已经使用的客户类别，向用户发出错误提醒；受操作影响的参数：无；降级运行的要求：无；算法：无；输出数据的有效性检查：无。输出客户类别列表。名称字段类型输出目标精度非法值类别代码字符系统页面50类别名称字符系统页面50非功能性需求性能要求本系统主体要求使用B/S架构，在专网环境下运行，要求安全稳定运行；检测客户端是基于C语言开发的单机版系统，要求稳定运行。主体系统并发要求：在专网环境下，≤200（生产环境下），最高并发情况下，页面请求最大响应时间不超过8秒；支持2000用户的在线用户峰值；系统的对外接口，需要满足各系统间信息交换峰值的压力，具体压力值在设计阶段中评估；软件可用性99%，即年度停机时间小于87.6小时（功能升级除外）；服务端接口必须经过压力测试和疲劳测试。安全性要求用户安全用户由系统管理人员授权操作权限，控制操作安全；密码安全，用户密码采用MD5码算法加密存储并要求包含英文和数字，长度大于等与8位；数据安全用户间只能访问具有访问权限的业务数据；用户操作的业务数据保存到内网数据库中；存储安全。对数据库进行定期备份，要求每周1次全数据库备份，每天进行增量备份，便于数据库故障时能迅速恢复；对非结构化文件，要求每月一次全量备份，每天增量备份；至少同时存在两份连接周期内的全量备份数据，连接三个月以内的增量备份数据。安全日志通过数据库日志及审计功能，发现数据操作安全漏洞；系统中建立用户操作的业务日志表，记录用户登录ID、登录IP、登录时间，及其在系统中所作的增删改操作。操作安全在每个模块对重要数据项进行验证，用户删除数据时，警告提醒。系统试用前要经过安全漏洞扫描，安全漏洞方面可借鉴公司保存的信息技术处反馈的其他系统的安全漏洞信息。系统友好性系统友好性直接影响用户对系统的使用感受，具体包括：易理解性：通过合理的功能划分和在交互界面中使用专业用语，使用户能够快速理解并掌握系统的功能。易操作性：减少用户操作所消耗的时间。扩展性不断满足后续的功能需求：在系统的使用过程，随着应用的不断深入，用户新的需求也会不断呈现出来；另一方面随着业务发展和变化，必须在现有系统基础上进行扩展和完善，系统能够根据变化调整系统功能以适应新的需求。对性能和安全性的扩展要求：初期系统使用人数比较少的时候，对系统性能的要求也相应比较低。但随着并发用户数的增多如果性能不能满足，不仅仅影响系统的访问速度，同时也会导致系统出错和运行不稳定。而随着系统重要性的提升，对系统安全也必然提出更高的要求。良好集成性的扩展要求：良好的集成性是系统扩展性的另外一个方面的体现，是延长系统使用生命周期和提高工作效率的基本要求。可实现性除与xxx相关的功能之外的系统通过自主开发的方式实现，其中的关键技术在xxx中有过初步探索并取得了较为满意的结果；xxx相关功能在公司外部存在具有成熟开发经验和实施经验的团队能够支持系统功能的实现。支持主流浏览器系统编码过程中应根据各浏览器特点，避免出现浏览器不兼容，同时要求在IE6、IE8、IE9、FireFox，等主流浏览器测试。集成和接口外部接口MACROBUTTONTableDeleteTable双击此处添加清晰详细地说明了系统与其他系统交互信息或数据的要求。建议通过UML或结构化图表形式进行说明。内部接口略硬件接口无通信接口无约束和限制条件MACROBUTTONTableDeleteTable双击此处添加设计约束受其他标准、硬件限制等方面的影响。约束性条件MACROBUTTONTableDeleteTable双击此处添加完整描述了需求实现的约束性条件，如环境和人力资源等的合理的约束性条件。限制性条件MACROBUTTONTableDeleteTable双击此处添加完整描述了需求实现的限制性条件，如业务需求的合理前提条件。运行环境需求硬件需求MACROBUTTONTableDeleteTable双击此处添加随着业务发展，会出现新的业务功能需求，需求分析应考虑到在现有业务功能和软硬件环境基础上进行软件定制扩展和开发的可能性。第三方软件需求MACROBUTTONTableDeleteTable双击此处添加应用服务器，数据库服务器的类型和版本等。网络需求MACROBUTTONTableDeleteTable双击此处添加描述网络带宽，稳定性等需求。可维护性MACROBUTTONTableDeleteTable双击此处添加规定若干需求以确保软件是可维护的。例如：软件模块所需要的特殊的耦合矩阵；为微型装置指定特殊的数据＼程序分割要求。可转移/转换性MACROBUTTONTableDeleteTable双击此处添加规定把软件从一种环境移植到另一种环境所要求的用户程序，用户接口兼容方面的约束等等。警告MACROBUTTONTableDeleteTable双击此处添加指定所需属性十分重要，它使得人们能用规定的方法去进行客观的验证。其他需求MACROBUTTONTableDeleteTable双击此处添加根据软件和用户组织的特性等，某些需求放在下面各项中描述。数据库MACROBUTTONTableDeleteTable双击此处添加本项对作为产品的一部分进行开发的数据库规定一些需求，它们可能包括：在功能需求中标识的信息类别；使用的频率；存取能力；数据元素和文卷描述符；数据元素、记录和文卷的关系；静态和动态的组织；数据保存要求。注：如果使用一个现有的数据库包，这个包应在“软件接口”中命名，并在那里详细说明其用法。操作MACROBUTTONTableDeleteTable双击此处添加这里说明用户要求的常规的和特殊的操作。在用户组织之中各种方式的操作。例如，用户初始化操作；交互作用操作的周期和无人操作的周期；数据处理运行功能；后援和恢复操作。注：这里的内容有时是用户接口的一部分。场合适应性需求MACROBUTTONTableDeleteTable双击此处添加这里包括：对给定场合或相关任务或操作方式的任何数据或初始化顺序的需求进行定义。例