示例APP项目系统设计说明书文档格式.docx
《示例APP项目系统设计说明书文档格式.docx》由会员分享，可在线阅读，更多相关《示例APP项目系统设计说明书文档格式.docx（10页珍藏版）》请在冰豆网上搜索。
2015-9-15至2015-9-18
2
1.文档介绍............................................................................................................................4
1文档目的与范围...............................................................................................................4
2读者对象..........................................................................................................................4
2.系统概述..............................................................................................................................5
3.开发、测试与运行环境.....................................................................................................5
4.软件系统结构图.................................................................................................................6
5.
数据库设计概述............................................................................................................10
5.1数据库环境说明..........................................................................................................10
5.2数据库命名规则..........................................................................................................11
5.3安全性设计说明..........................................................................................................11
5.4表清单..........................................................................................................................11
6.
客户端APP接口设计...................................................................................................12
3
1.文档介绍
1文档目的与范围
此文的是为了说明描述I水滴项目的服务端及管理后台的系统架构开发使用的技术及要
点。
2读者对象
系统开发人员；
系统维人员；
系统二次开发人员；
等。
4
2.系统概述
“i水”APP是面向于智能水表用户的一个移动应用，全面卡通家庭的形象设计贯
穿应用所有功能，通过实名用户与物联信息化的联接，为用户提供用水服务相关产
品的垂直电商等服务。
以智能水表为切入点，把与之绑定的“i水”应用作为服务入口，核心功能的实用
型用水服务来绑定用户，参与活动、游戏等获得免费用水来培养用户粘性，也可支
持第三方账号登录如QQ/微信/微博等，将虚拟水滴、虚拟理财、用水游戏、社区电
商等运营型服务来丰富服务收益渠道，摸索并积累不同地区不同类型的用水用户消
费习惯，并衍生更多服务方式。
（1）以用水缴费管理为核心，电商消费等管理流程，对用水客户的业务进行全方位
管理；
（2）建立积分制度即水滴，可免费获得并用来消费，提高客户的忠诚度；
（3）通过后台系统对已有的客户信息进行归类管理，比如通过分析得到客户特征、
购买行为、价值取向，从而定位出高价值客户，通过消费方式等与客户息息相关的
角度进行数据梳理，改善服务模式，实现完善与创新。
3.开发、测试与运行环境
类别
标准配置
最低配置
开发环境
CPU:
I5内存：
8M硬盘：
1T
I3内存：
4M硬盘：
500G
测试环境
运行环境
I7内存：
I7（双CUP）
内存：
32M硬盘：
5
4.软件系统结构图
1.系统以MVC模式进行开发.
Spring-MVC工作原理。
Spring的MVC框架主要由DispatcherServlet、处理器映射（HandlerMapping）、
处理器（Controller）、视图解析器（ViewResolver）、视图（View）组成。
1.客户端请求提交到DispatcherServlet
2.由DispatcherServlet控制器查询一个或多个HandlerMapping，
找到处理请求的Controller.
3.DispatcherServlet将请求提交到Controller
4.Controller调用业务逻辑处理后，返回ModelAndView
5.DispatcherServlet查询一个或多个ViewResoler视图解析器，找到
ModelAndView指定的视图
6.视图负责将结果显示到客户端DispatcherServlet是整个SpringMVC
的核心。
它负责接收HTTP请求组织协调SpringMVC的各个组成部分。
其主要工作有以下三项：
1.截获符合特定格式的URL请求。
2.初始化DispatcherServlet上下文对应的WebApplicationContext，并
将其与业务层、持久化层的WebApplicationContext建立关联。
3.初始化SpringMVC的各个组成组件，并装配到DispatcherServlet中。
SpingMVC核心接口:
6
1.DispatcherServlet接口：
Spring提供的前端控制器，所有的请求都有经过它来统一分发。
在
DispatcherServlet将请求分发给SpringController之前，需要借助于Spring
提供的HandlerMapping定位到具体的Controller。
2.HandlerMapping接口：
能够完成客户请求到Controller映射。
3.Controller接口：
需要为并发用户处理上述请求，因此实现Controller接口时，必须保证线程安
全并且可重用。
Controller将处理用户请求，这和StrutsAction扮演的角色
是一致的。
一旦Controller处理完用户请求，则返回ModelAndView对象给
DispatcherServlet前端控制器，ModelAndView中包含了模型（Model）和视图
（View）。
从宏观角度考虑，DispatcherServlet是整个Web应用的控制器；
从
微观考虑，Controller是单个Http请求处理过程中的控制器，而ModelAndView
是Http请求过程中返回的模型（Model）和视图（View）。
4.ViewResolver接口：
Spring提供的视图解析器（ViewResolver）在Web应用中查找View对象，从
而将
相应结果渲染给客户。
表现层
目前主要采用jsp,html页面,以及jquery等UI框架作为展示数据及交互的媒介.
控制/业务逻辑层
由Springmvc完成.
利用Spring框架的依赖注入实现对Service类和DAO类的实例托管；
在事务处理
方面，利用Spring提供的面向切面的事务处理功能，使对
数据的事务控制脱离于数据访问接口实现；
在对象关系映射方面，利用Spring对
数据库连接池的托管和对myBatis框架的支持。
开发人员需要完成对数据源的配置、
对不同模块所对应的application*.xml文件的配置，以及对特殊业务逻辑接口的
定义和业务逻辑实现的编写。
持久层
利用MyBatis提供的半自动化对象关系映射的实现，开发人员需要编写具体的sql
语句，为系统设计提供了更大的自由空间。
另外，开发人员需要完成对SqlMapConfig.xml
和*SqlMap.xml的配置
2.项目管理采用maven
ApacheMaven是一个软件项目管理和综合工具。
基于项目对象模型（POM）的概念，
Maven可以从一个中心资料片管理项目构建，报告和文件。
本教程将介绍如何使用Maven在Java开发，或任何其他的编程语言的任何项目。
Maven是什么？
7
Maven是一个项目管理和综合工具。
Maven提供了开发人员构建一个完整的生命周
期框架。
开发团队可以自动完成项目的基础工具建设，Maven使用标准的目录结构
和默认构建生命周期。
在多个开发团队环境时，Maven可以设置按标准在非常短的时间里完成配置工作。
由于大部分项目的设置都很简单，并且可重复使用，Maven让开发人员的工作更轻
松，同时创建报表，检查，构建和测试自动化设置。
Maven提供了开发人员的方式来管理：
∙Builds
∙Documentation
∙Reporting
∙Dependencies
∙SCMs
∙Releases
∙Distribution
∙mailinglist
概括地说，Maven简化和标准化项目建设过程。
处理编译，分配，文档，团队协作
和其他任务的无缝连接。
Maven增加可重用性并负责建立相关的任务。
8
3.项目模块结构图：
9
APP：
接口示例：
5.数据库设计概述
5.1数据库环境说明
数据库系统：
mysql5.5
设计工具：
powerdesigner15
10
5.2数据库命名规则
表：
模块名称_功能名称
如：
Sys_Account（系统模块_账户表）
字段：
表功能名称字段名称
AccountLoginName（账户表登录名称）
5.3安全性设计说明
1、数据库以密文方式存储账户密码
2、防止SQL注入
3、主外键关联防止垃圾数据
4、主要业务表设计为逻辑标志位删除
5、数据库定期备份等。
5.4表清单
名称
优惠券表
优惠券详情表
商品信息表
商品图片
地区表
代码
Shop_ParentCoupon
Shop_ChildCoupon
Shop_ProductInfo
Shop_ProductPic
Sys_Area
帖子分享表
帖子表
Bbs_PostShare
Bbs_Post
广告表
Sys_Ad
收货地址表
水宝信息表
水宝明细表
水滴信息表
水滴明细表
水表信息表
水表缴费记录表
消息推送
用户优惠券表
用户信息表
用户预注册表
Mb_UserAddress
Tre_TreasureInfo
Tre_TreasureDetails
Dro_DropInfo
Dro_DropDetails
Me_MeterInfo
Me_MeterPay
Sys_Msg
Mb_UserGroupon
Mb_User
Mb_UserPer
11
等级名称表
签到表
Sys_Level
Mb_Sign
系统模块表
角色和模块关系表
订单表
Sys_Module
Sys_GroupModuleRelation
Shop_Order
Bbs_Comment
Sys_Text
评论表
说明文本表
账户主表
账户细表
账户角色表
银行表
Sys_Account
Sys_AccountDetail
Sys_Group
Sys_Bank
Bbs_Att
附件表
6.客户端APP接口设计
详见““i水（爱水）APP”APP接口文档”
12
升级会员 