Unity保存玩家的数据到文件中（Unity的二进制序列化）

news2024/11/26 18:34:27

文章目录

文章运行环境
什么是二进制序列化
读写文件
- 构造函数
自定义二进制序列化

文章运行环境

Unity2022

什么是二进制序列化

Unity中的二进制序列化是一种将游戏对象或数据结构转换为二进制格式的过程，以便于存储或网络传输。这使数据能够以高效的方式保存，同时在需要时可以被正确地恢复（反序列化）回原始状态。二进制序列化对于保存游戏进度、网络同步数据或资源打包（如AssetBundles）特别有用。

二进制序列化通常比文本格式（如JSON、XML）更快，占用空间更小，但可能不如文本格式易于调试或跨平台兼容。

读写文件

在C#中，我们用FileStream类来读取、写入文件。它允许程序以流的形式访问文件系统中的文件，支持读取、写入、追加等多种操作模式。

FileStream类是.NET框架中一个非常核心的类，它位于System.IO命名空间下。

我们先来看一行代码，感受一下FileStream类读写文件的操作：

using FileStream stream = new FileStream(filePath, FileMode.Create);

这段代码创建了一个新的FileStream对象，用于与文件系统交互。这里有几个关键点：

new FileStream(filePath, FileMode.Create) 这里调用了FileStream的构造函数，它接受两个主要参数：

filePath: 字符串类型，表示要打开或创建的文件路径。如果路径不包含驱动器字母，它会被视为相对于当前工作目录的路径。
FileMode.Create: FileMode枚举的一个成员，指定了打开或创建文件的模式。在这个例子中我们用的是Create模式，表示如果指定的文件已经存在，则会覆盖现有文件（即删除原文件内容并开始写入新数据）。如果文件不存在，则会创建一个新文件。

另外示例使用了using语句，using关键字在这里用于确保FileStream对象在不再需要时（比如方法执行完毕或作用域结束）能够被正确且及时地关闭和释放相关资源。这有助于防止文件句柄泄露，保证系统资源的有效管理。使用using块可以自动调用Dispose()方法，即使在发生异常的情况下也能确保资源的释放。

构造函数

FileStream类提供了多个构造函数，以适应不同的使用场景。最基本的构造函数如下：

public FileStream(string path, FileMode mode);

其中，path是文件的路径，前面已经说的很详细了，这里不多赘述，mode决定了如何打开或创建文件，它是一个FileMode枚举值。除了FileMode.Create（如之前提到的，用于创建新文件或覆盖现有文件），还有其他几种模式，包括：

FileMode.Open：打开现有文件，如果文件不存在则抛出异常。
FileMode.OpenOrCreate：如果文件存在则打开，否则创建新文件。
FileMode.Append：打开文件以追加内容，如果文件不存在则创建新文件。
当然还有其他模式，这里不多说了，大家可以查阅文档。

除了上述基本构造函数外，还有其他构造函数，例如可以通过额外的参数指定文件访问权限（如FileAccess.ReadWrite）、文件共享选项（FileShare.None, FileShare.Read, 等）以及文件选项（如FileOptions.Asynchronous）。这里暂不展开。

自定义二进制序列化

我们可以使用BinaryFormatter来实现更复杂的自定义序列化需求，虽然不是Unity引擎直接推荐的方法。

这个类是.NET的，完全限定名是System.Runtime.Serialization.Formatters.Binary.BinaryFormatter，我们用这个类来进行二进制序列化。这种方法允许你精细控制哪些数据被序列化，并且可以将数据写入到文件或内存流中。

接下来我们写一个例子来学习。首先，定义一个简单的PlayerData类，该类标记有[Serializable]属性，这样BinaryFormatter就能识别并处理它：

[Serializable]
public class PlayerData
{
    public string playerName;
    public int score;
    public DateTime lastPlayed;

    public PlayerData(string name, int score, DateTime time)
    {
        this.playerName = name;
        this.score = score;
        this.lastPlayed = time;
    }
}

接下来，使用BinaryFormatter进行序列化和反序列化：

using System;
using System.IO;
using System.Runtime.Serialization.Formatters.Binary;
using UnityEngine;
public class DataSaver : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        // 创建一个示例对象
        PlayerData data = new("玩家1", 1000, DateTime.Now);

        // 序列化对象到文件
        SaveToFile(data, "game.save");

        // 从文件反序列化对象
        PlayerData loadedData = LoadFromFile("game.save");

        // 打印加载的数据，验证是否保存成功
        Debug.Log($"玩家名: {loadedData.playerName}");
        Debug.Log($"分数: {loadedData.score}");
        Debug.Log($"上次游玩时间: {loadedData.lastPlayed}");
    }
    static void SaveToFile(PlayerData data, string filePath)
    {
        using FileStream stream = new(filePath, FileMode.Create);
        BinaryFormatter formatter = new();
        formatter.Serialize(stream, data);
    }

    static PlayerData LoadFromFile(string filePath)
    {
        if (File.Exists(filePath))
        {
            using FileStream stream = new(filePath, FileMode.Open);
            BinaryFormatter formatter = new();
            return (PlayerData)formatter.Deserialize(stream);
        }
        else
        {
            throw new FileNotFoundException($"文件没找到: {filePath}");
        }
    }
}