Hebook项目设计说明书

原創 _Summer tree 2019-08-29 00:44

Hebook 软件设计说明书

1 Hebook内容描述

Hebook定位于人脉信息管理平台，帮助用户存储、查询复杂的人脉信息，并基于对人脉信息的分析和推断，给用户提供人脉管理方案推荐。

主要功能模块

  • 存储查询人脉信息
  • 人脉信息统计与分析
  • 人脉管理推荐

2 需求分析

2.1 角色分类

序号 名称 描述 权限
1 游客（Tourist） 脱机使用Hebook的群体 1 增删查改联系人信息 （信息本地存储）
2 用户（User） 使用Hebook的注册用户 1、查改看个人资料 2 增删查改联系人信息 3 查看人脉统计分析信息
3 VIP用户 使用Hebook的VIP用户 1、查改看个人资料 2 增删查改联系人信息 3查看人脉统计分析信息 4 查看人脉管理方案推荐

备注：对没有的权限项，在不必要的情况下，系统可以不生成

2.2 功能需求

2.2.1 功能需求总表

编号 功能需求名称 优先级别
fun01 注册用户 ，填写用户信息 高
fun02 用户管理个人信息 高
fun03 添加联系人 ，填写联系人信息 高
fun04 修改联系人信息 高
fun05 删除联系人 高
fun06 查看联系人信息，提供筛选、排序、搜索功能 高
fun07 人脉信息统计与分析 中
fun08 人脉管理推荐 底

2.2.2 功能需求描述

fun01：注册用户，填写用户信息
【功能概述】注册用户，填写注册信息，如登录手机号和密码设置等。 用户信息包括 姓名、性别、出生日期等，皆为非必填项目
【操作者】游客

fun02：用户管理个人信息
【功能概述】用户可对姓名、性别等个人信息进行修改管理。
【操作者】用户

fun03：添加联系人 ，填写联系人信息
【功能概述】游客或用户可以添加联系人，填写姓名、性别等信息。其中，与中间人关系、姓名，性别为必填项。
【操作者】游客、用户

fun04：修改联系人信息
【功能概述】游客或用户可以修改联系人信息，如姓名、性别等信息。
【操作者】游客、用户

fun05：删除联系人
【功能概述】游客或用户可以修改联系人。
【操作者】游客、用户

fun06：查看联系人信息，提供筛选、排序、搜索功能
【功能概述】游客和用户可以查看已添加的联系人信息，并可以按照联系人的相关信息信息筛选、排序以及搜索。
【操作者】游客、用户

fun07：人脉信息统计与分析
【功能概述】系统根据用户存储的人脉信息，对数据进行统计和分析，给出用户的相关人脉状况，如年龄分布，性别比列，职业领域，地域分布等。
【操作者】 系统

fun08：人脉管理推荐
【功能概述】系统根据用户存储的人脉信息，对用户的人脉管理进行推荐，如节日祝福提醒，好友生日提醒，久未联系提醒等。
【操作者】系统

2.3 用例图设计建模

在这里插入图片描述

2.4 实体属性分析

在这里插入图片描述

2.4 类图设计建模

在这里插入图片描述

2.4 组件图设计建模

在这里插入图片描述

3 数据库设计

3.1 设计规则

类名 全大写
表名 首字母大写
其他 全部小写 。 多词用下划线_连接
每个表都有create_time,update_time,is_delete字段

3.2 User

名称 CODE 类型 描述 可否为空 初始化
用户ID user_id char U000001(U开头) 否 表长度
登录账号 account int 11位手机号 否
登录密码 password char 密文格式存储 否
是否VIP is_vip bool 0 不是vip 1 是vip 否 0
联系人总数 contact_count int 所有联系人的总数 否 0
姓名 name char 这个项目注册的时候不会填写，所以需要默认值 否 user_id
性别 gender bool 0 女 1 男
出生日期 birthdate time
联系电话1 phone_number1 int
联系电话2 phone_number2 int
社会状态 status int 0 在读 1 在职 2 退休 3 无业
现居地 residence char
籍贯 birthplace char
婚姻状态 marital_status int 0 单身 1 恋爱 2 已婚

3.3 Contact

名称 CODE 类型 描述 可否为空 初始化
联系人ID contact_id char C000001（C开头） 否 表长度
用户ID user_id char user_id 外码 否 来源
总分 score int 评分计算规则？ 否 60
未联系天数 untouch_day int 自建立好友关系以来 否 0
主动联系次数 contact_count_a int 否 1
被动联系次数 contact_count_b int 否 0
联系总次数 contact_count int 主动+被动 否 1
联系码 contact_code int 180位记录半年来的联系情况 0 未联系 1 主动 2 被动 3 互动 否 0
联系频率 contact_frequency float 联系总次数 / (当前时间-创建时间+1) 否 1
关系等级 class int 1 挚友 2 好友 3 朋友 4 相识 5 存在 否 3
关系人 associated char user_id/contact_id 否 页面来源
关系 relationship int 0 家人 1 亲戚 2 朋友 3 同学 4 同事 5 老师 6 领导 7 特别关注 8 其他 否 2
姓名 name char 否
性别 gender bool 0 女 1 男
出生日期 birthdate time
联系电话1 phone_number1 int
联系电话2 phone_number2 int
社会状态 status int 0 在读 1 在职 2 退休 3 无业
现居地 residence char
籍贯 birthplace char
婚姻状态 marital_status int 0 单身 1 恋爱 2 已婚

3.4 Education

名称 CODE 类型 描述 可否为空 初始化
教育ID education_id int 否 表长度
人物ID person_id char user_id/contact_id 外码 否 来源
开始时间 start_time time
结束时间 end_time time
学历 academic int 0 高中 1 专科 2 本科 3 硕士 4 博士 5 博后 6 硕博
学校名称 school char 否
专业 major char
领域 field char 学习或研究领域

3.5 Job

名称 CODE 类型 描述 可否为空 初始化
工作ID job_id int 否 表长度
人物ID person_id char user_id/contact_id 外码 否 来源
开始时间 start_time time
结束时间 end_time time
公司名称 company char 否
薪资 salary float
薪资单位 salary_unit int 0 月薪 1 年薪 否 0
工作地点 work_place char
职位 position char

3.6 Mark （* - * ）

名称 CODE 类型 描述 可否为空 初始化
标签ID mark_id int 否 表长度
用户ID user_id char user_id （user拥有一个mark 列表）外码 否 来源
标签名称 mark_name char 否
标签占有数 mark_holder int 拥有这个标签的联系人的总数 否 0

3.7 Prefer（* - * ）

名称 CODE 类型 描述 可否为空 初始化
偏好ID prefer_id int 否 表长度
用户ID user_id char user_id （user拥有一个prefer 列表） 否 来源
偏好名称 prefer_name char 否
偏好类型 prefer_type int 0 喜好 1 讨厌 否 0
偏好占有数 prefer_holder int 拥有这个偏好的联系人的总数 否 0

3.8 Authorization

名称 CODE 类型 描述 可否为空 初始化
授权ID authorization_id int 否 表长度
用户ID user_id char 否 来源
应用名称 app_name int 0 微信 1 QQ 2 微博 （目前只考虑这三个平台） 否
账号 app_account char 第三方平台的账号 否
授权码 authorzation_code char 能有效登录第三方平台

3.9 Social_app（根据 命名自行匹配）

名称 CODE 类型 描述 可否为空 初始化
社交ID socia_id int 否 表长度
联系人ID contact_id char 外码 否
社交平台 social_platform int 0 微信 1 QQ 2 微博 （目前只考虑这三个平台） 否
社交账号 social_account char 每个平台的用户ID不一样 否

3.10 Contact_description

名称 CODE 类型 描述 可否为空 初始化
描述ID descript_id int 否 表长度
联系人ID contact_id char 用于描述联系人 外码 否 来源
描述内容 descript_content char 否

3.11 Contact_mark （关系表）

名称 CODE 类型 描述 可否为空 初始化
联系人ID contact_id char C000001（C开头） 否 表长度
标签ID mark_id int 否 表长度

3. 12 Contact_prefer （关系表）

名称 CODE 类型 描述 可否为空 初始化
联系人ID contact_id char C000001（C开头） 否 表长度
偏好ID prefer_id int 否 表长度

4 UI设计

4.1 颜色说明

编号 名称 色号 显示 描述
01 主题色 00C88C 在这里插入图片描述
02 字体色1 4A4A4A 在这里插入图片描述 联系人名称、 主要信息
03 字体色2 9B9B9B 在这里插入图片描述 附加信息、提示信息
04 模块背景色1 FCFCFC 在这里插入图片描述 下拉栏模块背景色
05 模块背景色2 F1F1F2 在这里插入图片描述 列表间隔色
06 输入框边框色 D8D8D8 在这里插入图片描述 也用作 holdplace 字体色
07 统计色-红 EB5F53 在这里插入图片描述
08 统计色-橙 F6B949 在这里插入图片描述 也用作提示信息
09 统计色-蓝 4CB6E9 在这里插入图片描述
10 统计色-绿 7DB19C
11 统计色-紫 9268C7 在这里插入图片描述
12 统计色-深蓝 6586A0 在这里插入图片描述

4.2 字体说明

编号 名称 字体 字号 描述
01 主题 -Hebook 微软雅黑 24px B B即为加粗的意思
02 一级字体 微软雅黑 18px 用于标题等醒目内容
03 button 字体 微软雅黑 18px B
04 二级字体 微软雅黑 14px
05 三级字体 微乳雅黑 12px 用为提示信息

4.3 UI设计说明

底部导航栏：

  • 联系人
  • 统计
  • 我的

在这里插入图片描述

使用方式：

  • 登录
    可使用 联系人、统计、我的 三个模块
  • 游客
    只能使用联系人 一个模块
    在这里插入图片描述

第三方登录支持方式：

  • 微信
  • QQ
  • 微博
    在这里插入图片描述

注册方式：

  • 账号为手机号，获得验证码。 密码只输入一遍，可以通过点击 👁 按钮确定密码。
    在这里插入图片描述

联系人查找方式：

  • 搜索🔍 ：文字模糊查询，后期可提供语音输入
  • 筛选 ： 下拉按钮展开。采用【即时相应】的方式，也就是说不需要在设定好筛选项之后点确定。筛选项列表如下：
编号 筛选项 内容 描述
01 性别 0 女 1 男
02 年龄 0 0-18 1 18-26 2 26-40 3 40-100
03 社会状态 0 在读 1 在职 2 退休 3 无业
04 现居地 列出所有联系人中出现过的现居地（需要及时计算） 按数量从多到少排序，页面宽度不够时，左右滑动
05 籍贯 列出所有联系人中出现过的籍贯（需要及时计算） 按数量从多到少排序，页面宽度不够时，左右滑动
06 婚姻状态 0 单身 1 恋爱 2 已婚
07 标签 User维护的标签列表 且标签占有数不为0的标签 按数量从多到少排序，页面宽度不够时，左右滑动
08 偏好 User维护的偏好列表 且偏好占有数不为0的标签 按数量从多到少排序，页面宽度不够时，左右滑动
09 学校 列出所有联系人中出现过的学校（需要及时计算） 按数量从多到少排序，页面宽度不够时，左右滑动
10 公司 列出所有联系人中出现过的公司（需要及时计算） 按数量从多到少排序，页面宽度不够时，左右滑动
  • 排序 ： 默认按照 联系人的【总分】排序，提供 【未联系天数】、【关系等级】、【联系频率】排序。
    在这里插入图片描述

列表中显示的联系人信息：

  • 头像
  • 关系及等级
  • 未联系天数
  • 联系频率
  • 总分
    在这里插入图片描述

新建联系人

  • 红色区域内为必填信息 ，点击修改。图像使用默认图像
  • 若首先关联应用，则可从应用中自动匹配 联系人信息 ，自动填入。
  • 其余内容均为非必填项。
    在这里插入图片描述

联系人详情页面

  • 红色区域的信息由 【联系码】 提供，样式参照 GitHub。颜色设定如下：
适用情况 颜色 色号 描述
无联系 灰色 F1F1F2
主动联系 橙色 F6B949
被动联系 蓝色 4CB6E9
互动联系 绿色 7DB19C 既不能说主动，也不能算被动的情况
  • 蓝色区域是联系人的基本信息显示区域，只显示非空项。
  • 黄色区域均为下拉展开。

在这里插入图片描述

个人中心（我的）

  • Module 1 账户信息： 用户头像 、用户名称、登录账号（手机号）
  • Module 2 用户信息：只显式非空项
  • Module 3【 点击跳转选项卡】
    在这里插入图片描述

标签管理

  • 显示现有标签，点击表示【删除标签】，button会变成灰色，点击【完成】之后才会消失。 （后续可以将【标签】恢复变为【vip-支持】）
  • 在输入空内输入标签名称，点击【添加】后，出现在【现有标签】中，添加时【检查重复】，点击【完成】后才生效。

在这里插入图片描述

偏好管理

  • 偏好管理中，将【喜欢】和【讨厌】分开管理
  • 其他同上【标签管理】

在这里插入图片描述

统计报表

  • 直接显示项： 联系人总数即各级人脉比例（人数）、男女比例、年龄分布
  • 下拉展开项： 社会状态、婚姻状态、地域分布、领域分布
  • 高级统计项（vip-支持）：关系等级分布、联系频率分段（0.25，0.5.0，75）、总分分段（40，50，60，70，80，90）、标签统计（各个标签有多少人-可查看列表）、偏好统计（各个偏好有多少人-可查看列表）
    在这里插入图片描述

5 接口设计说明

5.1 综述

5.1.1统一的输入输出参数

response

参数名 类型 是否必须 描述
success int Y 0 失败； 1 成功
error_code int N 错误码
error_desc String N 错误消息

5.1.2 错误返回码列表

error_code error_desc
1 授权过期
500 服务器内部错误
600 账号被锁定（是否需要新增 锁定的标志位）
10005 手机验证码不正确
10006 手机验证码已失效
10011 原密码不正确（可能会用到）

5.2 用户接口

5.2.1 用户注册（user/signup）

item content
接口 user/signup
描述 用户注册
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
account int Y 注册手机号
password char Y 密码
verify_code int Y 验证码

验证码的正确与否，由后台检验。
前端传输密码的明文给后台。

Response

参数名 类型 是否必须 描述
s_id char Y
user_id char Y 用户ＩＤ

Example
Request

{
	"account":158**************,
	"password": " 123456 " ，
	"verify_code”:11111
}

Response

＃１错误情况
{
	"succeed":0,
	"error_code":10005,
	"error_desc":"手机验证码错误"
}

5.2.2　发送验证码(user/verify_code)

item content
接口 user/verify_code
描述 发送验证码
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
account int Y 注册手机号

Response
【统一返回】

5.2.3 修改密码(user/change_password)

item content
接口 user/change_password
描述 修改密码
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
account int Y 注册手机号
password int Y 初始密码
password_new int Y 新密码

Response
【统一返回】

5.2.4 用户登录　(user/signin)

item content
接口 user/signin
描述 用户登录
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
account int Y 注册手机号
password char Y 密码

Response

参数名 类型 是否必须 描述
user_id char Y 用户ＩＤ
s_id char Y

5.2.5 设置用户信息　(user/set_info)

item content
接口 user/set_info
描述 设置用户信息
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
s_id char Y 用户ＩＤ
user_id char Y
name char N
gender bool N 0 女，１男（若没有信息，则为NULL）
birthdate time N
phone_number1 int N
phone_number2 int N
state int N 0 在读　１在职　２退休　３无业
residence char N
birthplace char N
marital_status int N ０单身　１恋爱　２　已婚

用户根据需要修改信息，只提交有变更的信息。

Response
【统一返回】 设置成功或失败

5.2.6 授权第三方平台　(user/auth_app）*

item content
接口 user/ass_app
描述 授权第三方平台，用于登录等
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
app_name int Y
app_account char Y
authorzation_code char Y

Response

参数名 类型 是否必须 描述
authorization_id int Y

5.2.7 添加标签　(user/add_mark）

item content
接口 user/add_mark
描述 添加标签， 检测是否存在同名的标签，若有则直接修改其is_delete标志位
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
mark_name char Y

Response

参数名 类型 是否必须 描述
mark_id int Y

5.2.8 删除标签　(user/delete_mark）

item content
接口 user/delete_mark
描述 删除标签， 只修改is_delete标记位
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
mark_id int Y
mark_name char Y

Response
【统一返回】是否删除成功

5.2.9 获取标签列表　(user/get_mark）

item content
接口 user/get_mark
描述 获取标签列表
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y

Response

参数名 类型 是否必须 描述
marks Array Y
mark_id int Y
mark_name char Y
mark_holder int Y

5.2.10 获取用户信息　(user/get_info)

item content
接口 user/signin
描述 获取用户信息
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y

Response

参数名 类型 是否必须 描述
user Array Y 用户信息列表
user_id char Y 用户ＩＤ
is_vip bool Y
contact_count int Y
name char Y
gender bool Y 0 女，１男（若没有信息，则为NULL）
birthdate time Y
phone_number1 int Y
phone_number2 int Y
state int Y 0 在读　１在职　２退休　３无业
residence char Y
birthplace char Y
marital_status int Y ０单身　１恋爱　２　已婚

Example
Response

# 正常情况
{
	"succeed":1,
	"user":{
			"user_id":"U23422342",
			"is_vip":０，
			……

	}
}

5.2.11 添加偏好　(user/add_prefer）

item content
接口 user/add_prefer
描述 添加偏好， 检测是否存在同名的偏好，若有则直接修改其is_delete标志位
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
prefer_name char Y
prefer_type int

Response

参数名 类型 是否必须 描述
prefer_id int Y

5.2.12 删除偏好　(user/delete_prefer）

item content
接口 user/delete_prefer
描述 删除偏好， 只修改is_delete标记位
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
prefer_id int Y
prefer_name char Y

Response
【统一返回】是否删除成功

5.2.13 获取偏好列表　(user/get_prefer）

item content
接口 user/get_prefer
描述 获取偏好列表
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y

Response

参数名 类型 是否必须 描述
prefers Array Y
prefer_id int Y
prefer_name char Y
prefer_holder int Y
prefer_type int Y

5.3 联系人模块

5.3.1 获取联系人列表(contact/get_list）

item content
接口 contact/get_list
描述 获取联系人列表
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
gender int N 0 女 1 男
age int N 0 0-18 1 18-26 2 26-40 3 40-100
status int N 0 在读 1 在职 2 退休 3 无业
prefer int N User维护的偏好列表 且偏好占有数不为0的标签
mark int N User维护的标签列表 且标签占有数不为0的标签
school char N 所有联系人中出现过的学校（需要及时计算）
company char N 所有联系人中出现过的公司（需要及时计算）
residence char N 所有联系人中出现过的现居地（需要及时计算）
birthplace char N 所有联系人中出现过的籍贯（需要及时计算）
marital_status int N 0 单身 1 恋爱 2 已婚
sort_way int N 0 总分 1 未联系天数 2 关系等级 3 联系频率

学校、公司等信息按照数量从大到小返回

Response

参数名 类型 是否必须 描述
contact Array Y
contact_id int Y
score int Y
untouch_day int Y
contact_frequency float Y
name char Y
relationship int Y 0 家人 1 亲戚 2 朋友 3 同学 4 同事 5 老师 6 领导 7 特别关注 8 其他
class int Y 1 挚友 2 好友 3 朋友 4 相识 5 存在

5.3.2 获取筛选项目（contact/get_select）

item content
接口 contact/get_select
描述 获取筛选项目
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y

Response

参数名 类型 是否必须 描述
residence Array Y [重庆，广州，山东……]
brithplace Array Y [重庆，广东，山东……]
mark Array Y [唱歌，宣传，演讲……] （在思考是否传id）
prefer Array Y [……]
school Array Y [……]
company Array Y [……]

5.3.3 搜索联系人（contact/search）

item content
接口 contact/search
描述 搜索联系人
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
key_word char Y 搜索信息

Response

参数名 类型 是否必须 描述
contact Array Y
contact_id int Y
score int Y
untouch_day int Y
contact_frequency float Y
name char Y
relationship int Y 0 家人 1 亲戚 2 朋友 3 同学 4 同事 5 老师 6 领导 7 特别关注 8 其他
class int Y 1 挚友 2 好友 3 朋友 4 相识 5 存在

5.3.4 新建联系人（contact/new）

item content
接口 contact/new
描述 新建联系人
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
name char Y
associated char Y user_id/contact_id
class int Y 1 挚友 2 好友 3 朋友 4 相识 5 存在
relationship int Y 0 家人 1 亲戚 2 朋友 3 同学 4 同事 5 老师 6 领导 7 特别关注 8 其他
gender int N 0 女 1 男
status int N 0 在读 1 在职 2 退休 3 无业
marital_status int N 0 单身 1 恋爱 2 已婚
birthdate time N
phone_number1 int N
phone_number2 int N
residence char N
birthplace char N

Response

参数名 类型 是否必须 描述
contact_id char Y

5.3.5 绑定社交应用（contact/social_app）*

item content
接口 contact/social_app
描述 绑定社交应用
验证 Session
方法 GET/POST

Request

参数名 类型 是否必须 描述
user_id char Y
s_id char Y
contact_id char Y
social_platform int Y 0 微信 1 QQ 2 微博 （目前只考虑这三个平台）
social_account char Y

Response

参数名 类型 是否必须 描述
social_id int Y
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

在word中插入格式漂亮的代码

最近在工作中，需要在詳細設計文檔中插入僞代碼。嘗試編輯了不同的格式，總是覺得代碼顯示的不美觀，因此嘗試在網上搜索一些方法，還真有這方面的資料。如下 一、CSDN的博文《如何優雅的在 Microsoft word中插入代碼》提到使用一個在線

飘零剑客 2020-06-23 04:07:58

《从零开始学架构》 一张图学会怎么写出好的架构设计文档

~学无止境~ 2020-06-20 10:53:01

设计文档

Xjack2012 2020-02-21 10:46:39

总体设计和详细设计怎么写？

_Debug_debug 2019-09-15 20:36:04

关于服务器在处理性能上的对比以及达到的速度

cuiyaonan2000 2019-09-06 05:06:38

【设计】星际争霸2 第二次世界大战 亚洲战场 各国角色特性分类方案一览（初步）

JomlyKellenda 2019-01-16 21:10:26

详细设计说明书的框架

yincaiqin 2018-09-03 13:15:41

WonderLand项目文档1

xiamu03 2018-09-03 01:27:29

利用“4+1”视图建模方法进行软件架构设计

xiamu03 2018-09-03 01:27:24

客户端防重放设计

Do丶YouMissing 2018-09-02 01:05:28

信道重连设计

Do丶YouMissing 2018-09-02 01:05:28

用户需求、功能需求与业务需求的区别

road2010 2018-09-01 20:35:52

基于泛数据的面向对象事务平台构架

zhengl 2018-08-27 22:49:09

概要设计与详细设计

cuiyaonan2000 2018-08-24 02:44:17

支付业务流程图--扫码付

mcl 2018-08-23 21:53:47