Unity3D中存档实现
发表于2015-08-24
今天想和大家分享的内容是RPG游戏中游戏存档的实现，因为最近在做一个RPG游戏的项目，所以遇到这个问题就随时记录下来，在对知识进行总结的同时可以将这种思路或者想法分享给大家，这是一件快乐而幸运的事情。我讨厌写按部就班的技术教程，因为我觉得学习是一种自我的探索行为，如果一切都告诉你了，探索的过程便会变得没有意义了。
游戏存档是一种在单机游戏中特别常见的机制，这种机制是你在玩网络游戏的时候无法体验到的，你知道每次玩完一款单机游戏都会把游戏存档保存起来是一种怎样的感觉吗？它就像是一个征战沙场的将军将陪伴自己一生金戈铁马的宝剑静静地收入剑匣，然而每一次打开它的时候都会不由自主的热泪盈眶。人的本性其实就是游戏，我们每一天发生的故事何尝不是一个游戏？有时候让我们怀念的可能并不是游戏本身，而只是搁浅在时光里的那时的我们。好了，游戏存档是我们在游戏世界里雪泥鸿爪，它代表了我们曾经来到过这个世界。以RPG游戏为例，一个一般化的游戏存档应该囊括以下内容：
角色信息：指一切表征虚拟角色成长路线的信息，如生命值、魔法值、经验值等等。
道具信息：指一切表征虚拟道具数量或者作用的信息，如药品、道具、装备等等。
场景信息：指一切和游戏场景相关的信息，如场景名称、角色在当前场景中的位置坐标等等。
事件信息：指一切和游戏事件相关的信息，如主线任务、支线任务、触发性事件等等。
从以上信息划分的层次来看，我们可以发现在游戏存档中要储存的信息相对是比较复杂的，那么我们这里不得不说说Unity3D中的数据持久化方案PlayerPrefs。该方案采用的是一种键值型的数据存储方案，支持int、string、float三种基本数据类型，通过键名来获取相对应的数值，当值不存在时将返回一个默认值。这种数据存储方案本质上是将数据写入到一个Xml文件。这种方案如果用来存储简单的信息是没有问题的，可是如果用它来存储游戏存档这样负责的数据结构就显得力不从心了。
一个更为重要的问题是在数据持久化的过程中我们希望得到是一个结构化的【游戏存档】实例，显然此时松散的PlayerPrefs是不能满足我们的要求的。因此我们想到了将游戏数据序列化的思路，常见的数据序列化思路主要有Xml和JSON两种形式，在使用Xml的数据序列化方案的时候通常有两种思路，即手动建立数据实体和数据字符间的对应关系和基于XmlSerializer的数据序列化。
其中基于XmlSerializer的数据序列化是利用了[Serializable]这样的语法特性来帮助.NET完成数据实体和数据字符间的对应关系，两种思路本质上一样的。可是我们知道Xml的优点是可读性强，缺点是冗余信息多，因此在权衡了两种方案的利弊后，我决定采用JSON来作为数据序列化的方案，而且JSON在数据实体和数据字符间的对应关系上有着天然的优势，JSON所做的事情不就是将数据实体转化为字符串和从一个字符串中解析出数据实体吗？所以整个方案基本一气呵成。好了，下面我们来看具体的代码实现过程吧！
一、JSON的序列化和反序列化
这里我使用的是Newtonsoft.Json这个类库，相信大家都是知道的了！因此，序列化和反序列化特别简单。
二、Rijandel加密/解密算法
因为我们这里要做的是一个游戏存档的方案设计，因为考虑到存档数据的安全性，我们可以考虑采用相关的加密/解密算法来实现对序列化后的明文数据进行加密，这样可以从一定程度上保证游戏存档数据的安全性。因为博主并没有深入地研究过加密/解密方面的内容，所以这里仅仅提供一个从MSDN上获取的Rijandel算法，大家感兴趣的话可以自行去研究。
三、完整代码
好了，下面给出完整代码，我们这里提供了两个公开的方法GetData()和SetData()以及IO相关的辅助方法，我们在实际使用的时候只需要关注这些方法就可以了！
这里我们的密钥是直接写在代码中的，这样做其实是有风险的，因为一旦我们的项目被反编译，我们这里的密钥就变得很不安全了。这里有两种方法，一种是把密钥暴露给外部方法，即在读取数据和写入数据的时候使用同一个密钥即可，而密钥可以采取由机器MAC值生成的方法，这样每台机器上的密钥都是不同的可以防止数据被破解；其次可以采用DLL混淆的方法让反编译者无法看到代码中的内容，这样就无法获得正确的密钥从而无法获得存档里的内容了。
四、最终效果
好了，最后我们来写一个简单的测试脚本：
脚本执行结果：
加密后游戏存档：
结束，希望大家喜欢！
游戏存档是一种在单机游戏中特别常见的机制，这种机制是你在玩网络游戏的时候无法体验到的，你知道每次玩完一款单机游戏都会把游戏存档保存起来是一种怎样的感觉吗？它就像是一个征战沙场的将军将陪伴自己一生金戈铁马的宝剑静静地收入剑匣，然而每一次打开它的时候都会不由自主的热泪盈眶。人的本性其实就是游戏，我们每一天发生的故事何尝不是一个游戏？有时候让我们怀念的可能并不是游戏本身，而只是搁浅在时光里的那时的我们。好了，游戏存档是我们在游戏世界里雪泥鸿爪，它代表了我们曾经来到过这个世界。以RPG游戏为例，一个一般化的游戏存档应该囊括以下内容：
角色信息：指一切表征虚拟角色成长路线的信息，如生命值、魔法值、经验值等等。
道具信息：指一切表征虚拟道具数量或者作用的信息，如药品、道具、装备等等。
场景信息：指一切和游戏场景相关的信息，如场景名称、角色在当前场景中的位置坐标等等。
事件信息：指一切和游戏事件相关的信息，如主线任务、支线任务、触发性事件等等。
从以上信息划分的层次来看，我们可以发现在游戏存档中要储存的信息相对是比较复杂的，那么我们这里不得不说说Unity3D中的数据持久化方案PlayerPrefs。该方案采用的是一种键值型的数据存储方案，支持int、string、float三种基本数据类型，通过键名来获取相对应的数值，当值不存在时将返回一个默认值。这种数据存储方案本质上是将数据写入到一个Xml文件。这种方案如果用来存储简单的信息是没有问题的，可是如果用它来存储游戏存档这样负责的数据结构就显得力不从心了。
一个更为重要的问题是在数据持久化的过程中我们希望得到是一个结构化的【游戏存档】实例，显然此时松散的PlayerPrefs是不能满足我们的要求的。因此我们想到了将游戏数据序列化的思路，常见的数据序列化思路主要有Xml和JSON两种形式，在使用Xml的数据序列化方案的时候通常有两种思路，即手动建立数据实体和数据字符间的对应关系和基于XmlSerializer的数据序列化。
其中基于XmlSerializer的数据序列化是利用了[Serializable]这样的语法特性来帮助.NET完成数据实体和数据字符间的对应关系，两种思路本质上一样的。可是我们知道Xml的优点是可读性强，缺点是冗余信息多，因此在权衡了两种方案的利弊后，我决定采用JSON来作为数据序列化的方案，而且JSON在数据实体和数据字符间的对应关系上有着天然的优势，JSON所做的事情不就是将数据实体转化为字符串和从一个字符串中解析出数据实体吗？所以整个方案基本一气呵成。好了，下面我们来看具体的代码实现过程吧！
一、JSON的序列化和反序列化
这里我使用的是Newtonsoft.Json这个类库，相信大家都是知道的了！因此，序列化和反序列化特别简单。
[C#]
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | /// <summary> /// 将一个对象序列化为字符串 /// </summary> /// <returns>The object.</returns> /// <param name="pObject">对象</param> /// <param name="pType">对象类型</param> private static string SerializeObject(object pObject) { //序列化后的字符串 string serializedString = string.Empty; //使用Json.Net进行序列化 serializedString = JsonConvert.SerializeObject(pObject); return serializedString; } /// <summary> /// 将一个字符串反序列化为对象 /// </summary> /// <returns>The object.</returns> /// <param name="pString">字符串</param> /// <param name="pType">对象类型</param> private static object DeserializeObject(string pString,Type pType) { //反序列化后的对象 object deserializedObject = null; //使用Json.Net进行反序列化 deserializedObject=JsonConvert.DeserializeObject(pString,pType); return deserializedObject; } |
二、Rijandel加密/解密算法
因为我们这里要做的是一个游戏存档的方案设计，因为考虑到存档数据的安全性，我们可以考虑采用相关的加密/解密算法来实现对序列化后的明文数据进行加密，这样可以从一定程度上保证游戏存档数据的安全性。因为博主并没有深入地研究过加密/解密方面的内容，所以这里仅仅提供一个从MSDN上获取的Rijandel算法，大家感兴趣的话可以自行去研究。
[C#]
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | /// <summary> /// Rijndael加密算法 /// </summary> /// <param name="pString">待加密的明文</param> /// <param name="pKey">密钥,长度可以为:64位(byte[8]),128位(byte[16]),192位(byte[24]),256位(byte[32])</param> /// <param name="iv">iv向量,长度为128（byte[16])</param> /// <returns></returns> private static string RijndaelEncrypt(string pString, string pKey) { //密钥 byte[] keyArray = UTF8Encoding.UTF8.GetBytes(pKey); //待加密明文数组 byte[] toEncryptArray = UTF8Encoding.UTF8.GetBytes(pString); //Rijndael解密算法 RijndaelManaged rDel = new RijndaelManaged(); rDel.Key = keyArray; rDel.Mode = CipherMode.ECB; rDel.Padding = PaddingMode.PKCS7; ICryptoTransform cTransform = rDel.CreateEncryptor(); //返回加密后的密文 byte[] resultArray = cTransform.TransformFinalBlock(toEncryptArray, 0, toEncryptArray.Length); return Convert.ToBase64String(resultArray, 0, resultArray.Length); } /// <summary> /// ijndael解密算法 /// </summary> /// <param name="pString">待解密的密文</param> /// <param name="pKey">密钥,长度可以为:64位(byte[8]),128位(byte[16]),192位(byte[24]),256位(byte[32])</param> /// <param name="iv">iv向量,长度为128（byte[16])</param> /// <returns></returns> private static String RijndaelDecrypt(string pString, string pKey) { //解密密钥 byte[] keyArray = UTF8Encoding.UTF8.GetBytes(pKey); //待解密密文数组 byte[] toEncryptArray = Convert.FromBase64String(pString); //Rijndael解密算法 RijndaelManaged rDel = new RijndaelManaged(); rDel.Key = keyArray; rDel.Mode = CipherMode.ECB; rDel.Padding = PaddingMode.PKCS7; ICryptoTransform cTransform = rDel.CreateDecryptor(); //返回解密后的明文 byte[] resultArray = cTransform.TransformFinalBlock(toEncryptArray, 0, toEncryptArray.Length); return UTF8Encoding.UTF8.GetString(resultArray); } |
三、完整代码
好了，下面给出完整代码，我们这里提供了两个公开的方法GetData()和SetData()以及IO相关的辅助方法，我们在实际使用的时候只需要关注这些方法就可以了！
[C#]
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | // // Unity3D数据持久化辅助类 // 作者:秦元培 //时间:2015年8月14日 //using UnityEngine;using System.Collections;using System;using System.IO;using System.Text;using System.Security.Cryptography;using Newtonsoft.Json;public static class IOHelper{ /// <summary> /// 判断文件是否存在 /// </summary> public static bool IsFileExists(string fileName) { return File.Exists(fileName); } /// <summary> /// 判断文件夹是否存在 /// </summary> public static bool IsDirectoryExists(string fileName) { return Directory.Exists(fileName); } /// <summary> /// 创建一个文本文件 /// </summary> /// <param name="fileName">文件路径</param> /// <param name="content">文件内容</param> public static void CreateFile(string fileName,string content) { StreamWriter streamWriter = File.CreateText(fileName); streamWriter.Write(content); streamWriter.Close(); } /// <summary> /// 创建一个文件夹 /// </summary> public static void CreateDirectory(string fileName) { //文件夹存在则返回 if(IsDirectoryExists (fileName)) return; Directory.CreateDirectory(fileName); } public static void SetData(string fileName,object pObject) { //将对象序列化为字符串 string toSave = SerializeObject(pObject); //对字符串进行加密,32位加密密钥 toSave = RijndaelEncrypt(toSave, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"); StreamWriter streamWriter = File.CreateText(fileName); streamWriter.Write(toSave); streamWriter.Close(); } public static object GetData(string fileName,Type pType) { StreamReader streamReader = File.OpenText(fileName); string data = streamReader.ReadToEnd(); //对数据进行解密，32位解密密钥 data = RijndaelDecrypt(data, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"); streamReader.Close(); return DeserializeObject(data,pType); } /// <summary> /// Rijndael加密算法 /// </summary> /// <param name="pString">待加密的明文</param> /// <param name="pKey">密钥,长度可以为:64位(byte[8]),128位(byte[16]),192位(byte[24]),256位(byte[32])</param> /// <param name="iv">iv向量,长度为128（byte[16])</param> /// <returns></returns> private static string RijndaelEncrypt(string pString, string pKey) { //密钥 byte[] keyArray = UTF8Encoding.UTF8.GetBytes(pKey); //待加密明文数组 byte[] toEncryptArray = UTF8Encoding.UTF8.GetBytes(pString); //Rijndael解密算法 RijndaelManaged rDel = new RijndaelManaged(); rDel.Key = keyArray; rDel.Mode = CipherMode.ECB; rDel.Padding = PaddingMode.PKCS7; ICryptoTransform cTransform = rDel.CreateEncryptor(); //返回加密后的密文 byte[] resultArray = cTransform.TransformFinalBlock(toEncryptArray, 0, toEncryptArray.Length); return Convert.ToBase64String(resultArray, 0, resultArray.Length); } /// <summary> /// ijndael解密算法 /// </summary> /// <param name="pString">待解密的密文</param> /// <param name="pKey">密钥,长度可以为:64位(byte[8]),128位(byte[16]),192位(byte[24]),256位(byte[32])</param> /// <param name="iv">iv向量,长度为128（byte[16])</param> /// <returns></returns> private static String RijndaelDecrypt(string pString, string pKey) { //解密密钥 byte[] keyArray = UTF8Encoding.UTF8.GetBytes(pKey); //待解密密文数组 byte[] toEncryptArray = Convert.FromBase64String(pString); //Rijndael解密算法 RijndaelManaged rDel = new RijndaelManaged(); rDel.Key = keyArray; rDel.Mode = CipherMode.ECB; rDel.Padding = PaddingMode.PKCS7; ICryptoTransform cTransform = rDel.CreateDecryptor(); //返回解密后的明文 byte[] resultArray = cTransform.TransformFinalBlock(toEncryptArray, 0, toEncryptArray.Length); return UTF8Encoding.UTF8.GetString(resultArray); } /// <summary> /// 将一个对象序列化为字符串 /// </summary> /// <returns>The object.</returns> /// <param name="pObject">对象</param> /// <param name="pType">对象类型</param> private static string SerializeObject(object pObject) { //序列化后的字符串 string serializedString = string.Empty; //使用Json.Net进行序列化 serializedString = JsonConvert.SerializeObject(pObject); return serializedString; } /// <summary> /// 将一个字符串反序列化为对象 /// </summary> /// <returns>The object.</returns> /// <param name="pString">字符串</param> /// <param name="pType">对象类型</param> private static object DeserializeObject(string pString,Type pType) { //反序列化后的对象 object deserializedObject = null; //使用Json.Net进行反序列化 deserializedObject=JsonConvert.DeserializeObject(pString,pType); return deserializedObject; }} |
这里我们的密钥是直接写在代码中的，这样做其实是有风险的，因为一旦我们的项目被反编译，我们这里的密钥就变得很不安全了。这里有两种方法，一种是把密钥暴露给外部方法，即在读取数据和写入数据的时候使用同一个密钥即可，而密钥可以采取由机器MAC值生成的方法，这样每台机器上的密钥都是不同的可以防止数据被破解；其次可以采用DLL混淆的方法让反编译者无法看到代码中的内容，这样就无法获得正确的密钥从而无法获得存档里的内容了。
四、最终效果
好了，最后我们来写一个简单的测试脚本：
[C#]
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | using UnityEngine;using System.Collections;using System.Collections.Generic;public class TestSave : MonoBehaviour { /// <summary> /// 定义一个测试类 /// </summary> public class TestClass { public string Name = "张三"; public float Age = 23.0f; public int Sex = 1; public List<int> Ints = new List<int> () { 1, 2, 3 }; } void Start () { //定义存档路径 string dirpath = Application.persistentDataPath + "/Save"; //创建存档文件夹 IOHelper.CreateDirectory (dirpath); //定义存档文件路径 string filename = dirpath + "/GameData.sav"; TestClass t = new TestClass (); //保存数据 IOHelper.SetData (filename,t); //读取数据 TestClass t1 = (TestClass)IOHelper.GetData(filename,typeof(TestClass)); Debug.Log(t1.Name); Debug.Log(t1.Age); Debug.Log(t1.Ints); }} |
脚本执行结果：
加密后游戏存档：
结束，希望大家喜欢！