前后端通信数据格式详解
前后端通信数据格式系统使用 JSON 格式的数据,主要包括客户端向服务器发送数据的格式和服务器应答消息格式。
客户端向服务器发送数据的格式
客户端向服务器发送数据的格式为一个 JSON 对象,包括三个部分:operation、parameter 和 body。
* operation:操作代码,表示当前操作的类型,例如登录、注销、注册等。
* parameter:操作参数,包括当前操作所需的参数,例如用户 ID、密码、用户名等。
* body:操作体,表示当前操作的具体内容,例如登录时的 token、注册时的用户名和密码等。
服务器应答消息格式
服务器应答消息格式也为一个 JSON 对象,包括两个部分:result 和其他数据。
* result:操作结果,表示当前操作的结果,例如成功或失败。
* 其他数据:根据操作结果的不同,服务器会返回不同的数据,例如登录成功时返回的 token,注册成功时返回的用户 ID 和 token 等。
支持的操作
前后端通信数据格式系统支持多种操作,包括:
* 用户登录
* 用户注销
* 用户注册
* 用户获取好友的状态和信息
* 用户发送即时消息
用户登录
用户登录时,客户端向服务器发送的数据格式为:
* operation:login
* parameter:token(上次登录时服务器返回的认证 token)、userId(登录用户的 userId)
* body:无
服务器应答消息格式为:
* result:success 或 error
* token:用于下次登录的 token
* cachedMessage:离线时的缓存即时消息
用户注销
用户注销时,客户端向服务器发送的数据格式为:
* operation:logout
* parameter:无
* body:无
服务器应答消息格式为:
* result:success 或 error
用户注册
用户注册时,客户端向服务器发送的数据格式为:
* operation:register
* parameter:userName(Base64 编码的用户设置的用户名)、password(用户设置的密码)
* body:无
服务器应答消息格式为:
* result:success
* userId:系统生成的用户 ID
* token:用户下次登录使用的 token
用户获取好友的状态和信息
用户获取好友的状态和信息时,客户端向服务器发送的数据格式为:
* operation:getFriendsInfo
* parameter:无
* body:无
服务器应答消息格式为:
* result:success
* friendsData:好友数据,包括好友的 userId、userName、personalSign、avatar 和 status 等信息
用户发送即时消息
用户发送即时消息时,客户端向服务器发送的数据格式为:
* operation:message
* parameter:targetUser(目标用户的 ID)、sendTime(消息发送时间)、body(消息体)
* body:Base64 编码的消息文本/字符串
服务器应答消息格式为:
* result:success 或 error
* error:notLogin 或 notFriend 等错误信息
本文详细解释了前后端通信数据格式的组成部分和支持的操作,帮助开发者更好地理解和实现前后端数据交换机制。
评论0
最新资源