PropertyDatabase

描述

PropertyDatabase 是一个系统，它可以以线程安全的方式将不同类型的属性存储到我们称为属性数据库的单个文件中。

PropertyDatabase 的理念是，大多数情况下，获取属性值可能代价高昂。因此，缓存这些值以便以后重用可以节省大量的周期。缓存存储在文件中，因此在域重新加载或退出 Unity 时不会丢失（并非所有类型都可以在文件中序列化，但它们仍然可以存储在 PropertyDatabase 中，请参阅 PropertyDatabase.IsPersistedType）。您可以在不同的文件上打开多个 PropertyDatabase，但不能在单个文件上打开多个 PropertyDatabase。这样做会导致无效的 PropertyDatabase（请参阅 valid）。您可以在 PropertyDatabase 的单个实例上执行并发操作，但出于性能原因，您应该使用视图（请参阅 PropertyDatabase.GetView 和 IPropertyDatabaseView）。

您可以使用 PropertyDatabase 执行三种主要操作：存储值、加载值和使值无效。存储值时，值将存储在数组中，并按其键排序（请参阅 PropertyDatabase.CreateRecordKey 和 PropertyDatabaseRecordKey。键是一个表示文档和属性的数字。您可以将来自 PropertyDatabase 中任何位置的任何值存储在其中，但最常见的用例是存储资产或游戏对象的属性。在这些情况下，资产或游戏对象将是文档，属性是您要存储的该文档上的任何属性。然后，您可以稍后加载这些值，无论是单个属性还是整个文档。

using System.Collections.Generic;
using NUnit.Framework;
using UnityEditor;
using UnityEditor.Search;
using UnityEngine;

static class Example_PropertyDatabase
{
    // Where the property database will be written.
    const string propertyDatabaseFilePath = "Temp/test_property_db";

    static PropertyDatabase propertyDatabase;

    static void InitializePropertyDatabase()
    {
        // Setup the property database. We configure it with automatic flushing so the file store
        // will be updated automatically after an update.
        propertyDatabase = new PropertyDatabase(propertyDatabaseFilePath, true);
    }

    static void ClearPropertyDatabase()
    {
        propertyDatabase.Clear();

        // Since we are done with the property database, we should dispose it
        // to clear all resources.
        propertyDatabase.Dispose();
    }

    static PropertyDatabaseRecordKey GetPropertyKey(int id)
    {
        return PropertyDatabase.CreateRecordKey((ulong)id / 100, PropertyDatabase.CreatePropertyHash((id % 100).ToString()));
    }

    static object LoadPropertyValue(int id)
    {
        var recordKey = GetPropertyKey(id);
        if (propertyDatabase.TryLoad(recordKey, out object value))
            return value;

        // Fetch the value with the time consuming operation and store it for future
        // accesses.
        value = id.ToString();
        propertyDatabase.Store(recordKey, value);
        return value;
    }

    [MenuItem("Examples/PropertyDatabase/Class")]
    public static void RunExample()
    {
        InitializePropertyDatabase();
        if (!propertyDatabase.valid)
        {
            Debug.LogFormat(LogType.Error, LogOption.NoStacktrace, null, $"PropertyDatabase \"{propertyDatabase.filePath}\" failed to open properly.");
            return;
        }

        var allValues = new Dictionary<int, object>();
        // Load the property values to do something with it.
        for (var i = 0; i < 1000; ++i)
        {
            var value = LoadPropertyValue(i);
            allValues.Add(i, value);
        }

        // Validate everything is in the database
        for (var i = 0; i < 1000; ++i)
        {
            var key = GetPropertyKey(i);
            if (!propertyDatabase.TryLoad(key, out object value))
                Assert.Fail("Record should be in the database.");
            Assert.AreEqual(i.ToString(), value);
        }

        ClearPropertyDatabase();
    }
}

如果属性或整个文档发生更改，您可以使用 PropertyDatabase.Invalidate 和 PropertyDatabase.InvalidateMask 使存储的值无效。

属性

构造函数

公共方法

静态方法