消息负载序列化
- Android
更新时间不可用
了解如何在实时消息 RTM 中消息负载序列化，包括适用场景、配置步骤、实现要点和注意事项。
当你为消息负载构建结构化的格式后，还需要将消息数据进行序列化转换成字符串类型或二进制类型，以满足 RTM 中发送消息的格式要求。你可以自己实现或使用第三方的插件，我们有以下两种推荐做法：
- 使用 Json.Net
- 使用 Protocol Buffers
使用 Json.Net
Json.Net 是 .NET 平台上一个强大、灵活、易用和高性能的 JSON 框架，可用于序列化和反序列化 JSON 数据，支持多种数据格式和数据类型。
使用自定义类
以下步骤展示了如何使用自定义类把包含问题和答案选项的投票消息序列化为 JSON 格式，并通过 publish 方法发布到指定的消息通道中。
- 定义一个
PollMessage类，该类包含了投票消息的所有属性，包括type（消息类型）、question（问题内容）、answer（答案选项）和sender（消息发送者）。 - 使用
Dictionary<string, string>类型的answer变量定义答案选项，并将其赋值给PollMessage对象的answer属性。 - 使用
Newtonsoft.Json包中的JsonConvert.SerializeObject方法将PollMessage对象序列化为 JSON 格式的字符串，并赋值给payload变量。 - 使用
customType来标识数据结构是自定义的PollMessage数据类型。 - 调用
PublishAsync方法将 payload 字符串发布到指定的频道中。
示例代码如下：
PollMessage message = new PollMessage();
// ...
// 序列化对象
String payload = message.serialize(); // 自定义类型的序列化
PublishOptions options = new PublishOptions();
options.customType = "PollMessage";
mRtmClient.publish(msChannelName, payload, options, new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
log(CALLBACK, "send message to channel success");
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});接收到消息时，你需要通过反序列化将字符串消息恢复成原先的自定义类型。示例代码如下：
eventListener = new RtmEventListener {
@Override
public void onMessageEvent(MessageEvent event) {
log(INFO, "onMessageEvent");
if (event.message.getType() == RtmMessageType.STRING) {
// 调用自定义的反序列化接口
PollMessage message = PollMessage.deserialize(event.message.getData());
}
}
}使用 JSON Object
你也可以直接利用 JSON Object 类型对消息进行序列化。JSON Object 是一种轻量级、简单、易读、跨平台的数据交换格式，具有广泛的应用性。 Newtonsoft.Json.Linq 中包含了对 JSON Object 类型的支持。
JSONObject jsonObject = new JSONObject();
// 添加键值对
try {
jsonObject.put("name", "John");
jsonObject.put("age", 25);
} catch (JSONException e) {
e.printStackTrace();
}
PublishOptions options = new PublishOptions();
options.customType = "customType";
mRtmClient.publish(msChannelName, jsonObject.toString(), options, new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
log(CALLBACK, "send message to channel success");
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});接收到消息时，你需要定义一个 JObject 对象，对接收到的字符串进行反序列化。示例代码如下：
eventListener = new RtmEventListener {
@Override
public void onMessageEvent(MessageEvent event) {
log(INFO, "onMessageEvent");
if (event.message.getType() == RtmMessageType.STRING) {
// Json Object 类型的反序列化
JSONObject jsonObject = new JSONObject(event.message.getData());
String name = jsonObject.getString("name");
int age = jsonObject.getInt("age");
}
}
}使用 Protocol Buffers
Protocol Buffers（Protobuf）是一种轻便高效的序列化数据结构的方式，具有体积小，效率高，兼容性强，支持跨平台等优点，常被用于一些网络传输效率要求较高的场景，如在线游戏、大规模数据分析、物联网等。
以下示例代码显示了如何在 RTM 中利用 Protobuf 定义一个 Position 类型的 message 消息结构，完成数据的序列化、传输和反序列化。
- 使用 Protobuf 定义一个
Position类型的message消息结构。示例代码如下：
syntax = "proto3";
option cc_enable_arenas = true;
package MessageType;
message Position {
string type =1;
Data data = 2;
repeated string mentionedUsers = 3;
string sender = 4;
}
message Data {
Coordinate coordinate = 1;
Direction direction =2;
}
message Coordinate {
float x = 1;
float y = 2;
float z = 3;
}
message Direction {
float pitch = 1;
float roll = 2;
float yaw =3;
}- 在程序中引用
Google.Protobuf和定义好的MessageType，把消息序列化成二进制格式后使用 RTM 的publish发送消息。示例代码如下：
byte[] message = position.ToByteArray(); // 二进制类型的数据
PublishOptions options = new PublishOptions();
options.customType = "customType";
mRtmClient.publish("msChannelName", message, options, new ResultCallback<Void>() {
@Override
public void onSuccess(Void responseInfo) {
log(CALLBACK, "send message to channel success");
}
@Override
public void onFailure(ErrorInfo errorInfo) {
log(ERROR, errorInfo.toString());
}
});- 当你接收到消息时，需要对消息进行反序列化。示例代码如下：
eventListener = new RtmEventListener {
@Override
public void onMessageEvent(MessageEvent event) {
log(INFO, "onMessageEvent");
if (event.message.getType() == RtmMessageType.BINARY) {
// 把二进制格式的消息反序列化为 Position 对象
Position position = new Position();
position = Position.ParseFrom(event.message.getData());
}
}
}