Merge pull request #2 from Machillka/features/objectpool

feature: ObjectPool

Author: Machillka

Assets/Framework/Scripts/Infra.meta

@@ -0,0 +1,72 @@
+using UnityEngine;
+using UnityEngine.Pool;
+using System.Collections;
+
+namespace Framework.Utilities.ObjectPool
+{
+    public class GameobjectPool : IObjectPool<GameObject>
+    {
+        private readonly ObjectPool<GameObject> _pool;
+        private readonly Transform _parent;
+        private readonly GameObject _prefab;
+        private readonly int _initializedSize;
+        private readonly int _maxSize;
+
+        public int InitializedSize => _initializedSize;
+
+        public int MaxSize => _maxSize;
+
+        /// <summary>
+        /// 仅提供预制体和父节点
+        /// </summary>
+        /// <param name="parent"></param>
+        /// <param name="prefab"></param>
+        /// <param name="initializedSize"></param>
+        /// <param name="maxSize"></param>
+        public GameobjectPool(Transform parent, GameObject prefab, int initializedSize, int maxSize)
+        {
+            _parent = parent;
+            _prefab = prefab;
+            _initializedSize = initializedSize;
+            _maxSize = maxSize;
+
+            _pool = new ObjectPool<GameObject>(
+                createFunc: () => Object.Instantiate(_prefab, _parent),
+                actionOnGet: go => { if (go != null) go.SetActive(true); },
+                actionOnRelease: go => { if (go != null) { go.SetActive(false); go.transform.SetParent(_parent); } },
+                actionOnDestroy: obj => { if (obj != null) Object.Destroy(obj); },
+                collectionCheck: false,
+                defaultCapacity: initializedSize,
+                maxSize: maxSize
+            );
+        }
+
+        public GameObject Create()
+        {
+            return _pool.Get();
+        }
+
+        public void Clear()
+        {
+            _pool.Clear();
+        }
+
+        public void Destroy(GameObject obj)
+        {
+            if (obj != null)
+                Object.Destroy(obj);
+        }
+
+        public GameObject Get()
+        {
+            return _pool.Get();
+        }
+
+        // NOTE: 实现一个回调函数, 实现 After Get
+
+        public void Release(GameObject obj)
+        {
+            _pool.Release(obj);
+        }
+    }
+}

Assets/Framework/Scripts/Utilities/ObjectPool/GameObjectPool.cs

@@ -2,8 +2,13 @@ namespace Framework.Utilities.ObjectPool
 {
     public interface IObjectPool<T>
     {
+        int InitializedSize { get; }
+        int MaxSize { get; }
+
         T Get();
+        T Create();
         void Release(T obj);
+        void Destroy(T obj);
         void Clear();
     }
 }

Assets/Framework/Scripts/Utilities/ObjectPool/GameObjectPool.cs.meta

@@ -0,0 +1,14 @@
+using UnityEngine;
+
+namespace Framework.Utilities.ObjectPool
+{
+    /// <summary>
+    /// 工厂方法, 用于管理所有的对象池
+    /// </summary>
+    public interface IPoolManager
+    {
+        IObjectPool<T> GetPool<T>(string key = null) where T : class;
+        IObjectPool<T> CreatePool<T>(string key, IObjectPool<T> pool);
+        bool TryRelease<T>(T item) where T : class;
+    }
+}

Assets/Framework/Scripts/Utilities/ObjectPool/IObjectPool.cs

@@ -0,0 +1,56 @@
+using System.Collections.Generic;
+using Framework.Core.Service;
+using UnityEngine;
+
+namespace Framework.Utilities.ObjectPool
+{
+    [Service]
+    public class PoolManager : IPoolManager
+    {
+        private readonly Dictionary<string, object> pools = new();
+
+        public IObjectPool<T> CreatePool<T>(string key, IObjectPool<T> pool)
+        {
+            if (pools.ContainsKey(Hash(key)))
+            {
+                Debug.LogWarning($"Pool already exists for key:{key}");
+                return pool;
+            }
+
+            pools.Add(Hash(key), pool);
+
+            return pool;
+        }
+
+        public IObjectPool<T> GetPool<T>(string key = null) where T : class
+        {
+            if (pools.TryGetValue(Hash(key), out var p))
+                return (IObjectPool<T>)p;
+            return null;
+        }
+
+        // 自动匹配类型, 尝试释放对象到对应池子
+        public bool TryRelease<T>(T item) where T : class
+        {
+            foreach (var p in pools.Values)
+            {
+                if (p is IObjectPool<T> pool)
+                {
+                    pool.Release(item);
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /// <summary>
+        /// 是否要做一层key的映射？使得出现不同类型的池子但是可以有相同名字
+        /// </summary>
+        /// <param name="key"></param>
+        /// <returns></returns>
+        public string Hash(string key)
+        {
+            return key;
+        }
+    }
+}

Assets/Framework/Scripts/Utilities/ObjectPool/IPoolManager.cs

@@ -0,0 +1,54 @@
+using UnityEngine;
+using NUnit.Framework;
+using Framework.Core.Service;
+using Framework.Utilities.ObjectPool;
+
+namespace Tests
+{
+    public class PoolManagerTests
+    {
+        public GameObject prefab;
+        public GameObject parent;
+        public ServiceLocator serviceManager;
+
+        [SetUp]
+        public void SetUp()
+        {
+            prefab = new GameObject("TestPrefab");
+            serviceManager = new();
+            parent = new GameObject("TestParent");
+            serviceManager.RegisterSingleton(serviceManager);
+        }
+
+        [Test]
+        public void CreateAndGetPool_Works()
+        {
+            var poolManager = serviceManager.Resolve<PoolManager>();
+            var pool = new GameobjectPool(parent.transform, prefab, 5, 20);
+            var returnedPool = poolManager.CreatePool("TestPool", pool);
+            Assert.AreEqual(pool, returnedPool);
+            var fetchPool = poolManager.GetPool<GameObject>("TestPool");
+            Assert.AreEqual(pool, fetchPool);
+        }
+
+        [Test]
+        public void PoolOperation_Works()
+        {
+            var poolManager = serviceManager.Resolve<PoolManager>();
+            var pool = new GameobjectPool(parent.transform, prefab, 5, 20);
+            poolManager.CreatePool("Op", pool);
+            var obj = pool.Get();
+            Assert.IsNotNull(obj);
+            pool.Release(obj);
+
+            var tryReleaseOut = poolManager.TryRelease(obj);
+            Assert.IsTrue(tryReleaseOut);
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            Object.DestroyImmediate(prefab);
+        }
+    }
+}