掌上导游系统——系统设计说明书.docVIP

项目名称Project Name密级Confidentiality Level基于Android平台的掌上导游系统仅供收件方查阅项目编号Project ID版本Version文档编号Document Codev6.3055.1116.90.8v6.3055.1116.9_SD_001Pocket guide system based on the Android platform Software System Design Specification 基于Android平台的掌上导游系统软件系统设计说明书Prepared by 拟制张汇东Date日期2012-09-04Reviewed by 评审人王飞Date日期Approved by批准喻国良Date日期 版权所有 不得复制Copyright BroadenGate Technologies, Co., Ltd. All Rights ReservedRevision Record修订记录Date日期Revision Version修订版本CR ID /Defect IDCR/ Defect号Sec No.修改章节Change Description修改描述Author作者2012-09-040.8全部软件系统设计说明书张汇东、刘善友、吴文传、张洋、傅颖、尹凯乐Catalog 目 录1Introduction 简介61.1Purpose 目的61.2Scope 范围61.2.1Name 软件名称61.2.2Functions 软件功能61.2.3Applications软件应用62Level 0 Design Description第0层设计描述62.1Software System Context Definition 软件系统上下文定义62.2Design Considerations (Optional)设计思路(可选)62.2.1Design Alternatives 设计可选方案72.2.2Design Constraints 设计约束72.2.3Other Design Considerations 其他73Level 1 Design Description第一层设计描述73.1System Architecture系统结构73.1.1Description of the Architecture系统结构描述73.1.2Representation of the Business Flow业务流程说明73.2Decomposition Description分解描述83.2.1Module/Subsystem 1 Description模块1/子系统1描述83.2.2Module/Subsystem 2 Description模块2/子系统2描述83.3Dependency Description依赖性描述83.4Interface Description接口描述83.4.1Module/Subsystem 1 Interface Description模块1/子系统1的接口描述83.4.2Module/Subsystem 2 Interface Description模块2/子系统2的接口描述94Level 2 Design Description第二层设计描述94.1Module Name (1) 模块1名称94.1.1Design Description模块设计描述94.1.2Function Illustration功能实现说明104.2Module Name (2) 模块2名称104.2.1Design Description模块设计描述104.2.2Function Illustration功能实现说明105Database Design数据库设计105.1Entities Definition实体定义115.1.1Decomposition Description分解描述115.1.2Internal Dependency Description内部依赖性描述115.2Behaviors Definition行为定义115.2.1Decomposition Description分解描述115.2.2External Dependency Description外部依赖性描述115.2.3Internal Dependency Description内部依赖性描述116Detailed Design of Module 模块详细设计116.1Class1 CLASS的设计116.1.1Overview简介126.1.2Class Diagram类图126.1.3Status Design状态设计126.1.4Attributes属性126.1.5Methods方法126.2Class2 CLASS的设计137Detailed Design of the Database数据库详细设计137.1Stored Procedure1 #/Trigger1# 存储过程1#/触发器1#的名称137.2Stored Procedure 2#/Trigger2# 存储过程2#/触发器2#的名称13 Keywords 关键词：Abstract 摘 要：List of abbreviations 缩略语清单：Abbreviations缩略语Full spelling 英文全名Chinese explanation 中文解释1 Introduction 简介1.1 Purpose 目的本文档描述的是“基于Android手机平台的手机导游”软件功能的模块功能点分析，本文档主要针对手机导游软件各个业务功能模块进行外界环境、系统框架、业务流程、功能类上的分析，文档主要面向本项目开发本的项目组成员，让项目组成员充分了解本手机导游软件开发项目的设计、功能模块、业务逻辑等，从而完整、有效地开发以及实现软件全部的功能。1.2 Scope 范围1.2.1 Name 软件名称基于Android平台的掌上导游系统1.2.2 Functions 软件功能本软件可以实现基本的定位功能，提供你所需要的地理信息。并可指明路线，使你能够很方便地到达目的地。还可搜索你所在地附近的商店信息。1.2.3 Applications软件应用随着人们对于出行要求的提高，如果能有一款能随身携带的工具，用以帮助人们查询地理位置，并提供优质的位置服务，便于人们查询路线、商店等信息，无疑会收到广大用户的欢迎与青睐。当你出差旅行时，你也许需要了解所在地的信息，需要了解所处位置周围所能提供的服务，如加油站、酒店、餐馆等，或者是希望获得某条线路以到达下一个目的地。这个时候，你的手机上有一个导游系统软件就显得非常必要。通过简单的操作，即可获得你所需要的这些服务，既节约了时间，也节约了人力与财力。2 Level 0 Design Description第0层设计描述2.1 Software System Context Definition 软件系统上下文定义图2.1.1系统环境图2.2 Design Considerations (Optional)设计思路(可选)2.2.1 Design Constraints 设计约束 Standards compliance 遵循标准l 本手机导游软件的开发在源代码上遵循java编程规范及其开发标准。l 运行eclipse开发环境和ADT插件。l 文档依据深圳易思博公司文档标准。 Hardware Limitations 硬件限制本手机导游软件只能在Android智能操作系统手机平台上正常运行，手机至少要有2M的剩余空间。本手机导游软件PC机模拟器的配置需要2GB以上的内存，奔腾IV以上的处理器，Windows Xp sp2及以上升级包的XP系统。 Technology Limitations 技术限制本手机导游软件主要是对手机移动终端使用过程中对武大校园及其附近进行信息导引，所以需要手机服务商提供网络，可以根据GPS进行实时定位。 Database 数据库暂无。 OS 操作系统本手机流量监控软件只适用于android智能操作系统平台SDK在2.1及以上的智能手机移动终端。2.2.2 Other Design Considerations 其他3 Level 1 Design Description第一层设计描述3.1 System Architecture系统结构3.1.1 Description of the Architecture系统结构描述 图3.1.2 系统功能模块图1) 欢迎信息 Logo界面展示（含欢迎语）本UI界面主要给用与展示应用系统的友好欢迎界面，提示用户本系统的主要功能，友好的交互界面将会给用户带来赏心悦目的感觉。智能平台手机移动终端操作用户通过本界面图形显示可以快速、方便、及时地了解本软件的意图（也就是说看欢迎界面就知道本软件要实现的业务及功能）；配合友好的UI图形显示Logo图标，加强产品影响力；给智能平台手机移动终端操作用户带来使用便捷的操作提升用户亲和力。2) 地图导航在手机界面上显示一张地图，并可运用GPS定位来确定当前位置，并标注在地图上。可通过输入地名来搜索位置信息，并可获得相应的行进线路，显示在地图之上。3) 周边查询商户查询：可通过点击菜单项，来获得附近商户信息，并显示在地图上4) 信息分享将拍得的照片，分享上传至微博。3.1.2 Representation of the Business Flow业务流程说明 地图导航模块流程 周边信息查询模块流程 帮助模块流程3.2 Decomposition Description分解描述3.2.1 地图导航模块描述1.Overview简介地图导航的功能主要包括查询想要位置的信息（天气、详细介绍等等）、通过GPS定位找到自己所在的位置和各种路线的查询。2. Functions功能用户可以查询自己当前的位置，通过输入查询的地方来查看地图，也能查询两个地方之间的路线。3.2.2 周边信息查询模块描述1.Overview简介周边查询功能主要包括搜索你选定位置周边的酒店、饭馆、车站、医院等等的信息，也可以浏览该景点的简介。本周边查询功能通过使用第三方的接口获取周边的信息，当用户点击了搜索周边的环境，则将弹出选项让用户选择搜索的类型是酒店，还是饭馆，或车站，或医院等等。当用户选择了某项时，地图上将标志该类型的地点，你可以点击该地点阅读该地点的简介，也可以点击链接，进一步了解该点的详细介绍。 2. Functions功能用户可以查询某个地方周边的信息，比如酒店、饭馆、车站、医院等，并可以在地图上显示。3.2.3 信息分享模块描述1.Overview简介信息分享功能主要包括分享你自己的位置、自己拍摄的照片以及自己在旅游该点的心得体会。本周边查询功能是将自己在该点的信息通过微博等分享给其他的人。当第一次分享时，将会要求用户登录微博进行授权该软件，授权后用户就可以使用此软件分析自己的旅游经历给好友了。2. Functions功能用户可以拍照上传到微博，也能分享自己当前的位置。3.3 Dependency Description依赖性描述l 该系统的操作设计简单，用户不需要具备相应的专业业务知识。本软件配有帮助说明文档，方便用户快速学习使用过程。同时，本软件使用过程中有明显的操作提示，用记可根据提示进行相关操作、查看网络流量信息数据等。l 依赖的运行环境指定为：基于Android智能操作系统平的手机，或是基于Android智能操作系统平的手机模拟器（Cell Phone Emulator）。l 本项目依赖Android构架进行开发，Android构架如下：图3.3 Android构架图3.4 Interface Description接口描述 主界面屏幕格式：640*480输入输出：无组合功能键：无 地图 屏幕格式：640*480页面规划：地图模式切换，地点搜索，景点/商户显示，路线搜索。输入输出：显示卫星地图，显示路况地图，显示地点及周边景点/商户，显示两地点间路线。组合功能键：无 景点收藏 屏幕格式：640*480页面规划：显示收藏的景点列表。 输入输出：显示景点列表和详细信息。组合功能键：无 商户收藏 屏幕格式：640*480 页面规划：显示收藏的商户列表。输入输出：显示商户列表和详细信息。组合功能键：无 路线 屏幕格式：640*480 页面规划：显示已游览的路线列表。输入输出：显示路线列表和详细信息。组合功能键：无 帮助 屏幕格式：640*480 页面规划：显示关于我们的信息输入输出：无组合功能键：无 系统设置 屏幕格式：640*480 页面规划：外观设置和城市设置 输入输出：改变外观和所在城市。3.4.2 Software Interface 软件接口A.名字： google API B.助记符： G_API C.版本号： api v3 D.来源： 官网 E.用途： 调用google API提供的强大地图功能。3.4.3 Hardware Interface 硬件接口本手机导游软件需在android智能操作系统平台的手机移动终端上使用，并且手机移动终端要求有16M内存、2M的存储空间、拥有无线3G网卡设备（无线3G网卡就确保智能平台移动手机终端使用网络访问功能的硬件接口，如无此设备智能平台移动手机终端无法访问使用网络资源，将没有相应的地图产生）。3.4.4 Communication Interface 通讯接口通讯接口：TCP/IP协议、google API中国可使用的智能手机移动无线网络：GSM/WCDMA/CDMA2000/TDSCDMA3.4.5 Other Interfaces 其他接口4 Level 2 Design Description第二层设计描述4.1 地图导航模块4.1.1 Design Description模块设计描述 GuideMap（1）CI Identification标识地图_GuideMap（2）Overview简介本掌上导游系统在此模块中将会显示baidu Map，可以对其进行放大缩小操作，也可在卫星视图和地图视图中进行切换，可以显示当前位置，也能搜索某个地方的地图，两地间路线的查询 （3）Definition类定义图 GuideMap类图 InsertPosition（1）CI Identification标识地点搜索_InsertPosition（2）Overview简介本界面是地点搜索界面，包含两个输入框，用户可输入经度和纬度，结果会显示在地图上，包含输入的位置和周围的商户、景点信息。（3）Definition类定义图 InsertPosition类图 MapsHttpUtil（1）CI Identification标识发送http请求_ MapsHttpUtil（2）Overview简介将搜索界面的经纬度传到请求地址中发送到服务器。（3）Definition类定义图 MapsHttpUtil类图 Tools（1）CI Identification标识解析服务器发回的信息_ Tools（2）Overview简介解析服务器返回的地点信息。（3）Definition类定义图 Tools类图 HelloItemizedOverlay（1）CI Identification标识标记_HelloItemizedOverlay（2）Overview简介该模块主要功能用于在地图上使用浮动层标记出地点和商户、景点。（3）Definition类定义图 HelloItemizedOverlay类图4.1.2 Function Illustration功能实现说明图4.1.2 地图模块时序图4.2 周边信息查询模块4.2.1 Design Description模块设计描述 StoreInfo（1）CI Identification标识商户信息_StoreInfo（2）Overview简介该类继承Activity类，实现向用户展示商户详细信息的功能，商户详细信息包括：商户ID（数据库中自增ID）,商户名称，类型，商户信息描述。（3）Definition类定义（Optional）类名：StoreInfo继承类：ActivityPublic方法：public Cursor queryById（int id）此方法实现通过商户ID从数据库中取景点信息的功能，返回一个Cursor对象。图 StoreInfo类图 StoreList（1）CI Identification标识商户信息_StoreList（2）Overview简介该类继承Activity类，实现以列表的形式向用户展示商户概要信息的功能，列表中信息具体包括：商户ID，商户名称。另通过点击列表中特定项能够进入该项的详细信息页面。（3）Definition类定义（Optional）类名：StoreList继承类：ActivityPublic方法：public void setAdapter（）此方法实现从数据库中取得相关信息并映射到ListView对应项实现以列表的形式向用户展示景点概要信息的功能。图 StoreList类图4.2.2 Function Illustration功能实现说明图4.2.2 商户模块时序图4.3 路线模块4.3.1 Design Description模块设计描述 GetWays（1）CI Identification标识获取道路_GetWays（2）Overview简介通过发送http请求，给出起始点和目标点的经纬度坐标，返回JSON文件，JSON文件中包含最优的行进路线的各个点以及距离、行走时间等重要信息。可以对JSON文件进行解析获取信息，方便用户查询旅游。（3）Definition类定义图4.3.1 GetWays类图 InsertPosition（1）CI Identification标识存储结点信息_InsertRoute（2）Overview简介通过用户输入出发点和目的地点，转化成经纬度，并将经纬度存入SharedPreferences中，供以后调用。（3）Definition类定义图4.3.2 InsertRoute类图 ValueUtil（1）CI Identification标识工具类_ ValueUtil（2）Overview简介工具类，用于存放一些不变的静态变量，便于统一管理及后期的维护。（3）Definition类定义图4.3.3 ValueUtil类图 WaysOverLay（1）CI Identification标识画出路线_ WaysOverLay（2）Overview简介通过返回的points，将其连线逐一连线，画出整条路线。便于导航用户旅行，画出线后，一目了然。（3）Definition类定义 图4.3.4 WaysOverLay类图4.3.2 Function Illustration功能实现说明图4.3.5 路线模块时序图4.4 帮助4.4.1 Design Description模块设计描述 Help（1）CI Identification标识掌上导游系统_ Help（2）Overview简介本掌上导游系统在此模块中将会通过文字的方式来对本软件系统的操作进行详细描述说明，同时也会介绍本软件系统开发的团队成员、本软件系统版本描述等相关信息内容。（3）Definition类定义图4.4.1 Help类图4.4.2 Function Illustration功能实现说明图4.4.2 帮助模块时序图5 Database Design数据库设计暂无。6 Detailed Design of Module 模块详细设计6.1 GuideMap GuideMap类6.1.1 GuideMap GuideMap类的设计6.1.2 Overview简介本掌上导游系统在此模块中将会显示baidu Map，可以对其进行放大缩小操作，也可在卫星视图和地图视图中进行切换，可以显示当前位置，也能搜索某个地方的地图，两地间路线的查询 6.1.3 Class Diagram类图图7.1.3 GuideMap类图6.1.4 Attributes属性Visibility可见性Name属性名称Type类型Brief descriptions说明Privatepb1, pb2, pb3, pb4, pb5, pb6Button菜单按钮PrivatezoomCMapController地图控制器PrivatemGeoPointGeoPoint地理位置PublicmapVMapView地图视图PrivatelocationManagerLocationManager地点管理PrivatelocationListenerLocationListener地点监听器Publiclongitudedouble精度Publiclatitudedouble纬度PublicresultStringString结果字符publicprogressDialogProgressDialog进度条privatebuttonCamera, buttonDelete, buttonWith, buttonPlace, buttonMusic, buttonThought, buttonSleepButton菜单按钮privateanimationTranslate, animationRotate, animationScaleAnimation动画效果privatewidth, heightInt获得长宽privateparamsLayoutParams动画布局privateisClickboolean是否点击privatecontextContext内容6.1.5 Methods方法 Method1 onCreate方法的设计1、Method onCreate方法（1）Method Descriptions方法描述Prototype函数原型public void onCreate(Bundle savedInstanceState)Description功能描述显示地图Calls调用函数initialButton()Called By被调用函数无Input输入参数Bundle savedInstanceStateOutput输出参数无Return返回值voidException抛出异常无 Method2 onActivityResult方法的设计1、Method onActivityResult方法（1）Method Descriptions方法描述Prototype函数原型protected void onActivityResult(int requestCode, int resultCode, Intent data)Description功能描述获取经纬度信息Calls调用函数updateLocation()Called By被调用函数无Input输入参数int requestCode, int resultCode, Intent dataOutput输出参数无Return返回值VoidException抛出异常无 Method3 onCreateOptionsMenu方法的设计1、Method onCreateOptionsMenu方法（1）Method Descriptions方法描述Prototype函数原型public boolean onCreateOptionsMenu(Menu menu)Description功能描述打开菜单Calls调用函数无Called By被调用函数无Input输入参数Menu menuOutput输出参数menuReturn返回值super.onCreateOptionsMenu(menu)Exception抛出异常无 Method4 onMenuItemSelected方法的设计1、Method onMenuItemSelected方法（1）Method Descriptions方法描述Prototype函数原型public boolean onMenuItemSelected(int featureId, MenuItem item)Description功能描述设置菜单监听Calls调用函数无Called By被调用函数无Input输入参数int featureId, MenuItem itemOutput输出参数featureId, itemReturn返回值super.onMenuItemSelected(featureId, item)Exception抛出异常无 Method5 onDestroy方法的设计1、Method onDestroy方法（1）Method Descriptions方法描述Prototype函数原型protected void onDestroy()Description功能描述销毁程序Calls调用函数无Called By被调用函数无Input输入参数无Output输出参数无Return返回值VoidException抛出异常无 Method6 updateLocation方法的设计1、Method updateLocation方法（1）Method Descriptions方法描述Prototype函数原型private void updateLocation()Description功能描述更新经纬度显示Calls调用函数无Called By被调用函数onActivityResult()Input输入参数无Output输出参数无Return返回值VoidException抛出异常无 Method7 isRouteDisplayed方法的设计1、Method isRouteDisplayed方法（1）Method Descriptions方法描述Prototype函数原型protected void onDestroy()Description功能描述系统函数Calls调用函数无Called By被调用函数无Input输入参数无Output输出参数无Return返回值FalseException抛出异常无 Method8 drawRoute方法的设计1、Method drawRoute方法（1）Method Descriptions方法描述Prototype函数原型public void drawRoute(MapView v)Description功能描述画路线Calls调用函数无Called By被调用函数无Input输入参数MapView vOutput输出参数vReturn返回值VoidException抛出异常 Method9 initialButton方法的设计1、Method initialButton方法（1）Method Descriptions方法描述Prototype函数原型private void initialButton()Description功能描述按钮初始化Calls调用函数无Called By被调用函数onCreate()Input输入参数无Output输出参数无Return返回值VoidException抛出异常无0 Method10 setAnimScale方法的设计1、Method setAnimScale方法（1）Method Descriptions方法描述Prototype函数原型protected Animation setAnimScale(float toX, float toY)Description功能描述设置动画范围Calls调用函数无Called By被调用函数无Input输入参数float toX, float toYOutput输出参数无Return返回值animationScaleException抛出异常无1 Method11 animRotate方法的设计1、Method animRotate方法（1）Method Descriptions方法描述Prototype函数原型protected Animation animRotate(float toDegrees, float pivotXValue, float pivotYValue)Description功能描述按钮旋转Calls调用函数无Called By被调用函数无Input输入参数float toDegrees, float pivotXValue, float pivotYValueOutput输出参数无Return返回值animationRotateException抛出异常无2 Method12 animTranslate方法的设计1、Method animTranslate方法（1）Method Descriptions方法描述Prototype函数原型protected Animation animTranslate(float toX, float toY, final int lastX, final int lastY,final Button button, long durationMillis)Description功能描述动画动作Calls调用函数无Called By被调用函数无Input输入参数float toX, float toY, final int lastX, final int lastY,final Button button, long durationMillisOutput输出参数无Return返回值animationTranslateException抛出异常无3 Method13 onStop 方法的设计1、Method onStop 方法（1）Method Descriptions方法描述Prototype函数原型protected void onStop()Description功能描述结束Calls调用函数无Called By被调用函数无Input输入参数无Output输出参数无Return返回值VoidException抛出异常无7 Detailed Design of Module 商户模块详细设计7.1 StoreInfo类的设计7.1.1 Overview简介该类继承Activity类，实现向用户展示商户详细信息的功能，商户详细信息包括：商户ID（数据库中自增ID）,商户名称，类型，商户描述。7.1.2 Class Diagram类图7.1.3 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions 说明（对属性的简短描述）privatestoreIdTextView商户ID（数据库自增产生）private storeNameTextView商户名称privatestoreInfoTypeTextView类型privatestoreInfoDisTextView商户信息描述privatedeleteButton删除商户详细信息7.1.4 Methods方法 Method1 onCreate方法（1）onCreate方法描述Prototype 函数原型protect void onCreate(Bundle savedInstanceState)Description 功能描述 初始化Activity中各控件。Calls 调用函数queryById ()Called By 被调用函数无Input 输入参数Bundle savedInstanceStateOutput 输出参数 无Return 返回值VoidException 抛出异常无 Method2 queryById方法（1）Method Descriptions方法描述Prototype 函数原型 Public void Cursor queryById(int id)Description 功能描述通过商户ID查询商户详细信息Calls 调用函数.1 query(String table, String columns, String selection, String selectionArgs, String groupBy, String having, String orderBy)Called By 被调用函数onCreate（）Input 输入参数id: 商户编号Output 输出参数无Return 返回值Cursor对象其中保存查询到的商户具体信息。Exception 抛出异常无7.2 StoreList 类的设计7.2.1 Overview简介该类继承Activity类，实现以列表的形式向用户展示商户概要信息的功能，列表中信息具体包括：商户ID，商户名称。另通过点击列表中特定项能够进入该项的详细信息页面。7.2.2 Class Diagram类图7.2.3 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions 说明（对属性的简短描述）privatedbHelperDataBaseHelper 通过此对象完成对数据库的操作7.2.4 Methods方法 Method1 onCreate方法（1）onCreate方法描述Prototype 函数原型protect void onCreate(Bundle savedInstanceState)Description 功能描述 初始化Activity中各控件。Calls 调用函数setAdapter()Called By 被调用函数无Input 输入参数Bundle savedInstanceStateOutput 输出参数 无Return 返回值VoidException 抛出异常无（2）Implementation Descriptions 实现描述protected void onCreate(Bundle savedInstanceState) 调用父类onCreate方法；初始化控件；调用setAdapter()方法; Method2 onListItemClick方法（1）Method Descriptions方法描述Prototype 函数原型 protected void onListItemClick(ListView l, View v, int position, long id)Description 功能描述相应列表点击事件，转到商户详细信息Calls 调用函数.1 无Called By 被调用函数无Input 输入参数ListView l, View v, int position, long idOutput 输出参数无Return 返回值无Exception 抛出异常无 Method3 onResume方法（1）Method Descriptions方法描述Prototype 函数原型 protected void onResume()Description 功能描述 更新列表信息Calls 调用函数setAdapter()Called By 被调用函数无Input 输入参数无Output 输出参数无Return 返回值无Exception 抛出异常无 Method4 setAdapter方法（1）Method Descriptions方法描述Prototype 函数原型 public void setAdapter()Description 功能描述 显示列表信息Calls 调用函数 setListAdapter().1 query(String table, String columns, String selection, String selectionArgs, String groupBy, String having, String orderBy)Called By 被调用函数onResume（），onCreate（）Input 输入参数无Output 输出参数无Return 返回值无Exception 抛出异常无8 Detailed Design of Module 路线模块详细设计8.1 Class GetWays类的设计8.1.1 Overview简介通过发送http请求，给出起始点和目标点的经纬度坐标，返回JSON文件，JSON文件中包含最优的行进路线的各个点以及距离、行走时间等重要信息。可以对JSON文件进行解析获取信息，方便用户查询旅游。8.1.2 Class Diagram类图图6.3 GetWays类图8.