DataSet数据集简介
DataSet主要用于管理所有的自定义数据集,任何需要存储数据的地方都可以定义为自定义数据集,包括预制的配置文件、运行时生成的动态数据、从后台拉取的各种数据等。
数据集的使用策略是:新建数据集(加载数据集配置文件) => 存入数据集仓库(可选) => 从仓库提取数据集(可选) => 使用数据集。
使用DataSet数据集
自定义数据集
自定义数据集,需满足以下条件:
1.继承至DataSetBase
2.标记特性System.Serializable
3.标记特性UnityEngine.CreateAssetMenu
注意:因为DataSet是继承至ScriptableObject类,标记Serializable和CreateAssetMenu特性主要是为了使其能够在编辑器内直接创建配置文件。
推荐使用快捷创建方式:
Project界面右键 -> Create -> HTFramework -> C# DataSet Script
如下,自定义了一个用于存储音乐配置的数据集:
/// <summary>
/// 音乐数据
/// </summary>
[Serializable]
[CreateAssetMenu(menuName = "HTFramework DataSet/音乐配置")]
public class AudioDataSet : DataSetBase
{
/// <summary>
/// 背景音乐
/// </summary>
public AudioClip BGMusic;
/// <summary>
/// 通过Json数据填充数据集
/// </summary>
public override void Fill(JsonData data)
{
}
/// <summary>
/// 将数据集打包为Json数据
/// </summary>
public override JsonData Pack()
{
JsonData data = new JsonData();
return data;
}
}
新建数据集:配置文件
CreateAssetMenu特性会提供一个Create菜单的创建路径,通过它可以直接创建数据集的配置文件:
如下,我们创建一个数据集的配置文件:
新建数据集:动态数据
动态创建的数据集不会序列化下来,他跟普通的实例一样会被GC回收,创建数据集时可以直接创建,也可以通过服务器拉取的Json数据来构建。
//新建一条数据集,并保存至仓库
Main.m_DataSet.CreateDataSet<AudioDataSet>();
JsonData json;
//新建一条AudioDataSet数据集,使用json数据初始化
Main.m_DataSet.CreateDataSet<AudioDataSet>(json);
提取并使用数据集
提取数据集:
AudioDataSet dataSet;
List<AudioDataSet> dataSets;
//根据先后顺序提取一条数据集,如果该数据集只有全局唯一一条,建议使用此方法
dataSet = Main.m_DataSet.GetDataSet<AudioDataSet>();
//根据先后顺序提取一条数据集,并将之从仓库中移除
dataSet = Main.m_DataSet.GetDataSet<AudioDataSet>(true);
//根据索引提取一条数据集
dataSet = Main.m_DataSet.GetDataSet<AudioDataSet>(0);
//根据匹配条件提取第一条满足条件的数据集
dataSet = Main.m_DataSet.GetDataSet<AudioDataSet>((d) =>
{
return d.BGMusic != null;
});
//根据匹配条件提取所有满足条件的数据集
dataSets = Main.m_DataSet.GetAllDataSets<AudioDataSet>((d) =>
{
return d.BGMusic != null;
});
//提取所有数据集
dataSets = Main.m_DataSet.GetAllDataSets<AudioDataSet>();
使用数据集:
AudioDataSet dataSet;
//根据先后顺序提取一条数据集
dataSet = Main.m_DataSet.GetDataSet<AudioDataSet>();
//播放背景音乐
Main.m_Audio.PlayBackgroundMusic(dataSet.BGMusic);
运行时检视面板
在编辑器中运行时将会出现运行时检视面板(Runtime Data),主要用以调试或数据监测,目前面板如下:
1.显示当前数据集仓库中的所有数据集数量。