Unity3D 如何在退出运行模式后保存修改数据

其他 2018-07-25 16:11:05 阅读次数: 0
之前因为策划有在Game运行模式时动态修改脚本参数，在退出Playmode后脚本参数保存的需求，用于在场景中动态地调整参数。研究了一下之前老外实现的一个插件PlayModePersist，也就是一个在运行模式下进行保存数据的插件。
PlayModePersist 这款插件不知道什么原因已经从Appstore下架了。有需要的同学可以自行下载。
通过阅读这款插件的源码，学到了两个比较有趣的实现：
1. 通过反射获取所有应用类，做成编辑器以供筛选。
2. 退出Playmode后，保存修改过的数据。

今天讨论的就是No.2的实现方式


实现的核心还是通过反射。
通过脚本控制添加所需要修改的组 件列表，在 EditorApplication.playmodeStateChanged 类似于OnApplicationQuit 的时候把保存的数据提交修改。

我发现以前写云笔记的时候还是比较轻松，毕竟只是写给自己看，写博客的时候要让读者读懂，说清楚思路还是好难。
不废话了，先上代码
  1. using System.Collections.Generic;
  2. using UnityEngine;
  3. using UnityEditor;
  4. using System.Reflection;
  5. using System;
  7. public class PlayModeEditHelper {
  9. private static PlayModeEditHelper _instance;
  10. public static PlayModeEditHelper Instance
  11. {
  12. get
  13. {
  14. if (_instance == null)
  15. _instance = new PlayModeEditHelper();
  16. return _instance;
  17. }
  18. }
  20. //在构造函数中 注册修改事件
  21. public PlayModeEditHelper()
  22. {
  23. EditorApplication.playmodeStateChanged = Application_PlaymodeStateChanged;
  24. SavingDatas = new Dictionary< int, SettingData>();
  25. }
  27. List<Component> SavingGroups = new List<Component>(); //需要保存的组件列表
  28. List< int> SavingIDs = new List< int>(); //需要保存组件的InstanceID列表
  29. Dictionary< int, SettingData> SavingDatas; //缓存数据字典
  31. void Application_PlaymodeStateChanged()
  32. {
  33. if (EditorApplication.isPlaying || EditorApplication.isPaused)
  34. {
  35. //window repaint or do sth...
  36. }
  37. else
  38. {
  39. RestoreAllSavingSetting();
  40. EditorApplication.playmodeStateChanged = null;
  41. }
  42. }
  44. //还原所有修改数据
  45. void RestoreAllSavingSetting()
  46. {
  47. for ( int i = 0; i < SavingIDs.Count; i++)
  48. {
  49. RestoreSetting(SavingIDs[i]);
  50. }
  51. }
  53. //通过实例ID修改组件参数
  54. void RestoreSetting(int id)
  55. {
  56. Component ComponentObject = EditorUtility.InstanceIDToObject(id) as Component;
  58. Dictionary< string, object> values = SavingDatas[id].values;
  60. foreach ( string name in values.Keys)
  61. {
  62. object newValue = values[name];
  64. PropertyInfo property = ComponentObject.GetType().GetProperty(name);
  66. if ( null != property)
  67. {
  68. object currentValue = property.GetValue(ComponentObject, null);
  69. property.SetValue(ComponentObject, newValue, null);
  70. }
  71. else
  72. {
  73. FieldInfo field = ComponentObject.GetType().GetField(name, BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Public);
  74. object currentValue = field.GetValue(ComponentObject);
  75. field.SetValue(ComponentObject, newValue);
  76. }
  77. }
  79. if (ComponentObject != null)
  80. {
  81. SetPrefabDirty(ComponentObject);
  82. }
  83. }
  85. //如果是预设体，通知引擎修改 不能省略，修正了修改目标是预设体时，每次运行参数重置的bug
  86. void SetPrefabDirty(Component ComponentObject)
  87. {
  88. PrefabType prefabType = PrefabUtility.GetPrefabType(ComponentObject.gameObject);
  89. if (prefabType == PrefabType.DisconnectedPrefabInstance || prefabType == PrefabType.PrefabInstance)
  90. {
  91. EditorUtility.SetDirty(ComponentObject);
  92. }
  93. }
  95. //缓存修改信息 包括属性、字段
  96. public void SaveValues(Component ComponentObject)
  97. {
  98. if (SavingGroups.Contains(ComponentObject))
  99. {
  100. RefreshValues(ComponentObject);
  101. return;
  102. }
  104. Dictionary< string, object> values = new Dictionary< string, object>();
  106. List<PropertyInfo> properties = GetProperties(ComponentObject);
  107. List<FieldInfo> fields = GetFields(ComponentObject);
  109. foreach (PropertyInfo property in properties)
  110. {
  111. values.Add(property.Name, property.GetValue(ComponentObject, null));
  112. }
  114. foreach (FieldInfo field in fields)
  115. {
  116. values.Add(field.Name, field.GetValue(ComponentObject));
  117. }
  119. //添加需要保存的组件
  120. SavingGroups.Add(ComponentObject);
  121. SavingIDs.Add(ComponentObject.GetInstanceID());
  122. SavingDatas.Add(ComponentObject.GetInstanceID(), new SettingData(values));
  123. }
  125. //修正多次点击修改不能更新数据的bug
  126. private void RefreshValues(Component ComponentObject)
  127. {
  128. Dictionary< string, object> values = SavingDatas[ComponentObject.GetInstanceID()].values;
  130. List<PropertyInfo> properties = GetProperties(ComponentObject);
  131. List<FieldInfo> fields = GetFields(ComponentObject);
  133. foreach (PropertyInfo property in properties)
  134. {
  135. values[property.Name] = property.GetValue(ComponentObject, null);
  136. }
  138. foreach (FieldInfo field in fields)
  139. {
  140. values[field.Name] = field.GetValue(ComponentObject);
  141. }
  142. }
  144. //获取私有字段+公有字段列表
  145. private List<FieldInfo> GetFields(Component ComponentObject)
  146. {
  147. List<FieldInfo> fields = new List<FieldInfo>();
  148. //获取字段包括私有字段、共有字段 修正了私有字段不能正常修改的bug
  149. FieldInfo[] infos = ComponentObject.GetType().GetFields(BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Public);
  151. //foreach (FieldInfo fieldInfo in ComponentObject.GetType().GetFields())
  152. foreach (FieldInfo fieldInfo in infos)
  153. {
  154. if (!Attribute.IsDefined(fieldInfo, typeof(HideInInspector)))
  155. {
  156. fields.Add(fieldInfo);
  157. }
  158. }
  159. return fields;
  160. }
  162. //获取属性列表
  163. private List<PropertyInfo> GetProperties(Component ComponentObject)
  164. {
  165. List<PropertyInfo> properties = new List<PropertyInfo>();
  167. foreach (PropertyInfo propertyInfo in ComponentObject.GetType().GetProperties())
  168. {
  169. if (!Attribute.IsDefined(propertyInfo, typeof(HideInInspector)))
  170. {
  171. MethodInfo setMethod = propertyInfo.GetSetMethod();
  172. if ( null != setMethod && setMethod.IsPublic)
  173. {
  174. properties.Add(propertyInfo);
  175. }
  176. }
  177. }
  178. return properties;
  179. }
  180. }
  182. //简易的设置数据 自行根据需求扩充
  183. public class SettingData
  184. {
  185. public Dictionary< string, object> values;
  187. public SettingData(Dictionary<string, object> datas)
  188. {
  189. values = datas;
  190. }
  192. public void AddData(string name, object value)
  193. {
  194. if (!values.ContainsKey(name))
  195. {
  196. values.Add(name, value);
  197. }
  198. }
  199. }

其中测试脚本如下：
  1. using UnityEngine;
  3. public class TestEditParam : MonoBehaviour {
  5. public enum ENUM_TEST
  6. {
  7. ENUM1,
  8. ENUM2,
  9. ENUM3
  10. }
  12. public int mIntValue; //测试整形字段
  14. public float mFloatValue; //测试Float型字段
  16. public Vector3 mVector3Value; //测试Vector型字段
  18. public string mStringValue; //测试String型字段
  20. public ENUM_TEST mEnumType; //测试自定义枚举型字段
  22. //测试私有字段
  23. [ SerializeField]
  24. private int mPrivateIntValue;
  25. [ SerializeField]
  26. private float mPrivateFloatValue;
  27. }

测试Editor脚本：置于Editor文件夹下
  1. using UnityEngine;
  2. using UnityEditor;
  4. [ CustomEditor(typeof(TestEditParam), true)]
  5. public class TestEditParamEditor : Editor {
  7. public override void OnInspectorGUI()
  8. {
  9. base.OnInspectorGUI();
  11. GUILayout.Space( 10);
  12. if (GUILayout.Button( "Save"))
  13. {
  14. SaveParam();
  15. }
  16. }
  18. //将TestEditParam 和 Transform 注册到修改队列
  19. void SaveParam()
  20. {
  21. //将target（即Editor脚本的目标组件TestEditParam）注册到修改队列
  22. Component mTarget = target as Component;
  23. PlayModeEditHelper.Instance.SaveValues(mTarget);
  24. //将Transform 注册到修改队列
  25. Transform rectCom = mTarget.transform.GetComponent<Transform>();
  26. PlayModeEditHelper.Instance.SaveValues(rectCom);
  27. //ApplyParam();
  28. }
  30. //提交预设体修改 直接保存prefab的暴力方法 只需更改prefab时直接用此接口即可
  31. void ApplyParam()
  32. {
  33. Object prefabParent = PrefabUtility.GetPrefabParent(target);
  34. TestEditParam mScript = target as TestEditParam;
  35. PrefabUtility.ReplacePrefab(mScript.gameObject, prefabParent);
  36. }
  37. }

使用方法 很简单，在Editor脚本的按钮事件中添加需要修改的组件mTarget 即可
PlayModeEditHelper.Instance.SaveValues(mTarget);
支持添加多个组件，支持多次保存更新

其实prefab在保存时就是一系列序列化信息。可以通过文本工具查看，如：

主要实现的思路就是，通过反射方法，把Component的 属性(PropertyInfo)，和字段(FieldInfo)缓存下来。在结束运行模式后，系统首先会把组件数值还原。然后调用Application_PlaymodeStateChanged 方法，在系统默认还原后重新通过InstanceID获取组件，并对其字段属性的数值进行覆盖。
由于这个时序性，具体应用时会直观地看到一个数值跳动的过程。

接下来我们具体看一下 测试脚本中 PropertyInfo 和FieldInfo具体包含的信息

PropertyInfo ：

FieldInfo：

我们测试时用到的是字段值，而工作中也经常会用到属性索引器等等。所以都需要处理。

我们可以看到在PropertyInfo 中有些无用的基类的属性比如tag值，hideflag等。
这些在插件源码中单独处理成了一个IgnoreList 忽略列表，但是代码基类千变万化，出于简化代码的目的（不想人力维护这个列表），而且插件中的属性有多余的情况，比如包含了Transform类的基础属性等等，最终没有定义这个筛选列表。如果有需要可以参照插件源码。

这里在获取所有字段中用到了反射的筛选条件，支持了获取私有字段 
ComponentObject.GetType().GetFields(BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Public);
具体反射类可自行查阅相关文章，这里不做详细说明。

在playmodeStateChanged 状态切换后，检查状态如果是退出playmode时，调用脚本的保存修改方法。
通过property.SetValue，field.SetValue设置参数。

这里需要说明的是，如果修改的目标被设置成prefab（通常都是这样），要通过EditorUtility.SetDirty(ComponentObject)方法在Editor中将其标记为脏（变化过的）才能保存修改。否则会出现退出时虽然属性被修改，但是下一次运行时，系统会自动还原成prefab的参数。

如果大家不明白最好的方法就是断点走一遍。呃。程序猿们最简单的上手方法。

补充：
1. 之前只支持了单组件的保存。后来发现实际过程中可能会想保存Transform的属性等等，所以添加了对多个组件保存的支持。为了不影响之前的代码结构 维护了一个Dictionary<int, SettingData> SavingDatas; //缓存数据字典
临时添加SavingDatas用作处理缓存数据，方法也比较粗暴。大家用到时可以扩充数据类型，优化查找方法。
2. 还是写了这篇文章自己测试后发现，多次Save只能保存第一次的数据。忘了Save也应该有更新数据的功能，所以添加了RefreshValues的方法。也很粗暴，直接进行的所有数据全更新。请同学们自行修改优化。
3. 本文描述时比较啰嗦，主要是想简单记录一下实现时遇到的坑。
4. 在测试Editor脚本中有个方法。其实是脚本做提交预设体修改的方法。即：
  1. Object prefabParent = PrefabUtility.GetPrefabParent(target);
  2. TestEditParam mScript = target as TestEditParam;
  3. PrefabUtility.ReplacePrefab(mScript.gameObject, prefabParent);
如果仅是保存prefab需求直接应用即可



由于这是个辅助脚本，用于配合企划的修改需求。不会在正常的项目中实际运行到。所以代码并不优雅，只是给同学们一个思路，也许有更佳的方法

猜你喜欢

转载自blog.csdn.net/lizhenxiqnmlgb/article/details/80955072
今日推荐
周排行
Leetcode简单题61~80
解决zookeeper磁盘IO高的问题
多线程相关方法详解
Maven-setting.xml文件详解
Maven 项目的 classpath 理解
渊亭科技大数据笔试题
配置JVM内存分配
计算机网络个人学习笔记 （三）网络层 ：第三部分 连载
js中两个等号(==)和三个等号(===)的区别
用C程序自动打开电脑上的程序
每日归档
更多
2024-09-18(0)
2024-09-17(0)
2024-09-16(0)
2024-09-15(0)
2024-09-14(0)
2024-09-13(0)
2024-09-12(0)
2024-09-11(0)
2024-09-10(0)
2024-09-09(0)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022