软件设计文档第六期SRTP项目含需求分析文档概要设计详细设计使用手册.docx

1、软件设计文档第六期SRTP项目含需求分析文档概要设计详细设计使用手册软件设计说明书项目名称基于Google Map的垂直社交网站的设计与实现项目编号110453项目成员ql，xx，xxx，xxx指导老师xx一、需求分析报告1 引言1.1编写目的 该需求规格说明书对基于Google Maps的社会交友系统进行了全面细致的用户需求分析，明确所要开发的软件应具有的功能、性能和界面，概要设计说明书和完成后续设计与编程工作将在此基础上进一步提出。1.2项目背景 现有的交友网站大多不支持LBS，即地理信息服务，用户状态的改变只有文本的内容改变，难以反应出用户当前的其它信息。本交友系统基于LBS，用户在更新

2、状态时可以加上地理位置信息，并会在地图上显示出其位置，能让人直观的看到友人所处的位置，方便朋友间线下的活动。在此背景下成立了该项目。1.3术语定义表1.1 术语定义表B/S结构Browser/Server（浏览器/服务器）结构Google MapsGoogle公司开发的一个地图，编程人员可以调用其API，在自己的网站中加入地图APIApplication Programming Interface 应用程序编程接口LBSLocation Based Service 基于位置的服务SNSSocial Networking Services 社会性网络服务2 任务概述2.1目标 该系统的目的在于给

3、用户创造一个新的交友环境，让用户能够使用地理信息来丰富自己的内容，同时运用地理位置来使应用变得有趣，例如通过当前位置查找范围内的陌生人并加好友。通过LBS，能够让用户体验到新鲜好玩的东西。2.2用户特点 面向所有网民，有时间上网，爱交友，爱探索位置周边信息。2.3假定约束 本系统开发期限为12个月。 用户调研，需求分析，概要设计和前期工作为2个月，具体代码编写，功能实施，最后软件测试和系统总结为6个月。对设备的要求：要求计算机稳定性良好，整套系统经济实惠。可以利用的信息和资源：图书馆书籍和网络资源。3 功能需求分析 系统流程简图：（仅针对用户）用 户注册注册/登录选择登录退出注册个人主页请求新

4、鲜事操作结果返回结果好友操作返回新鲜事日志操作新鲜事模块日志模块好友系统图2.1 系统流程简图功能树状图：LBS交友系统后台（略）前台好友搜索投票群组朋友圈心情相册照片日志登录注册图2.2功能树状图该系统的功能具体如下：表3.1系统功能表序号功能名功能明细备注1登录/注册新用户的注册以及老用户的登录以及登录验证2新鲜事登录后现实好友的新鲜事（普通模式和地图模式）3日志编辑，修改自己日志以及查看，评论好友日志（普通模式和地图模式）4相册/照片编辑，修改自己相册照片以及查看，评论好友相册照片（普通模式和地图模式）5心情编辑，修改自己心情以及查看，回复好友心情（普通模式和地图模式）6朋友圈管理自己的

5、朋友圈子7群组创建群组，结实志同道合的人8投票发起投票，看看大家的意见9搜索好友找到好友以及陌生人（普通模式和地图模式）4 运行环境需求服务器端：Windows Server 操作系统Apache Web服务器MySQL 数据库PHP 5.5 版本环境客户端：Windows XP或以上操作系统IE6 或以上版本浏览器或Chrome或Firefox或Opera浏览器5 其它非功能需求5.1 性能需求带宽要求：50-100M独享带宽或共享带宽。由于加载地图时所需的数据量较大，所以需要服务器的带宽应尽量高，同时地图的响应时间也与用户接入的实际带宽有很大关系。数据精确度要求：数据精度保持8位以上，能更

6、有效的标注用户位置。由于用户需要在地图的坐标上标注位置，所以需要地图数据（坐标，方向，海拔等）有相当高的精度，最大化的减少用户标注的地理位置与真实位置的偏移和失真。数据库要求：对关键位置的索引应尽量多而全同时应尽量快，否则加载地图时会出现延迟，影响用户体验。系统响应时间最大不超过5秒，平均在13秒。同时应具有良好的适应性，可移植性，可维护性5.2 安全性需求1. 用户可以选择对哪些分组或部分个人好友公开自己的地理位置信息，同时也可以选择公开的时间和地理范围。以防止用户隐私的泄漏和公开，尽量给用户以最大的自主性。2. 规则严密的用户白名单和黑名单系统。本软件不仅提供了简单的自定义分组，同时还设置

7、了白名单分组和黑名单分组。白名单分组：分组内好友拥有时时得到用户地理位置信息的权限，并且彼此的地理信息会首先加载，同时互动信息也会第一位的传递给彼此用户。黑名单分组：屏蔽此分组内用户对用户任何信息（最重要的是用户的地理位置）的访问，并且拒绝“加为好友”的任何申请和站内信件或评论。3. 用户的定制地图默认是某些好友公开，而不是向所有好友公开。防止默认情况下，用户的隐私计划泄漏并且不可挽回。5.3 软件质量属性 本软件的响应速度优于界面的人性化和功能的多样性，用户首先关注的是网站的地图加载速率，然后才是界面的人性化和功能的多样性。5.4 业务规则 当用户发表的两个言论之间的间隔不超过10s时，要限

8、制用户发言，防止用户恶意评论或机器评论。 用户标注商铺（景点）或分享商铺（景点）信息时，需要确定用户等级数，当达到一定等级之后才能分享商铺和景点，防止某些相关人员随意篡改和增加信息。5.5 用户文档 用户使用手册 网站帮助文档页面6 待定问题列表1. 用户是否愿意提供自己的地理位置信息2. 网页设计师界面设计能否达到用户的易用性要求。 二、概要设计报告1引言1.1编写目的为明确垂直社交网站系统的系统结构、安排项目规划与进度、制定详细测试计划、组织软件开发与测试，特撰写本文档。本文档的主要阐述基于Google Maps的的概要设计内容。本阶段将会在需求分析的基础上对软件系统做进一步的概要设计，主

9、要包括系统的组织设计、结构设计、接口设计、出错处理设计和数据库设计。同时，在下一阶段的详细设计中，本阶段的概要设计将做为参考，以方便完成整个系统的设计工作。本文档供项目经理、设计人员、开发人员参考。1.2背景开发软件名称：基于Google Map的垂直社交网站项目来源：西南交通大学第六期SRTP项目项目开发者：祁磊，郭凯，仓文旭，李丹丹用户：互联网用户项目与其他软件，系统的关系：该系统是在iwebSNS平台上进行进一步的开发，所以在定义数据时要与已有系统相兼容，同时保持页面风格保持一致。1.3定义Google Map：谷歌地图（Google Maps）是 Google 公司提供的电子地图服务，

10、包括局部详细的卫星照片。Google Maps API：Google为开发者提供的Maps编程API。SQL SERVER 2005：微软公司生产的SQL SERVER数据库管理系统；iWebSNS：一款大型高并发高负载的开源SNS软件，基于iwebSuperInteraction(简称iweb SI)框架开发1.4参考资料1需求分析报告，祁磊，2012.12齐治昌，谭庆平，宁洪编著，软件工程( 第2版)，北京，高等教育出版社，20043美 戴维斯,M. E.等著，车立红等译，Learning PHP & MySQL中文版，北京，中国电力出版社，20074 杨智宇著，PHP 5+MySQL动态

11、网站开发指南，北京，科学出版社，2008.65项目介绍网址，http:/202.115.71.131/SRTPMng2011/seeBlog.action?proj_idDes=A0277B4E7F678833，20106 iWebSNS主程序开发与改进规范，2任务概述2.1目标在一般社交网站的基础之上，增加用户和用户发表的各种内容的地理信息，从而形成以地理位置信息为基础的社交网站。由于项目是研究应用性质，所以都采用开源软件。用户在注册登录之后，可以在相应的模块中增删改查相应的信息。如在日志模块中，用户 可以发表新日志，编辑日志，删除日志。同时在个人首页中，可以查看好友的新鲜事，如好友最近发表

12、的心情，日志，最近上上传的相片等。在地图模式中，用户可以点击“全部”，在地图上查看所有好友的新鲜事，还可以选择查看日志新鲜事，心情新鲜事，相册新鲜事。当用要发表心情时，用户右击地图选择“发表说说”即可在弹出的窗口输入文字信息，然后点击发布。用户也可以右击地图在菜单中选择“发表日志”，“上传照片”，系统会自动指引用户到达相应页面。2.2运行环境软件环境1. 操作系统：Microsoft Windows XP/Windows 72. 网络服务器：Apache2.2及以上版本3. 数据库服务器：MySQL 5.0及以上版本4. 开发工具：Zend Studio设计和实现上的限制1. 处理器要求：Pe

13、ntium II及以上2. 运行环境：php-5.2.43. 内存要求：512MB或以上4. 浏览器要求：IE6.0及以上2.3 设计概述2.3.1限制和约束 技术条件；由于都是学生，可能专业技术和编程技术达不到要求。 资金状况；资金目前是自己筹备资金 开发环境(包括：工具和平台)；开发IDE免费，服务器软件需要支付费用 时间限制；时间在一年之内。2.3.2 设计原则和设计要求描述对本软件系统进行概要设计的原则，通常可以考虑以下几方面的内容：1. 用户界面设计原则：为了让系统拥有良好的人机交互界面，本软件系统用户界面布局应考虑到用户的操作系统，做到功能布局明显、空间分配平衡，以及界面统一规范化

14、等。2. 数据库设计原则：考虑到本系统为小型的应用型系统，在进行数据库设计时要优先考虑的地理坐标的数据精确性，同时还要保证系统的简练性，所以在满足第一、第二范式的情况下允许一定量的冗余出现。3. 系统安全性原则：为了确保用户地理位置的隐私安全，本系统应提供对用户地理信息数据进行加密。3总体设计3.1 系统架构设计controllerdo.phpmodel.php数据库ajax图3.1 系统架构图如图3.1所示，系统采用MVC三层架构开发模型。之所以要如此设计因为大型网站通常要有一个良好的系统架构，方便协作和日后的扩展升级。在本系统中主要采用了如下的设计：1. 请求结果展示视图部分主要由PHP页

15、面和HTML页面编译生成，用来显示各种请求返回的结果。其中在HTML中利用Ajax技术动态的将数据库中的数据提取到前台页面中，再用javascript脚本语言解析服务器返回的json数据，并最终显示在页面中。2. 功能模块功能模块部分重要是SNS网站的各个主要功能的实现模块，如心情模块，日志模块，相册模块等。他们负责模块内各种业务逻辑的实现，如发表日志，修改日志，上传照片等。3. 控制层Controller此部分由系统核心的两个PHP页面do.php和model.php承担。在PHP页面中维护这一个模块的注册数组。控制层当接受到访问某个模块的请求时，会查阅模块注册数组，找到模块注册时留下的相对

16、路径，然后系统自动调转到相应模块页面中。4. 数据库连接中间层此部分是为了将系统和特定的数据库服务器分离开，降低系统的耦合度。它是由PHP的dbconfig.php和cdbex类实现的。系统将与数据库的连接配置抽离成变量，保存在dbconfig.php中，同时cdbex类将操作数据库的SQL语句封装成函数，方便系统调用。3.2 系统逻辑设计3.1 系统组织设计系统组织表的格式如下：子系统编号英文名称中文名称业务职能安装地点备注F0.1SkanFriInfo新鲜事（浏览好友信息）在地图模型下查看用户好友的日志心情说说等信息需要F0.4F0.2RegLog注册登录系统用户注册登录到网站F0.3Fr

17、iSearch搜索好友在地图上搜索所有用户，并在地图上显示需要F0.4F0.4LoadMap载入地图加载地图模式的地图js库和对话框库3.2 系统结构设计系统特性表系统由多个子系统(模块)组成时，所以每个子系统分别使用一张系统特性表进行描述。系统特性表的格式如下：表 3.1 浏览好友信息子系统特性表子系统编号：F0.1子系统英文名称：SkanFriInfo子系统中文名称：浏览好友信息特性编号系统特征英文名称系统特征中文名称操作功能调用对象被调用对象备注T1.1FriBlog好友博客查看好友的博客T1.5T1.2FriMen好友心情查看好友的心情T1.5T1.3FriShuo好友说说查看好友的说

18、书T1.5T1.4LoadMap加载地图加载地图T1.5T1.5LoadFriInfo加载好友信息在地图上加载好友的信息T1.1 T1.2 T1.3 T1.4 表 3.2 注册登录子系统特性表子系统编号：F0.2子系统英文名称：RegLog子系统中文名称：注册登录特性编号系统特征英文名称系统特征中文名称操作功能调用对象被调用对象备注T2.1Reg用户注册记录用户信息，提供用户注册T2.2Log用户登录用户登录T2.1表 3.3 搜索好友子系统特性表子系统编号：F0.3子系统英文名称：FriSearch子系统中文名称：搜索好友特性编号系统特征英文名称系统特征中文名称操作功能调用对象被调用对象备注

19、T3.1FriSearch搜索好友提供搜索用户功能T2.1T2.2T3.2AddFri加为好友加陌生用户为好友表 3.4 载入地图子系统特性表子系统编号：F0.4子系统英文名称：LoadMap子系统中文名称：载入地图特性编号系统特征英文名称系统特征中文名称操作功能调用对象被调用对象备注T4.1LoadGoogleMap加载基础地图将Google Map贴片加入HTMLT4.2LoadC加载控件加载地图自定义空间T4.3LoadUserInfo加载用户信息加载用户信息T2.1T2.2T4.4LoadJs加载js库加载js库和对话框函数库T4.1T4.24接口设计4.1用户接口 在用户界面部分，根

20、据需求分析的结果，用户需要一个用户友善界面。在界面设计上，应做到简单明了，易于操作，并且要注意到界面的布局，应突出的显示重要以及出错信息。在个人主页中应突出Google Map，并且在Google Map地图上的操作应尽量做到简单快捷，同时在页面的右侧边应有相应的文字指示和选择界面。这个界面有两个用户：一是指引用户进行下一步的操作，二是详细展示地图上的信息。4.2外部接口本系统主要使用Google Maps Api调用Google Map的各种地图服务。同时使用ODBC服务调用MySQL的数据库服务。4.3内部接口内部接口方面，各模块之间采用函数调用、参数传递、返回值的方式进行信息传递。具体参

21、数的结构将在下面数据结构设计的内容中说明。接口传递的信息将是以数据结构封装了的数据，以参数传递或返回值的形式在各模块间传输。5系统数据结构设计5.1 逻辑结构设计表和表字段命名规范：1. 表名的定义：规范格式：系统名_表名本系统中的某个表定义为：isns_users;2. 表字段的定义：规范格式：表名+下划线+字段名称，以避免字段重名出现在不同表中。比如，表isns_users中的字段标识Id定义为：user_d；3. 表字段长度的定义：规范格式：长度一般为8的整数倍；比如，VARCHAR的长度可为8或16或24或32或64等；4. 表字段类型为日期型的定义： 规范格式：一般日期型的字段设为T

22、imestamp5. 公共表名的定义：规范格式：PUBLIC_表名（字母全部大写）比如，各个子系统都会用到的公共表，如角色或操作日志表可定义为：PUBLIC_ROLE，PUBLIC_OPERATELOG;表5.1 用户表isns_users编号字段名称数据类型大小允许空默认说明1(PK)user_idmediumint8ID2user_namevarchar50姓名3user_sexSmallint20性别4user_emailvarchar200邮箱备注：其他字段（基本信息）此处略去表5.2 位置表isns_location编号字段名称数据类型大小允许空默认说明1(PK)Loc_idintI

23、D2User_idMediumint8用户ID3Mood_idMediumint90心情ID4Blog_idMediumint90日志ID5Album_idMediumint90相册ID6addressVarchar200地址信息2latDouble10，6纬度3lngdouble10，6经度备注：其他字段（基本信息）此处略去表5.3 好友信息表isns_pals_mine编号字段名称数据类型大小允许空默认说明1(PK)idmediumint8表ID2(FK)User_idmediumint8用户ID3(FK)Pals_idmediumint8好友ID备注：其他字段（基本信息）此处略去表5.4

24、 日志表编号字段名称数据类型大小允许空默认说明1(PK)Log_idMediumint8日志ID2user_idMediumint8Null用户ID3Log_titleVarchar80Null日志标题4Log_contentTextNull日志正文5TagVarcahr80Null日志标签6PrivacyVarchar200Null日志隐私备注：其他字段（基本信息）此处略去表5.5 相册表编号字段名称数据类型大小允许空默认说明1(PK)Album_idMediumint8相册ID2Album_namevarchar200相册名称3User_idMediumint8用户ID4PrivacyVa

25、rchar80相册隐私表5.6 心情表编号字段名称数据类型大小允许空默认说明1(PK)Mood_idMediumint8心情ID2User_idMediumint8用户ID3MoodText心情内容5CommentsInt5评论数备注：其他字段（基本信息）此处略去表5.7 相片表编号字段名称数据类型大小允许空默认说明1(PK)photo_idMediumint8 相片ID2User_idMedium8用户ID3Photo_nameVarchar200Null相片名称4Photo_infomationTextnull相片信息5Photo_srcVarchar150null相片存放路径6Album

26、_idMediumint8所属相册ID备注：其他字段（基本信息）此处略去6系统出错处理设计6.1出错信息表 6.1 出错信息表出错名称系统输出信息处理方法未输入地址信息“请填写地址”在输入框显示出错信息未点击地图“请在地图上标注”在输入框显示出错信息用户名输入错误“用户名错！请重新输入！”进入登录页面前三次密码错误“您的密码输入有误，请重新输入！”进入登录页面密码错数次数超过三次“密码错误！请半个小时后再进行登录操作！”进入默认登录页，并半小时内禁止该用户进行登录。输入数据格式错误“输入格式不正确，请检查后再输入！”返回原输入页面不允许为空的输入框输入空字符“请输入!”弹回原输入页面的输入处系统故障“服务器维护中！暂停服务！”立即启用备用机，恢复故障6.2补救措施由于数据在数据库中已经有备份，故在系统出错后可以依靠数据库的恢复功能，并且依靠日志文件使系统再启动，就算系统崩溃用户数据也不会丢失或遭到破坏。但有可能占用更多的数据存储空间，权衡措施由用户来决定。三、详细设计报告1引言1.1 编写目的本文档的目的是阐述基于Goo