在Unity中使用Protobuf-net进行数据持久化

Protobuf是什么,能做什么

自行查阅,此处暂不做介绍。
游戏中,有些数据是要存储的,以便玩家下次可以继续,实现这个功能的一种方案就是采用Protobuf。

哪里获取Protobuf

资源根目录/assorted/protobuf-net.Enyim/packages/protobuf-net.2.0.0.602/lib/net20-cf

怎么使用Protobuf

  • 在Unity项目里随便找个地方创建个Plugins文件夹,把protobuf-net.dll放进去就行了。
  • 若要自己了解一下用法,可以看完整资源中这两个位置:
    1 资源根目录下有个“StartHere.txt”,里面介绍了简单的用法。
    2 资源根目录\assorted\QuickStart,这个路径下的几个文件就是StartHere中提到的那几个文件。

使用案例

内容

场景中有一个缓慢移动并旋转的立方体,点“保存旋转”按钮时,会将其当前的旋转信息保存的文件,点“读取旋转”按钮时,会从文件中读取旋转信息重置给立方体。

设计

  • 设计PBN_Quaterion类,用于持久化Unity中的Quaterion类型的数据。
  • 指定存取数据的文件位“c:\rot.bin”。
  • 设计PBN_Test组件,用来测试,主要功能如下:
    • saveRot(),保存cube的localRotation到文件。
    • loadRot(),从文件读取数据并设置给cube的localRotation。
  • 界面上放两个按钮对应saveRot和loadRot。

实施

  • 以下是主测试代码PBNTest.cs,测试组件和Protobuf对应的类都写在里面了,文件路径可以在inspector面板里设置path即可:
using UnityEngine;
using System.IO;
// 引用ProtoBuf-Net的功能包
using ProtoBuf;

/// <summary>
/// 用于保存Unity中Quaterion类型的PB类
/// </summary>
[ProtoContract]
public class PBN_Quaterion{
    /// <summary>
    /// 以下是对应Quaterion的数据分量,重点是ProtoMember从1开始编号,不要重复,
    /// 并且使用getter,setter方式。
    /// </summary>
    /// <value>The x.</value>
    [ProtoMember(1)]
    public float x{get;set;}
    [ProtoMember(2)]
    public float y{get;set;}
    [ProtoMember(3)]
    public float z{get;set;}
    [ProtoMember(4)]
    public float w{get;set;}
    /// <summary>
    /// 无参构造函数,这个必须要有!
    /// </summary>
    public PBN_Quaterion(){
    }
    /// <summary>
    /// 方便Unity的Quaterion转化到PBN_Quaternion
    /// </summary>
    /// <param name="q">Q.</param>
    public PBN_Quaterion(Quaternion q){
        this.x = q.x;
        this.y = q.y;
        this.z = q.z;
        this.w = q.w;
    }
    /// <summary>
    /// 方便转化回Unity的Quaternion
    /// </summary>
    /// <returns>The quat.</returns>
    public Quaternion toQuat(){
        return new Quaternion(x, y, z, w);
    }
    /// <summary>
    /// 一切为了方便吧
    /// </summary>
    /// <returns>The quat.</returns>
    /// <param name="q">Q.</param>
    public static PBN_Quaterion FromQuat(Quaternion q){
        return new PBN_Quaterion(q);
    }
}

/// <summary>
/// 测试组件
/// </summary>
public class PBNTest : MonoBehaviour {

    /// <summary>
    /// 要采样的对象
    /// </summary>
    public Transform target;
    /// <summary>
    /// 用来存取数据的绝对路径
    /// </summary>
    public string path;
    /// <summary>
    /// 存储target当前旋转
    /// </summary>
    public void saveRot(){
        using(Stream file = File.Create(path)){
            Serializer.Serialize(file, PBN_Quaterion.FromQuat(target.localRotation));
            file.Close();
        }
    }
    /// <summary>
    /// 读取存储的旋转,并设置回target
    /// </summary>
    public void loadRot(){
        using(Stream file = File.OpenRead(path)){
            PBN_Quaterion q = Serializer.Deserialize<PBN_Quaterion>(file);
            file.Close();
            target.localRotation = q.toQuat();
        }
    }
}
  • 以下是控制物体移动旋转的组件Controller.cs
using UnityEngine;

public class Controller : MonoBehaviour {
    /// <summary>
    /// 被控制的对象
    /// </summary>
    public Transform target;
    /// <summary>
    /// 旋转速度
    /// </summary>
    public Vector3 rotSpeed;
    /// <summary>
    /// 移动速度
    /// </summary>
    public Vector3 movSpeed;
    
    // Update is called once per frame
    void Update () {
        target.Rotate(rotSpeed * Time.deltaTime);
        target.Translate(movSpeed * Time.deltaTime);
    }
}
  • 界面上加两个按钮去调用PBNTest的saveRot()和loadRot()。

扩展
1 增加“保存位置”和“读取位置”按钮。
2 合并旋转和位置的存储功能,用“保存”和“读取”保存和重置立方体的transform。
如果自己扩展以上功能没思路,可以参考以下给出的合并功能之后的主代码:

using UnityEngine;
using System.IO;
// 引用ProtoBuf-Net的功能包
using ProtoBuf;

/// <summary>
/// 用于保存Unity中Quaterion类型的PB类
/// </summary>
[ProtoContract]
public class PBN_Quaterion{
    /// <summary>
    /// 以下是对应Quaterion的数据分量,重点是ProtoMember从1开始编号,不要重复,
    /// 并且使用getter,setter方式。
    /// </summary>
    /// <value>The x.</value>
    [ProtoMember(1)]
    public float x{get;set;}
    [ProtoMember(2)]
    public float y{get;set;}
    [ProtoMember(3)]
    public float z{get;set;}
    [ProtoMember(4)]
    public float w{get;set;}
    /// <summary>
    /// 无参构造函数,这个必须要有!
    /// </summary>
    public PBN_Quaterion(){
    }
    /// <summary>
    /// 方便Unity的Quaterion转化到PBN_Quaternion
    /// </summary>
    /// <param name="q">Q.</param>
    public PBN_Quaterion(Quaternion q){
        this.x = q.x;
        this.y = q.y;
        this.z = q.z;
        this.w = q.w;
    }
    /// <summary>
    /// 方便转化回Unity的Quaternion
    /// </summary>
    /// <returns>The quat.</returns>
    public Quaternion toQuat(){
        return new Quaternion(x, y, z, w);
    }
    /// <summary>
    /// 一切为了方便吧
    /// </summary>
    /// <returns>The quat.</returns>
    /// <param name="q">Q.</param>
    public static PBN_Quaterion FromQuat(Quaternion q){
        return new PBN_Quaterion(q);
    }
}

/// <summary>
/// 用来对应Unity的Vector3类型数据
/// </summary>
[ProtoContract]
public class PBN_Vector3{
    [ProtoMember(1)]
    public float x {get;set;}
    [ProtoMember(2)]
    public float y {get;set;}
    [ProtoMember(3)]
    public float z {get;set;}

    public PBN_Vector3(){}

    public PBN_Vector3(Vector3 v){
        x = v.x;
        y = v.y;
        z = v.z;
    }

    public Vector3 toVec3(){
        return new Vector3(x, y, z);
    }

    public static PBN_Vector3 FromVec3(Vector3 v){
        return new PBN_Vector3(v);
    }
}

/// <summary>
/// 方便操作一些Transform相关数据,这并不是Unity的Transform对应版
/// </summary>
[ProtoContract]
public class PBN_Transform{
    [ProtoMember(1)]
    public PBN_Vector3 localPosition{get;set;}
    [ProtoMember(2)]
    public PBN_Quaterion localRotation{get;set;}

    public PBN_Transform(){}

    public PBN_Transform(Vector3 p, Quaternion r){
        localPosition = PBN_Vector3.FromVec3(p);
        localRotation = PBN_Quaterion.FromQuat(r);
    }

    public static PBN_Transform From(Vector3 p, Quaternion r){
        return new PBN_Transform(p, r);
    }
}

/// <summary>
/// 测试组件
/// </summary>
public class PBNTest : MonoBehaviour {

    /// <summary>
    /// 要采样的对象
    /// </summary>
    public Transform target;
    /// <summary>
    /// 用来存取数据的绝对路径
    /// </summary>
    public string path;
    /// <summary>
    /// 存储target当前旋转
    /// </summary>
    public void save(){
        using(Stream file = File.Create(path)){
            Serializer.Serialize(file, PBN_Transform.From(target.localPosition, target.localRotation));
            file.Close();
        }
    }
    /// <summary>
    /// 读取存储的旋转,并设置回target
    /// </summary>
    public void load(){
        using(Stream file = File.OpenRead(path)){
            PBN_Transform t = Serializer.Deserialize<PBN_Transform>(file);
            file.Close();
            target.localPosition = t.localPosition.toVec3();
            target.localRotation = t.localRotation.toQuat();
        }
    }
}

补充

  • 经测试,以上方案可以在android平台上运行,只是文件路径要特别设置一下。ios还未测试。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容