基于地图定位的场景交互游戏设计说明书

设计说明书

Invisible War

基于地图定位的场景交互游戏（iOS）

目录

第1章 数据库设计 (4)

1.1 数据库总体设计 (4)

1.2 数据库结构设计 (4)

第2章 接口设计 (9)

2.1 接口数据交换格式 (9)

2.2 基于HTTP的网络请求 (9)

2.3 相关接口设计 (9)

2.3.1注册接口 (9)

2.3.1登录陆口 (10)

2.3.3获取塔信息接口 (11)

2.3.4使用步数换取能量接口 (13)

2.3.5获取日志信息接口 (13)

第3章 服务开发运行环境 (15)

3.1 接口运行环境 (15)

3.2 接口发布环境 (15)

第4章 系统设计 (16)

4.1 系统的总体设计 (16)

4.1.1 模型（Model） (16)

4.1.2 视图（View） (16)

4.1.3 控制器（Controller） (17)

4.2 底层模块设计 (17)

4.2.1网络请求模块封装设计 (17)

4.2.2 全局单例模式设计 (17)

4.3 注册登录模块设计 (18)

4.3.1 功能描述 (18)

4.3.2 逻辑设计 (18)

4.4 地图定位模块设计 (19)

4.4.1 功能描述 (19)

4.4.2 逻辑设计 (19)

4.5 能量工厂模块设计 (20)

4.5.1 功能描述 (20)

4.5.2 逻辑设计 (20)

4.6 攻击/加固模块设计 (20)

4.6.1 功能描述 (20)

4.6.2 逻辑设计 (20)

4.7 放置模块设计 (21)

4.7.1 功能描述 (21)

4.7.2 逻辑设计 (21)

4.8 背包模块设计 (22)

4.8.1 功能描述 (22)

4.8.2 逻辑设计 (22)

4.9 个人模块设计 (22)

4.9.1 功能描述 (22)

4.9.2 逻辑设计 (22)

第1章数据库设计

1.1 数据库总体设计

以下是数据库总体设计的ER图，图中包括了数据库设计中所有的关系，以及所有需要的属性以及实体。

图 1 IW数据库总体ER图

1.2 数据库结构设计

以下是数据库结构设计:

表1-1 游戏用户表（iw_users）

字段名 字段描述 类型 约束 示例

uid 用户的 UID int(11) PK 1

user_name 用户名 varchar(255) NN 用户名

user_power 用户总能力值 int(8) NN 1000

user_powernow 用户当前能力值 int(8) NN 500

device_code 设备码，唯一标识 varchar(255) NN 20150555 avatar_file 头像文件 varchar(128) NN touxiang.png step_num 用户当前行走步数 int(8) NN 100

update_time 最新更新步数时间 datetime NN 2016-04-10

00:00:00

reg_time 注册时间 datetime NN 2016-04-10

00:00:00

last_login 最后登录时间 datetime NN 2016-04-10

00:00:00 forbidden 是否禁止用户 tinyint(1) NN 0

belong_group 用户阵营 tinyint(1) NN 0

表1-2 宝塔表（iw_pagoda）

字段名 字段描述 类型 约束 示例

pid 宝塔的ID int(11) PK 1

pname 塔名称 varchar(255) NN 名称

uid 占领用户 int(11) NN FK 1

longitude 经度 double(32,24) NN 34.1111 latitude 纬度 double(32,24) NN 117.1111 pphoto 宝塔图标 varchar(128) NN baota.png belong_group 所属阵营 tinyint(1) NN 0

pintro 宝塔描述 text NN 这是一座塔

表1-3 物品总表（iw_item）

字段名 字段描述 类型 约束 示例

item_id 物品ID int(11) PK 1

item_type_id 分类的物品ID int(11) NN 1

item_type 物品类别 int(11) NN 1

item_name 物品名称 varchar(255) NN 武器

item_photo 物品图标 varchar(128) NN item.png

item_quality 稀有度 int(8) NN 0

item_intro 物品描述 text NN 这是一个物品

表1-4 装置表（iw_package）

字段名 字段描述 类型 约束 示例

unitid 装置的ID int(11) PK 1

item_id 物品ID int(11) NN FK 1

uhp 装置血量 int(8) NN 100

uatk 装置攻击力 int(8) NN 100

udef 装置防御力 int(8) NN 100

collect_effi 采集效率 int(8) NN 100

con_energy 需要消耗的能力 int(8) NN 100

lifetime 生命期 int(8) NN 100

表1-5 武器表（iw_package）

字段名 字段描述 类型 约束 示例

wid 武器的ID int(11) PK 1

item_id 物品ID int(11) NN FK 1

wpower 使用需耗费能量值 int(8) NN 100

watk 武器攻击力 int(8) NN 100

eff_type 武器效能类型 int(8) NN 1

eff_level 武器效能级别 int(8) NN 1

表1-6 土地表（iw_field）

字段名 字段描述 类型 约束 示例

fid 武器的ID int(11) PK 1

pid 所属宝塔ID int(11) NN FK 1

uid 装置所属人ID int(11) NN 1

unitid 所放装置的ID int(11) NN 1

set_time 放置时间 datetime NN 2016-04-10

00:00:00

fhp 所剩血量 int(8) NN 100

fatk 土地的攻击力 int(8) NN 100

fdef 土地的防御力 int(8) NN 100

collect_effi 采集效率 int(8) NN 100

expire_time 到期时间 datetime NN 2016-04-10

00:00:00 fnumber 土地编号 int(8) NN 1

fintro 土地描述 text 这是一块土地

表1-7 宝塔掠夺日志表（iw_pagoda_log）

字段名 字段描述 类型 约束 示例

id 日志ID int(11) PK 1

uid 用户ID int(11) NN FK 1

pid 宝塔 ID int(11) NN FK 1

content 日志内容 varchar(256) NN 攻击了这座塔 msg_type 日志分类 tinyint(1) NN 1

add_time 发布时间 datetime NN 2016-04-10

00:00:00

表1-8 用户物品关联表（iw_users_item）

字段名 字段描述 类型 约束 示例

id 关联ID int(11) PK 1

uid 用户ID int(11) NN FK 1

item_id 物品ID int(11) NN FK 1

item_type 物品类别 tinyint(1) NN 1

item_num 物品数量 int(8) NN 1

表1-9 宝塔掠夺日志表（iw_users_pagoda）

字段名 字段描述 类型 约束 示例

id 日志ID int(11) PK 1

uid 用户ID int(11) NN FK 1

pid 宝塔 ID int(11) NN FK 1

rob_time 上一次掠夺时间 datetime NN 2016-04-10

00:00:00

表1-10 用户状态表（iw_users_status）

字段名 字段描述 类型 约束 示例

id 状态的ID int(11) PK 1

uid 用户ID int(11) NN FK 1

content 状态内容 varchar(256) NN 啊哈 longitude 经度 double(32,24) NN 34.1111 latitude 纬度 double(32,24) NN 117.1111 rob_time 发布时间 datetime NN 2016-04-10

00:00:00 flag 状态查看权限 tinyint(1) NN 1

表1-11 能量包表（iw_energy）

字段名 字段描述 类型 约束 示例 eid 能量包的ID int(11) PK 1 item_id 物品ID int(11) NN FK 1 epower 能量值 int(8) NN 1

表1-12 包裹表（iw_package）

字段名 字段描述 类型 约束 示例 pgid 包裹的ID int(11) PK 1 item_id 物品ID int(11) NN FK 1

第2章接口设计

2.1 接口数据交换格式

接口采用轻量级的JSON作为数据交换格式。JSON 是一种轻量级的数据交换格式，采用了类似于 C 语言家族的习惯（如 C，C++，Java 等），但是本身是一种独立于语言之外的文本格式，既便于开发者阅读和编写，同时也易于机器解析和生成。

本系统在与服务器交换过程便是采用这种类型的数据，在部分本地数据的存储和应用上提供类似的构造和解析操作接口，并且在部分存储过程，也直接采用 JSON 格式写入数据库。

2.2 基于HTTP的网络请求

客户端集成了HttpClient，可以直接使用HttpClient来发送HTTP请求，其实质就是把HTTP请求模拟后发给服务器。

Http连接请求包括Post方法和Get方法，Get方法获取网络服务链接数据的一般步骤如下：

1. 构造HttpClient对象，管理请求。

2. 构造HttpGet对象，向服务器发起请求。

3. 发起请求，获得HttpResponse对象，从中读取数据。

Post请求的构造相较于Get要复杂一些，需要将应用提交至服务器的数据打包放入请求对象中，比如表单数据可以通过UrlEncodedFormEntity对象构造，二进制数据可以通过ByteArrayEntity对象封装。

一般情况下，DefaultHttpClient对象是线程非安全的，不能在多个线程中同时调用DefaultHttpClient对象的方法，要保证HttpClient的线程安全性，可以设置线程安全的管理对象或者选择使用AndroidHttpClient对象来替代DefaultHttpClient。

2.3 相关接口设计

根据系统需要，我们总共设计了14个接口，包括注册接口、登录接口、使用步数换取能量接口、获取塔信息接口、获取用户物品背包接口、使用武器接口、获取日志接口等。下面选取部分代表接口做主要描述。

2.3.1注册接口

1.接口说明

客户端用户注册接口

请求方式：POST、GET

2. 传入参数

参数 必选 类型及范围 说明

device_code true string 机器设备码

username true string 用户名

group true int 所属势力 1 => A势力，2 => B势力

3. 返回值

字段 类型及范围 说明

data string/json

uid int 用户 UID

username string 用户名

laststep_time string 上一次将步数换成物品的时间

laststep int 上一次将步数换成物品后剩余步数

user_powernow int 目前的能量

user_power int 用户总能量

group int 用户所属阵营 1 => A势力，2 => B势力

isRegisted int 该设备码是否已被注册过 0 =>未注册，1 => 已注册

code int 错误码

msg string 错误信息

2.3.1登录陆口

1.接口说明

客户端登录接口

请求方式：POST、GET

2. 传入参数

参数 必选 类型及范围 说明 device_code true string 机器设备码

3. 返回值

字段 类型及范围 说明

data string/json

uid int 用户 UID

username string 用户名

laststep_ti

me

string 上一次将步数换成物品的时间 laststep int 上一次将步数换成物品后剩余步数 user_powern

ow

int 目前的能量

user_power int 用户总能量

group int 用户所属阵营 1 => A势力，2 => B势力

isRegisted int 该设备码是否已被注册过 0 => 未注册，1 => 已注册

code int 错误码

msg string 错误信息

2.3.3获取塔信息接口

1. 接口说明

获取塔信息接口

请求方式：POST、GET

2. 传入参数

参数 必选 类型及范围 说明 device_code true string 机器设备码 portal_id true int 入侵的能量源id

3. 返回值

字段 类型及范围 说明

data string/json

具体信息见示例

code int 错误码

msg string 错误信息

4. 接口返回核心信息示例

"portal_info": {

"portal_atk": 200,

"portal_owner_id": 4,

"portal_lon": 116.31721739558647,

"portal_lat": 39.96803111070252,

"portal_lands": [

{

"lands_unit_quality": "1",

"lands_index": 1,

"lands_time": "2016-04-20 15:56:32.0",

"lands_def": 20,

"lands_unit_gain": "50",

"lands_intro": "",

"lands_unit_name": "Uuo能量采集器Lv1",

"lands_unit_intro": "用于采集Uuo能量的装置，能够为工厂提高采集效率", "lands_id": 1,

"lands_unit_hp": "250",

"lands_unit_type": 1,

"lands_unit_photo":

"http://120.27.92.220/Photo/Unit_Photo/collector.png",

"lands_atk": 0,

"lands_gain": 50,

"lands_unit_def": "0",

"lands_unit_atk": "0",

"lands_hp": 835,

"lands_username": "admin",

"lands_uid": 1,

}

],

"portal_photo": "http://120.27.92.220/Photo/Portal_Photo/1.jpg", "portal_id": 1,

"portal_intro": "软件学院门口的石碑",

"portal_group": 1,

"portal_name": "BIT软件石碑",

"portal_gain": 115,

"portal_owner_name": "Ccyuan"

}

2.3.4使用步数换取能量接口

1. 接口说明

客户端使用步数兑换能量接口

访问地址：http://120.27.92.220:30001/?if=StepsToEnergy 请求方式：POST、GET

2. 传入参数

参数 必选 类型及范围 说明 device_code true string 机器设备码

uid true int 用户ID

stepnum true int 用户今天行走总步数

3. 返回值

字段 类型及范围 说明 data string/json

uid int 用户 UID

energy_now int 用户目前能量值 alsteps int 用户今天已兑换步数 code int 错误码

msg string 错误信息

2.3.5获取日志信息接口

1. 接口说明

客户端获取日志信息接口

请求方式：POST、GET

2. 传入参数

参数 必选 类型及范围 说明

pid true int 塔 ID

logid false int 上一页最后一条数据的 ID limit false int 每页数据条数

msg_type false int 日志类型 0 => 系统日志；1 => 用户发送

3. 返回值

字段 类型及范围 说明 data string/json

uid int 产生该条日志记录的用户 ID

username string 用户名

user_photo string 用户头像

group int 用户所属阵营 1 => A势力，2 => B势力 pid int 塔 ID

logid int 日志 ID

content string 日志内容

msg_type int 日志类型 0 => 系统日志；1 => 用户发送 add_time string 添加时间

code int 错误码

msg string 错误信息

第3章服务开发运行环境3.1 接口运行环境

n操作系统：windows 8.1

n浏览器：Chrome浏览器

n测试环境：jdk 1.7.0

n数据库：MySql 3.4.10.1

n开发工具：Eclipse 4.3.2

3.2 接口发布环境

n操作系统：CentOS 7.0

n测试环境：jdk 1.7.0

n数据库：MySql 3.4.10.1

n其他环境：Apache

第4章客户端设计

4.1 系统的总体设计

模型-视图-控制器（Model-View-Controller，MVC）是当前被广泛应用的一种软件架构。在Apple公司搭建的SDK中，MVC架构的优点得到了充分的发挥，使得软件的开发与管理过程得到了简化，其中MVC之间的通信关系如下图4-1所示。

图4-1 iOS中的MVC关系图

4.1.1 模型（Model）

模型对象封装了软件中的数据，并且定义了数据的操作和处理数据的逻辑和运算。例如在本应用中，模型对象可能是储存于本地的聊天数据。用户在视图中所进行的创建或修改数据的操作，通过控制器对象来与模型对象交互，最终会创建或更新模型对象。模型对象发生变化时（例如通过网络连接接收到新数据），它会通知控制器对象，控制器对象再更新相应的视图对象。

4.1.2 视图（View）

视图对象指的是软件中用户可以看见的对象，例如界面上的控件等元素，视图对象中定义了其自身的绘制方法，并可以对用户的操作作出响应。视图对象的主要目的，是用来显示来自软件中模型对象的数据，并使该数据在功能允许的情

况下被用户编辑。但是，在使用MVC架构的软件中，视图对象通常与模型对象分离，不直接进行交互，而是通过控制器对象来传达操作。

在iOS应用程序开发中，所有的控件、窗口等都继承自 UIView，对应MVC 中的V。UIView及其子类主要负责UI的实现，而UIView所产生的事件都可以采用委托的方式，交给UIViewController实现。

4.1.3 控制器（Controller）

在应用程序的视图对象和模型对象之间，控制器对象以中间人的角色存在。控制器对象是同步管道程序，视图对象通过控制器对象了解模型对象的变化，反之亦然。控制器对象还可以为软件执行设置和协调任务，并管理其他对象的生命周期。

控制器对象对视图对象中进行的用户操作进行处理，并将新的或被更改过的数据传达给模型对象。模型对象发生变化时，控制器对象会将新的模型数据传达给视图对象，以便视图对象可以重新显示它。

对于不同的UIView，有相应的UIViewController，对应MVC中的C。例如在iOS上常用的UITableView，它所对应的Controller就是UITableViewController。

4.2 底层模块设计

4.2.1网络请求模块封装设计

本应用中的网络请求部分使用了AFNetWorking开源库，由于本应用的服务端接口处采用统一的返回格式，其中包括了登录失效的消息，因此对AFNetWorking进行了二次封装，使得本应用中所有的网络请求都使用封装过后的AFNW类，开发过程中根据功能模块的区分，为每个模块单独创建网络请求的工具类。在AFNW类中对于接口的返回值进行初步的解析，当解析到用户的登录失效信息时，将会要求用户进行重新登录操作，随后再通过工具类中传入的Block参数，将接口返回的数据传入Block并执行回调。

4.2.2 全局单例模式设计

在iOS中，类的单例模式设计使用Grand Central Dispatch（GCD）编程，其原理是通过声明返回值为单例类对象的类方法，在类方法中声明单例类的静态强变量，通过GCD对单例类的初始化进行控制，使得单例类只在第一次被使用时进行初始化并赋值于静态变量返回，由此即可实现类的单例模式。

游戏应用中设计了三个单例类，IWLocationManager类，IWUserInfo类和IWHeartbeatModel类。

IWLocationManager类是用于用户定位的单例类，由于地位功能贯穿于整个游戏的流程之中，因此将其设计为单例，能够供所有组件在任何时机获取到用户

所在的位置信息。

IWUserInfo类是用于存储用户信息的类，由于在应用中存在大量需要使用用户ID、设备UUID、背包信息等数据的地方，因此将这些信息存储于单例模式下的IWUserInfo类中。

IWHeartbeatModel类是用于游戏后台定期更新数据用的数据维护类，其中设置了多个NSTimer计时器，针对背包信息、用户周边工厂信息、聊天信息，IWHeartbeatModel类会定期调用服务端接口更新数据。同时，IWHeartbeatModel 类声明了Delegate协议，能够在数据更新完毕后，通过观察者模式，通知所有注册过的观察者对象。

4.3 注册登录模块设计

4.3.1 功能描述

注册登录模块负责新用户的注册，以及老用户的登录功能。游戏中的用户通过UUID无需密码自动登录，注册的用户需要先观看一段对故事背景的描述动画，然后需要选择阵营，并输入用户名，确认后即可完成注册。登录的用户需要获取用户的定位信息，背包信息，位置附近的工厂信息，获取完毕后才能进入地图界面。

4.3.2 逻辑设计

注册功能：

1、进入游戏后获取设备UUID

2、将UUID发送到服务端检验是否已登录

3、若已注册，则进入登录功能

4、若未注册，则开始播放背景描述动画

5、动画播放完毕后，显示用户阵营选择界面

6、用户选择阵营后，填写用户名

7、发送至服务端确认无误后，进入登录功能

登录功能：

1、根据UUID获取用户信息

2、根据userid获取用户背包信息

3、开启手机定位，获取位置信息

4、根据位置信息，获取附近工厂信息

5、若1~4中任意一组信息获取失败，则重复失败的操作，直到成功

6、信息获取完整后，进入地图定位界面

4.4.1 功能描述

地图定位使用百度地图，界面中需要显示用户当前的位置，以及周围工厂的标识信息，点击工厂后会出现新的气泡窗，显示工厂的名称、势力和与用户的距离。同时需要在聊天信息和工厂信息更新后，刷新地图上的标识和消息栏的内容。同时地图定位模块中包含了公频聊天功能，用户可以查看和发送公频消息。用户可以在界面中查看自己当前行动能量。

4.4.2 逻辑设计

进入界面后：

1.从IWUserInfo类中获取周边工厂的信息，并与地图上的标识核对，若有变动则修改

地图上的标识。

2.刷新公频聊天消息栏中的信息。

用户位置更新后：

1、更新地图上的显示位置

2、如果新的位置距离上一次获取周边工厂信息的位置超过限定范围，则调用接口获取

新位置附近的工厂信息

3、更新气泡窗中选中工厂与用户的距离

工厂信息更新后：

1、从IWUserInfo类中获取周边工厂的信息，并与地图上的标识核对，若有变动则修改

地图上的标识。

用户点击收起的消息栏：

1、将消息栏变为展开状态。

消息栏在展开状态下，用户点击地图：

1、将消息栏变为收起状态。

用户输入完毕点击发送：

1、调用发送公频消息接口，若成功则保存消息信息，并刷新消息栏内容

用户点击某个工厂的标识：

1、若已存在气泡窗，移除原来的气泡窗

2、显示这个工厂的气泡窗，并显示工厂信息和与用户距离

3、将地图中心设置为标识所在位置

用户点击气泡窗：

1、进入该工厂的工厂信息界面

用户点击地图：

1、若已存在气泡窗，则移除气泡窗

4.5.1 功能描述

能量工厂模块为用户提供查看能量工厂信息的功能，包括查看工厂照片、工厂所有者、工厂周围的防御装置、查看和发送工厂日志、搜索工厂的功能。用户通过点击地图定位中的气泡窗进入能量工厂信息界面。

4.5.2 逻辑设计

进入界面后：

1、从IWUserInfo类中获取本工厂的信息，并刷新界面上的显示信息

2、刷新工厂日志的显示内容

工厂信息更新后：

1、从IWUserInfo类中获取本工厂的信息，并与地图上的标识核对，若有变动则修改地

图上的标识。

日志信息更新后：

1、刷新工厂日志的显示内容

发送日志消息后：

1、刷新工厂日志的显示内容

点击搜索后：

1、调用搜索工厂接口，若成功则显示获得的道具，并将背包信息存入IWUserInfo类中

2、若失败则显示失败信息

4.6 攻击/加固模块设计

4.6.1 功能描述

攻击/加固模块为用户显示工厂周围装置的具体信息，同时显示用户背包中可以使用的道具，用户选择某个装置和某个道具后，可以点击使用来对装置进行攻击/加固的操作。

攻击装置界面只有与工厂敌对势力的用户可以进入，同势力的用户进入加固装置界面。攻击界面中只会显示用户拥有的攻击性武器和能量罐，加固界面中只会显示用户拥有的增强性武器和能量罐。

4.6.2 逻辑设计

进入界面：

1、如果工厂与用户同势力，则显示加固界面

2、如果工厂与用户敌对势力，则显示攻击界面