小舍App开发文档

注意：线上项目 italk.aoau.top 注册功能已修复（其他功能也恢复正常），请放心食用。

推荐本人的另一个项目：VuEgg-jwt-template，基于 Vue、Eggjs 开发的用户鉴权模板，开箱即用，可配合 italk-app 项目食用，规范了后台代码，项目使用 MySQL，可自行更换成 MongoDB，让你专注于核心逻辑开发。

快速预览

项目名称：小舍-社交app

开发人员：熙子黒

更新日期：2021-05-24

开源协议：MIT

有任何疑问请联系邮箱：3224266014@qq.com，并注明来意。

请勿商用！

功能介绍

• QQ、VX结合的聊天社交app
• 即时通讯技术
• 全栈架构
• UI规范化

项目地址：http://italk.aoau.top （建议移动设备访问）

apk自提：https://pan.baidu.com/s/14i6yiGFdAuQgSCcQbcU45w 提取码：q29u

衍生产品：小舍图片Api https://github.com/yesmore/photosapi 本项目已使用（注：该图床暂存在本人服务器，只能尽可能保证其稳定性，你可以选择更佳的图床方案来迭代：PicGo+Github+CDN，了解详情请转到本人的另一个仓库：yesmore/img）。

更多项目请访问个人博客：https://yesmore.cc

技术栈

前端：vue+uni-app+sass

后端：Nodejs(express)+mongoDB

通信：Websocket(socket.io)

Development Tool: HBuilderX+WebStorm

Developing env: Windows开发+Linux(Nginx)部署

Why uni-app?

1.简洁的跨平台开发框架，一次开发多平台上线（Android、ios、小程序）。

2.开发前置条件低，只需掌握vue即可快速上手。

Why websocket？

1.不同于http协议，详情查看官网。

2.服务端与客户端双向数据绑定。

3.封装的socket.io库简洁API，方便快速上手。

4.此项目为本人学习websocket项目，以准备后期开发物联网项目打基础。

Why express？

1.express是基于nodejs标准库http封装的web后端框架，方便前端人员快速开发，学习成本较低。

功能列表

登陆界面

• [x] 支持用户名/邮箱匹配登陆
• [x] 实时反馈匹配结果
• [x] 密码校验

注册界面

• [x] 支持用户名/邮箱已存在提示
• [x] 支持提示表单项是否填写完整
• [x] 密码复杂度反馈

主页界面

• [x] 好友消息提示
• [x] 好友申请提示
• [x] 最后一条消息及发送时间渲染
• [x] 最新消息排序
• [ ] 群消息提示
• [ ] 群与好友列表渲染优先级
• [ ] 大厅入口（无需创建群聊）

搜索界面

• [x] 正则匹配查询数据库
• [x] 搜索所有注册用户
• [x] 正则匹配渲染指定字符（串）
• [x] 添加好友功能
• [ ] 私聊窗口入口

资料卡界面

• [x] 好友昵称、备注、个性签名渲染
• [ ] 私聊窗口入口
• [x] 好友详情界面入口

详情界面

• [x] 用户详情修改（头像、签名、昵称、性别、生日、电话、邮箱）
• [ ] 用户密码修改
• [x] 修改存储数据库
• [x] 退出登录功能
• [x] 删除好友功能

好友私聊窗口

• [x] 发送文字消息
• [x] 发送图片消息
• [ ] 发送语音消息（兼容性）
• [x] 发送定位消息（未完善）
• [x] 发送表情消息
• [x] 拍摄照片功能
• [ ] 发送文件消息
• [ ] 发送视频消息

好友动态

• [ ] 动态列表渲染
• [ ] 动态详情查看
• [ ] 分享动态消息

Project

项目目录

暂未完善

前端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

┌- 
├-	commons/					// 配置文件
    ├-	db.js				// 连接数据库配置
    ├-  
├-	components/					// 数据模型
    ├-	
├-	pages/				// 中间件
    ├-	err.js				// 错误处理中间件
├-	static/					// 后端路由
    ├-	index.js
├-	App.vue					// 
├-	main.js						//
├-	pages.json				// 入口
├-	manifest.json
├-	project.config.json			 // 版本控制
├-	uni.scss		 // 版本控制
├-	README.md				// readme
└-	

后端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

┌- 
├-	config/					// 配置文件
    ├-	db.js				// 连接数据库配置
    ├-  
├-	model/					// 数据模型
    ├-	
├-	middleware/				// 中间件
    ├-	err.js				// 错误处理中间件
├-	router/					// 后端路由
    ├-	index.js
├-	server/					// 
    ├-
├-	dao/					//
    ├-
├-	app.js					// 入口
├-	package.json			 // 版本控制
├-	package-lock.json		 // 版本控制
├-	README.md				// readme
└-	

插件

后端插件

前端路由

交互逻辑

Schema

用户

好友

私聊消息

群

群消息

群成员

API DOC

baseURL:

注：所有接口名对应路由调用的api

1.signUp

描述：注册用户

地址：/signup/add

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

2.judgeValue

描述：查询用户是否存在

地址：/signup/judge

请求方式：POST

参数：

返回值：

示例：

1
2
3
4

{
    "status":200,
    "result":1
}

3.signIn

描述：登陆

地址：/signin/match

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7
8
9

{
    "status":200,
    "back":{
        "id":"60a9cb976d91641d68733adf",
        "name":"西西",
        "imgurl":"user.jpg",
        "token":"后端生成的token"
    }
}

4.searchUser

描述：搜索用户

地址：/search/user

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
    "status":200,
    "result":[
        {
      	 "imgurl":"user.jpg",
     	 "_id":"60a9cb976d91641d68733adf",
      	 "name":"西西",
      	 "email":"123456@qq.com"
        },
        {
          "imgurl":"user.jpg",
          "_id":"60aa4245fc3f843660404cc8",
          "name":"哥哥",
          "email":"123456789@qq.com"
        }
    ]
}

5.isFriend

描述：是否为好友

地址：/search/isfriend

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

6.searchGroup

描述：搜索群

地址：/search/group

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

7.isInGroup

描述：是否在群内

地址：/search/isingroup

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

8.userDetial

描述：用户详情

地址：/user/detial

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
    data:{
        result:{
           	 createdAt:"2021-05-23T11:53:41.100Z"
			email:"242166@qq.co"
             imgurl:"user.jpg"
			name:"小花"
			sex:"asexual"
			time:"2021-05-23T11:53:41.090Z"
			updatedAt:"2021-05-25T08:20:01.765Z"
			_id:"60aa4245fc3f843660404cc8"
        }
    }
}

9.userUpdate

描述：用户信息修改

地址：/user/update

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7
8

200：修改成功
300：用户名已存在，修改失败
400：失败
500：报错
201：邮箱已存在
{
    
}

10.getMarkName

描述：获取好友昵称

地址：/user/getmarkname

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

11.updateMarkName

描述：好友昵称修改

地址：/user/updatemarkname

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

12.applyFriend

描述：申请好友

地址：/friend/apply

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

13.updateFriendState

描述：更新好友关系（同意）

地址：/friend/updatefriendstate

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

14.deleteFriend

描述：好友状态更新（拒绝/删除）

地址：/friend/deletefriend

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

15.*upload

描述：文件上传

地址：/files/upload

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

16.getFriend

描述：获取好友列表

地址：/index/getfriend

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7

{
    id: ver.friendID._id,
    name: ver.friendID.name,
    markname: ver.markname,
    imgurl: ver.friendID.imgurl,
    lastTime: ver.lastTime,
}

17.getLastMsg

描述：获取最后一条好友消息

地址：/index/getlastmsg

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5

{
    message: ver.message,
      types: ver.types,
      time: ver.time,
}

18.unreadMsg

描述：获取好友未读消息数

地址：/index/updatemsg

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

19.updateMsg

描述：更新好友未读消息数

地址：/index/updatemsg

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

20.getGroup

描述：获取群列表

地址：/index/getgroup

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7
8

{
    gid: ver.groupID._id,
        name: ver.groupID.name,
        markname: ver.name,
        imgurl: ver.groupID.imgurl,
        lastTime: ver.lastTime,
        tip: ver.tip
}

21.getLastMsg

描述：获取最后一条群消息

地址：/index/getlastgroupmsg

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6

{
    message: ver.message,
      types: ver.types,
      time: ver.time,
      name: ver.userID.name // 谁发的
}

22.updateGroupMsg

描述：更新群未读消息数

地址：/index/updategroupmsg

请求方式：POST

参数：

返回值：

示例：

1
2
3

{
    
}

23.msg

描述：聊天消息分页查询

地址：/chat/msg

请求方式：POST

参数：

返回值：

示例：

1
2
3
4
5
6
7
8
9

{
    id: ver._id,
    messagee: ver.message,
    types: ver.types,	// 消息类型
    time: ver.time,

    fromId: ver.userID._id,
    imgurl: ver.userID.imgurl,
}

• ← 上一篇
• 下一篇 →