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

Protobuf是什么，能做什么

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

哪里获取Protobuf

• 完整资源在git上https://github.com/mgravell/protobuf-net
• 仅仅用于Unity的话，下载这个就行.net2.0简版的protobuf-net.dll，如果你已经获取完整资源，那么它就位于这个路径下：

资源根目录/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;

/// 

/// 用于保存Unity中Quaterion类型的PB类
/// 
[ProtoContract]
public class PBN_Quaterion{
    /// 

    /// 以下是对应Quaterion的数据分量，重点是ProtoMember从1开始编号，不要重复，
    /// 并且使用getter，setter方式。
    /// 
    /// The x.
    [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;}
    /// 

    /// 无参构造函数，这个必须要有！
    /// 
    public PBN_Quaterion(){
    }
    /// 

    /// 方便Unity的Quaterion转化到PBN_Quaternion
    /// 
    /// Q.
    public PBN_Quaterion(Quaternion q){
        this.x = q.x;
        this.y = q.y;
        this.z = q.z;
        this.w = q.w;
    }
    /// 

    /// 方便转化回Unity的Quaternion
    /// 
    /// The quat.
    public Quaternion toQuat(){
        return new Quaternion(x, y, z, w);
    }
    /// 

    /// 一切为了方便吧
    /// 
    /// The quat.
    /// Q.
    public static PBN_Quaterion FromQuat(Quaternion q){
        return new PBN_Quaterion(q);
    }
}

/// 

/// 测试组件
/// 
public class PBNTest : MonoBehaviour {

    /// 

    /// 要采样的对象
    /// 
    public Transform target;
    /// 

    /// 用来存取数据的绝对路径
    /// 
    public string path;
    /// 

    /// 存储target当前旋转
    /// 
    public void saveRot(){
        using(Stream file = File.Create(path)){
            Serializer.Serialize(file, PBN_Quaterion.FromQuat(target.localRotation));
            file.Close();
        }
    }
    /// 

    /// 读取存储的旋转，并设置回target
    /// 
    public void loadRot(){
        using(Stream file = File.OpenRead(path)){
            PBN_Quaterion q = Serializer.Deserialize(file);
            file.Close();
            target.localRotation = q.toQuat();
        }
    }
}

• 以下是控制物体移动旋转的组件Controller.cs：

using UnityEngine;

public class Controller : MonoBehaviour {
    /// 

    /// 被控制的对象
    /// 
    public Transform target;
    /// 

    /// 旋转速度
    /// 
    public Vector3 rotSpeed;
    /// 

    /// 移动速度
    /// 
    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;

/// 

/// 用于保存Unity中Quaterion类型的PB类
/// 
[ProtoContract]
public class PBN_Quaterion{
    /// 

    /// 以下是对应Quaterion的数据分量，重点是ProtoMember从1开始编号，不要重复，
    /// 并且使用getter，setter方式。
    /// 
    /// The x.
    [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;}
    /// 

    /// 无参构造函数，这个必须要有！
    /// 
    public PBN_Quaterion(){
    }
    /// 

    /// 方便Unity的Quaterion转化到PBN_Quaternion
    /// 
    /// Q.
    public PBN_Quaterion(Quaternion q){
        this.x = q.x;
        this.y = q.y;
        this.z = q.z;
        this.w = q.w;
    }
    /// 

    /// 方便转化回Unity的Quaternion
    /// 
    /// The quat.
    public Quaternion toQuat(){
        return new Quaternion(x, y, z, w);
    }
    /// 

    /// 一切为了方便吧
    /// 
    /// The quat.
    /// Q.
    public static PBN_Quaterion FromQuat(Quaternion q){
        return new PBN_Quaterion(q);
    }
}

/// 

/// 用来对应Unity的Vector3类型数据
/// 
[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);
    }
}

/// 

/// 方便操作一些Transform相关数据，这并不是Unity的Transform对应版
/// 
[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);
    }
}

/// 

/// 测试组件
/// 
public class PBNTest : MonoBehaviour {

    /// 

    /// 要采样的对象
    /// 
    public Transform target;
    /// 

    /// 用来存取数据的绝对路径
    /// 
    public string path;
    /// 

    /// 存储target当前旋转
    /// 
    public void save(){
        using(Stream file = File.Create(path)){
            Serializer.Serialize(file, PBN_Transform.From(target.localPosition, target.localRotation));
            file.Close();
        }
    }
    /// 

    /// 读取存储的旋转，并设置回target
    /// 
    public void load(){
        using(Stream file = File.OpenRead(path)){
            PBN_Transform t = Serializer.Deserialize(file);
            file.Close();
            target.localPosition = t.localPosition.toVec3();
            target.localRotation = t.localRotation.toQuat();
        }
    }
}

---

补充

• 经测试，以上方案可以在android平台上运行，只是文件路径要特别设置一下。ios还未测试。