软件产品规格说明

CDIOCDIO 实践报告之实践报告之五五 软件产品规格说明软件产品规格说明 （根据国标GB/T 8567-2006 计算机软件文档编制规范撰写） 项 目 名 称 ： 校内易书系统 项 目负责人 ： 熊方翼 报 告 主 编 ： 专 业 ： 软件工程 任 课 教 师 ： 李彤 CDIO 指导教师： 李彤 编 制 时 间 ： 2012 年 12 月 云南大学软件学院云南大学软件学院 20122012 年年 1212 月制表月制表 目录目录 1 引言.2 1.1 标识.2 1.2 系统概述.2 1.3 文档概述.2 2 引用文件.3 3 需求.3 3.1 可执行软件.3 3.2 源文件.3 3.3 打包需求.3 4 合格性规定.3 5 软件支持信息.4 5.1“已建成”软件设计.4 5.2 编译/建立过程.5 5.3 修改过程.7 5.4 计算机硬件资源使用.8 6 需求的可追踪性.9 7 注解.14 1 引言引言 1.1 标识标识 本文档使用与校内易书系统。 系统标识号：CDIO-校内易书系统-1.0。 标题：校内易书系统。 缩略词语：无。 版本号：1.0。 标识号：1.0。 1.2 系统概述系统概述 本文档适用于校内易书系统。 校内易书系统的用户为普通用户和管理员。普通用户课利用该系统进行用户注册，个 人资料管理，图书检索，发布书籍转让信息，发布书籍需求信息，图书交易等活动。而管 理员主要进行的是用户资料、书籍资料、求购信息、转让信息、订单的管理以及对使用该 系统的某些恶意行为进行有效地制止，保证系统的安全和良好的环境。 校内易书系统的开发经过项目需求分析，分析开发可行性，软件、硬件需求，人员需 求，组织人员，系统设计，系统编码，系统实现，系统测试等阶段。软件运行于 windows 平台下，运用 Eclipse、mysql 等软件进行开发和维护。 关于系统的维护是由开发方担任。项目投资方无；需求方为云南大学；用户暂为云南 大学在校学生，以后可能进行扩展，为其他高校学生服务；开发方为云南大学软件学院软 件工程专业本科生小组；支持机构是云南大学软件学院 2010 级软件工程。 有关文档： 软件工程概论 李彤，王炜，郁湧 科学出版社 第一版（2012 年 2 月 28 日） 校内易书系统-软件需求规格说明书 校内易书系统-可行性分析报告 1.3 文档概述文档概述 软件产品规格说明 （SPS）包含或引用可执行软件、源文件、合格性规定以及软件 支持的信息。包括一个计算机软件配置项（CSCI） “已建成”的软件设计、编辑/建立过程、 修改过程、计算机硬件资源使用。最后，还要制定需求的可行性跟踪。在这个文档中包含 了软件建立、编辑、编译、生成及修改的几个阶段，清晰的记录了整个软件开发中对开发 的软件所进行的修改。 本文档可由投资方，需方，开发方和支持机构查看。 2 引用文件引用文件 软件工程概论 李彤，王炜，郁湧 科学出版社 第一版（2012 年 2 月 28 日） 软件产品规格说明（GB856788） 校内易书系统-可行性分析报告-v1.0 文档来源：开发方编写 校内易书系统-软件需求规格说明书-v1.0 文档来源：开发方编写 校内易书系统-数据库设计说明书-v1.0 文档来源：开发方编写 3 需求需求 本章应分为以下几条，规定必须满足的需求，以实现软件交付和建立另一软件实体， 以使其被认为是该 CSCI 的一个有效拷贝。 注：本章将软件自身作为被认为是 CSCI 的一个有效拷贝软件实体所必须匹配的准则。 被更新的软件设计不作为需求，而被放在第 5 章，仅作为用于修改、增强或其他支持该软 件时所使用的信息。如果此规格说明的任何部分被置于需方配置的控制之下，只应限于第 3 章。建立产品基线的是软件自身，而不是软件的设计说明. 3.1 可执行软件可执行软件 该系统名称为校内易书系统。 校内易书系统是 B/S 类型的软件，要使用该软件，要求客户端操作系统为 WindowsXP 及以上版本，需安装 IE、Chrome、FireFox 等主流浏览器。使用时，只需进行联网，打开 浏览器，输入网址即可。 3.2 源文件源文件 本条应通过引用所附的或其他形式提供的电子媒体给出该 CSCI 的源文件，它应包括重 新产生 CSCI 的可执行软件所需的批处理文件、命令文件、数据文件或其他文件。为使一软 件实体被认为是该 CSCI 源文件的有效拷贝，它必须精确匹配这些文件。 3.3 打包需求打包需求 (若有)本条应陈述打包和标记 CSCI 拷贝的需求。 4 合格性规定合格性规定 校内易书系统中，普通用户的操作主要有用户注册，登录，个人信息管理，上传书籍， 图书检索（包括按照书名直接检索，按类名检索，按学院专业年级检索） ，发布书籍转让信 息、书籍求购信息，管理发布信息、求购信息等图书交易功能。 用户注册时，必须按照规定的格式填写用户信息，必填的项不可为空。若信息填写不 正确，会给出提示直到正确为止。 在用户登录界面登录时，如果使用不符规定的用户名及对应的密码时会报错。如果正 确才进入校内易书系统。 普通用户登陆后转到个人主页，在此界面上可以进行个人基本信息的修改，包括昵称、 密码、学院、专业、联系方式、地址等等。在此页面，用户还可查看、修改、删除自己的 转让信息、求购信息、订单等。 用户只有登录后才能进行信息的发布、书籍的求购等操作。 若用户发布的转让信息或求购信息或留言中有不文明的词语，可对其进行屏蔽。 上传书籍：若用户需要的书籍在系统中不存在，用户可自行上传书籍，但必须详细填 写书籍的相关信息。 书籍检索：采用模糊搜索的方式，可按照书名直接检索、按类名检索、按学院专业年 级检索等。 在管理员登录界面登录时，如果使用不符规定的用户名及对应的密码时会报错。如果 正确才进入校内易书系统。 管理员登录后可进入管理员主页，进行用户的删除以及管理员信息的修改；还可以进 行书籍的管理，包括书籍的增、删、改、查；另外，还可进行管理员和用户的管理，包括 管理员和用户的添加及密码重置。 管理员也可进行书籍的上传，但同样的，必须详细填写书籍的详细信息。 以上所有操作中，若存在信息格式不正确货内容有争议性，则可使用相应措施进行阻 止。 5 软件支持信息软件支持信息 5.1“已建成已建成”软件设计软件设计 本系统实现校内易书的功能，具体包括用户注册，登录，个人信息管理，图书检索 （包括按照书名直接检索，按类名检索，按学院专业年级检索） ，发布书籍转让信息、书籍 求购信息，管理发布信息、求购信息等图书交易功能。 1）用户注册：用户需要提供电子邮件、密码、学校、专业、手机、宿舍等信息进行 注册成为会员，才可以在网站上进行交易。 2）个人资料管理：用户能修改自己的个人资料，比如修改自己的昵称，手机等等。 3）图书检索： 用户能根据书名、作者、ISBN、出版社等关键字进行检索出相关书籍。 用户能根据学院专业年级进行检索出相关书籍。 用户能根据图书的类别检索出相关书籍。 4）发布书籍转让信息：点击你要转让书籍下面的“我要转让” ，然后登记相应信息， 比如：联系方式，书籍说明，使用时间，新旧程度，图书照片，交易模式等信息，然后自 己的书籍转让信息就会出现在书籍详情页面下方。同时，在未交易成功的前提下，可以对 已经发布的信息进行修改。 5）发布书籍需求信息：当没有搜索到所需要的书籍时，点击“我要购买” ，登记自己 的相关信息，如联系方式等，没有方便在有人转让该书籍的时候能够及时联系到你。 6）图书交易：即线下交易，类似于货到付款，由于是同校交易，卖家和买家可以见 面交易。 7）订单的管理：可以管理生成的订单的修改、发货及删除。 校内易书系统后台主要提供的功能： 1）管理员登录及密码修改。 2）书籍的管理，包括书籍的增、删、改、查。 3）管理员和用户的管理，包括管理员和用户的添加及密码重置。 用户接口： 本系统采用广泛应用的 Web GUI，即诸如窗口、菜单、对话框、滚动条等。用户与系 统的交互通过用户输入字符，选择菜单或者对话框，然后系统对用户输入的信息进行分析 处理。 5.2 编译编译/建立过程建立过程 本系统为 B/S 架构，采用 Eclipse 进行开发，服务器使用 Apache Tomcat 7.0，数据 库采用 MyMySQL5.5。 系统标识号：专业实训-校内易书系统-1.0。 标题：校内易书系统。 缩略词语：无。 版本号：1.0。 标识号：1.0。 编译该系统的主机上需要安装 IE、Chrome、FireFox 等主流浏览器、Apache Tomcat 7.0，Eclipse for J2EE，jdk1.7，MyMySQL5.5，并正确配置运行环境。 本系统主要采用的 MVC 模型。M 指 Model，即底层类及一些服务类；V 指 View，即视图； C 指 Control，即控制。MVC 模型的基本思想为控制器接受用户请求，通过调用底层的服务 类处理请求，并将得到的结果返回。 编译的源文件为 Book，Book 中包含的文件如图 1 所示，主要有 JAX-WS Web Service、Deployment Description:Book、Java Resources、JavaScript Resources、build、WebCotent。其中，Java Resources 主要包含的是该系统的后台源代 码，即用于功能的实现，包括对象、服务以及控制器还包括系统的库；WebCotent 则包 含该系统的后台代码，即用于界面的展现。 图 1 Java Resources 中有两个文件夹，src 中为代码，Libraries 中为该项目的库。Src 包含四个包，即 com.book.controller（控制器） 、com.book.model（底层模型） 、 com.book.test（测试） 、com.book.util(公用方法)。如图 2 所示。 图 2 包 com.book.controller 中包含的文件有： AdminBookController.java、AdminBuyInfoController.java、BookController.java、Adm inInfoController.java、AdminLoginController.java、UserManageController.java、Lo ginController.java、AdminSaleInfoController.java、OrderController.java、AdminUp loadBookController.java、BuyInfoController.java、UserController.java、Recommend ationController.java、RegisterController.java、SaleInfoController.java、SearchC ontroller.java、UploadBookController.java、TradeController.java。 包 com.book.model 包含的文件有： Admin.java、AdminService.java、Book.java、BookService.java、BuyInfo.java、D BService.java、InfoService.java、Order.java、OrderService.java、User.java、Reco mmendationService.java、SaleInfo.java、SearchService.java、UserService.java。 包 com.book.test 包含的文件有 TestDB.java。 包 com.book.util 包含的文件有 MD5.java。 WebCotent 中主要包含 BookPic、css、image 以及 jsp 文件，如图 3 所示。BookPic 存 放的为书籍的图片，image 存放的为网页使用的图片。 图 3 jsp 文件有 admin.jsp、adminBuyInfo.jsp、adminChangeBookInfo.jsp、adminInfo.jsp、adminLogin.j sp、adminSaleInfo.jsp、adminUploadBook.jsp、adminUserInfo.jsp、buyInfo.jsp、hom e.jsp、homeBuyInfo.jsp、homeBuyOrder.jsp、homeChangeBuyInfo.jsp、homeChangeBuyO rder.jsp、adminBookManage.jsp、homeChangeSaleInfo.jsp、homeChangeSaleOrder.jsp 、homePassword.jsp、homeSaleChange.jsp、homeSaleInfo.jsp、homeSaleOrder.jsp、ho meUserInfo.jsp、Index.jsp、login.jsp、ok.jsp、register.jsp、saleInfo.jsp、searc h.jsp、trade.jsp、uploadBook.jsp、book.jsp。 数据库名为 book。数据库中一共建立起了 11 个表，表名分别为、书籍表：book、转 让书籍表：saleList、求购书籍表：buyList、订单表：orderList、管理员表：admin、学院表： school、专业表： major、课程表： course、书籍和课程的关系表：courseBook、专业和 课程的关系表：majorCourse、用户表：user。 建立起完整的数据库后，便可在 Eclipse 中运行该项目，在浏览器中进行操作。 5.3 修改过程修改过程 a.修改该系统用到的软件为 Eclipse、MySQL5.5 以及版本管理工具 SubVersion。修改 时，只需打开要修改的程序，然后进行代码的修改，修改完成后，需上传至服务器，以便 系统的版本随时保持最新。 b.CSCI 所使用的数据库数据库名为 book。数据库中一共建立起了 11 个表，表名分别 为、书籍表：book、转让书籍表：saleList、求购书籍表：buyList、订单表：orderList、管 理员表：admin、学院表： school、专业表： major、课程表： course、书籍和课程的关 系表：courseBook、专业和课程的关系表：majorCourse、用户表：user。 要修改数据库表时，需用到 MySQL5.5。有两种方法可以对表进行修改：一种是直接 使用 SQL 语句进行修改；另一种方法为右击要修改的表名，选择 Edit Table，然后进行相 应的修改，包括表属性的修改以及表中数据的修改。 c.在对数据表进行修改时不可对其中的默认值进行修改，以免发生数据修改后系统某 些功能无法使用；此外对表属性也不可随意更改，以防牵一发而动全身，导致系统无法正 常运行。在对源代码进行修改时应遵循源代码结构，在不破坏源代码结构的情况下可在其 中加入期望的功能；此外，不可随意更改底层的服务类和构造类，以免影响大局。 d.集成时，若出现错误，则可使用集成测试的方法来缩小错误范围，得到错误原因， 不能只凭个人经验修改，以免造成更大的错误；系统测试时，若发现 bug，不应急躁的马 上修改，而是要先分析一下如果这个 bug 被修复，会不会曹成更大的缺陷，要懂得衡量得 失。 5.4 计算机硬件资源使用计算机硬件资源使用 a.本系统运行时所占用的最少可使用硬件资源能力百分比如下： 前台： 百分比 Admin.jsp 管理员中心 0.1% adminBuyInfo.jsp 管理员管理求购信息页面 0.1% adminChangeBookInfo.jsp 管理员修改书籍信息页面 0.1% adminInfo.jsp 管理员信息管理页面 0.1% adminLogin.jsp 管理员登陆页面 0.1% adminSaleInfo.jsp 管理员管理求购信息页面 0.1% adminUploadBook.jsp 管理员上传书籍页面 0.1% adminUserInfo.jsp 管理员管理用户信息页面 0.1% Book.jsp 书籍详情页 0.1% buyInfo.jsp 发布求购信息页面 0.1% Home.jsp 个人中心 0.1% homeBuyInfo.jsp 用户求购信息页面 0.1% homeBuyOrder.jsp 用户购买订单页面 0.1% homeChangeBuyInfo.jsp 用户修改求购信息页面 0.1% homeChangeBuyOrder.jsp 用户修改购买订单页面 0.1% adminBookManage.jsp 管理员管理书籍信息页面 0.1% homeChangeSaleInfo.jsp 用户修改求购信息页面 0.1% homeChangeSaleOrder.jsp 用户修改出售订单页面 0.1% homePassword.jsp 用户修改密码页面 0.1% homeSaleChange.jsp 用户修改转让信息页面 0.1% homeSaleInfo.jsp 用户转让信息列表页面 0.1% homeSaleOrder.jsp 用户出售订单页面 0.1% homeUserInfo.jsp 用户信息页面 0.1% Index.jsp 网站首页 0.1% Login.jsp 用户登录页面 0.1% Ok.jsp 提交成功页面 0.1% Register.jsp 用户注册页面 0.1% saleInfo.jsp 发布转让信息页面 0.1% Search.jsp 书籍搜索页面 0.1% Trade.jsp 交易页面 0.1% uploadBook.jsp 用户上传书籍页面 0.1% 后台： 百分比 Admin.java 管理员类 0.1% AdminService.java 管理员服务类 0.1% Book.java 书籍类 0.1% BookService.java 书籍服务类 0.1% BuyInfo.java 求购信息类 0.1% DBService.java 数据库服务类 0.1% InfoService.java 信息服务类 0.1% Order.java 订单类 0.1% OrderService.java 订单服务类 0.1% User.java 用户类 0.1% RecommendationService.java 书籍推荐服务类 0.1% SaleInfo.java 转让信息类 0.1% SearchService.java 书籍搜索服务类 0.1% UserService.java 用户服务类 0.1% MD5.java 密码 MD5 加密类 0.1% AdminBookController.java 书籍信息管理控制器 0.2% AdminBuyInfoController.java 管理员管理求购信息控制 0.2% BookController.java 书籍控制器 0.2% AdminInfoController.java 管理员信息管理控制器 0.2% AdminLoginController.java 管理员登录控制器 0.2% UserManageController.java 管理员管理用户信息控制器 0.2% LoginController.java 用户登录控制器 0.2% AdminSaleInfoController.java 管理员管理转让信息控制器 0.2% OrderController.java 订单管理控制器 0.2% AdminUploadBookController.java 管理员上传书籍控制器 0.2% BuyInfoController.java 求购信息控制器 0.2% UserController.java 用户控制器 0.2% RecommendationController.java 书籍推荐控制器 0.2% RegisterController.java 用户注册控制器 0.2% SaleInfoController.java 求购信息控制器 0.2% SearchController.java 书籍搜索控制器 0.2% UploadBookController.java 书籍上传控制器 0.2% TradeController.java 交易控制器 0.2% b.假设在内存可硬盘等比较小的情况下，运行本系统所需的最小硬件资源如下： 处理器：20% 内存：20% 硬盘：5% c. 计算机内存至少为 512M，硬盘大于 40G，处理器为奔腾 4 以上，操作系统 window 2000、 windows xp、Vista 、windows7。 d. 处理器采用 Hz 每秒，存储器采用千字节每秒。 e. 在系统配置比较高的情况下，本系统可以正常运行而不出显死机等情况。 6 需求的可追踪性需求的可追踪性 a每一 CSCI 源文件到它所实现的软件配置项 前台： Admin.jsp 管理员中心 adminBuyInfo.jsp 管理员管理求购信息页面 adminChangeBookInfo.jsp 管理员修改书籍信息页面 adminInfo.jsp 管理员信息管理页面 adminLogin.jsp 管理员登陆页面 adminSaleInfo.jsp 管理员管理求购信息页面 adminUploadBook.jsp 管理员上传书籍页面 adminUserInfo.jsp 管理员管理用户信息页面 Book.jsp 书籍详情页 buyInfo.jsp 发布求购信息页面 Home.jsp 个人中心 homeBuyInfo.jsp 用户求购信息页面 homeBuyOrder.jsp 用户购买订单页面 homeChangeBuyInfo.jsp 用户修改求购信息页面 homeChangeBuyOrder.jsp 用户修改购买订单页面 adminBookManage.jsp 管理员管理书籍信息页面 homeChangeSaleInfo.jsp 用户修改求购信息页面 homeChangeSaleOrder.jsp 用户修改出售订单页面 homePassword.jsp 用户修改密码页面 homeSaleChange.jsp 用户修改转让信息页面 homeSaleInfo.jsp 用户转让信息列表页面 homeSaleOrder.jsp 用户出售订单页面 homeUserInfo.jsp 用户信息页面 Index.jsp 网站首页 Login.jsp 用户登录页面 Ok.jsp 提交成功页面 Register.jsp 用户注册页面 saleInfo.jsp 发布转让信息页面 Search.jsp 书籍搜索页面 Trade.jsp 交易页面 uploadBook.jsp 用户上传书籍页面 后台： Admin.java 管理员类 AdminService.java 管理员服务类 Book.java 书籍类 BookService.java 书籍服务类 BuyInfo.java 求购信息类 DBService.java 数据库服务类 InfoService.java 信息服务类 Order.java 订单类 OrderService.java 订单服务类 User.java 用户类 RecommendationService.java 书籍推荐服务类 SaleInfo.java 转让信息类 SearchService.java 书籍搜索服务类 UserService.java 用户服务类 MD5.java 密码 MD5 加密类 AdminBookController.java 书籍信息管理控制器 AdminBuyInfoController.java 管理员管理求购信息控制 BookController.java 书籍控制器 AdminInfoController.java 管理员信息管理控制器 AdminLoginController.java 管理员登录控制器 UserManageController.java 管理员管理用户信息控制器 LoginController.java 用户登录控制器 AdminSaleInfoController.java 管理员管理转让信息控制器 OrderController.java 订单管理控制器 AdminUploadBookController.java 管理员上传书籍控制器 BuyInfoController.java 求购信息控制器 UserController.java 用户控制器 RecommendationController.java 书籍推荐控制器 RegisterController.java 用户注册控制器 SaleInfoController.java 求购信息控制器 SearchController.java 书籍搜索控制器 UploadBookController.java 书籍上传控制器 TradeController.java 交易控制器 b. 每一软件配置项到实现它的源文件 前台： Admin.jsp 管理员中心 adminBuyInfo.jsp 管理员管理求购信息页面 adminChangeBookInfo.jsp 管理员修改书籍信息页面 adminInfo.jsp 管理员信息管理页面 adminLogin.jsp 管理员登陆页面 adminSaleInfo.jsp 管理员管理求购信息页面 adminUploadBook.jsp 管理员上传书籍页面 adminUserInfo.jsp 管理员管理用户信息页面 Book.jsp 书籍详情页 buyInfo.jsp 发布求购信息页面 Home.jsp 个人中心 homeBuyInfo.jsp 用户求购信息页面 homeBuyOrder.jsp 用户购买订单页面 homeChangeBuyInfo.jsp 用户修改求购信息页面 homeChangeBuyOrder.jsp 用户修改购买订单页面 adminBookManage.jsp 管理员管理书籍信息页面 homeChangeSaleInfo.jsp 用户修改求购信息页面 homeChangeSaleOrder.jsp 用户修改出售订单页面 homePassword.jsp 用户修改密码页面 homeSaleChange.jsp 用户修改转让信息页面 homeSaleInfo.jsp 用户转让信息列表页面 homeSaleOrder.jsp 用户出售订单页面 homeUserInfo.jsp 用户信息页面 Index.jsp 网站首页 Login.jsp 用户登录页面 Ok.jsp 提交成功页面 Register.jsp 用户注册页面 saleInfo.jsp 发布转让信息页面 Search.jsp 书籍搜索页面 Trade.jsp 交易页面 uploadBook.jsp 用户上传书籍页面 后台： Admin.java 管理员类 AdminService.java 管理员服务类 Book.java 书籍类 BookService.java 书籍服务类 BuyInfo.java 求购信息类 DBService.java 数据库服务类 InfoService.java 信息服务类 Order.java 订单类 OrderService.java 订单服务类 User.java 用户类 RecommendationService.java 书籍推荐服务类 SaleInfo.java 转让信息类 SearchService.java 书籍搜索服务类 UserService.java 用户服务类 MD5.java 密码 MD5 加密类 AdminBookController.java 书籍信息管理控制器 AdminBuyInfoController.java 管理员管理求购信息控制 BookController.java 书籍控制器 AdminInfoController.java 管理员信息管理控制器 AdminLoginController.java 管理员登录控制器 UserManageController.java 管理员管理用户信息控制器 LoginController.java 用户登录控制器 AdminSaleInfoController.java 管理员管理转让信息控制器 OrderController.java 订单管理控制器 AdminUploadBookController.java 管理员上传书籍控制器 BuyInfoController.java 求购信息控制器 UserController.java 用户控制器 RecommendationController.java 书籍推荐控制器 RegisterController.java 用户注册控制器 SaleInfoController.java 求购信息控制器 SearchController.java 书籍搜索控制器 UploadBookController.java 书籍上传控制器 TradeController.java 交易控制器 c. 给定每一计算机硬件资源使用计量到它所涉及的的 CSCI。 当在运行系统时，各个不同的模块是在同一时间运行，他们同时占用处理器、内存、 硬盘。 本系统计算机硬件资源最小可使用的资源能力的百分比： 处理器：20% 内存：20% 硬盘：5% d. 从有关计算机硬件资源使用的每一 CSCI 到给定的计量 前台： 百分比 Admin.jsp 管理员中心 0.1% adminBuyInfo.jsp 管理员管理求购信息页面 0.1% adminChangeBookInfo.jsp 管理员修改书籍信息页面 0.1% adminInfo.jsp 管理员信息管理页面 0.1% adminLogin.js