XRLib/Assets/Scripts/UVC/Pool/MonoBehaviourPool.cs

#nullable enable
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
using UnityEngine.InputSystem;

namespace UVC.Pool
{
    /// <summary>
    /// MonoBehaviour를 상속받는 컴포넌트의 오브젝트 풀링을 관리하는 제네릭 클래스입니다.
    /// 오브젝트 풀링은 오브젝트를 반복적으로 생성하고 파괴하는 데 드는 비용을 줄여 성능을 향상시키는 데 사용됩니다.
    /// 사용하지 않는 오브젝트를 비활성화하여 보관했다가 필요할 때 재사용합니다.
    /// 
    /// 사용 예:
    /// <code>
    /// public class BulletManager : MonoBehaviour
    /// {
    ///     public GameObject bulletPrefab;
    ///     public Transform bulletContainer;
    ///     private MonoBehaviourPool&lt;Bullet&gt; _bulletPool;
    /// 
    ///     void Start()
    ///     {
    ///         // 총알 프리팹과 부모 컨테이너를 사용하여 풀을 초기화합니다.
    ///         _bulletPool = new MonoBehaviourPool&lt;Bullet&gt;(bulletPrefab, bulletContainer);
    ///     }
    /// 
    ///     void SpawnBullet()
    ///     {
    ///         // 풀에서 총알을 가져와 사용합니다.
    ///         Bullet bullet = _bulletPool.GetItem();
    ///         bullet.transform.position = transform.position;
    ///         bullet.Fire();
    ///     }
    /// 
    ///     public void ReturnBulletToPool(Bullet bullet)
    ///     {
    ///         // 사용이 끝난 총알을 풀에 반환합니다.
    ///         _bulletPool.ReturnItem(bullet);
    ///     }
    /// }
    /// </code>
    /// </summary>
    /// <typeparam name="T">풀링할 MonoBehaviour 타입입니다.</typeparam>
    public class MonoBehaviourPool<T> where T : MonoBehaviour
    {
        /// <summary>
        /// Resources 폴더에 있는 프리팹의 경로입니다.
        /// </summary>
        protected string _prefabsPath = "";
        /// <summary>
        /// 새로운 오브젝트를 생성할 때 사용할 원본 프리팹입니다.
        /// </summary>
        protected GameObject _originalPrefab;

        /// <summary>
        /// 활성화된(사용 중인) 오브젝트들을 담아둘 부모 Transform입니다.
        /// </summary>
        protected Transform _activeItemContainer;

        /// <summary>
        /// 재활용(비활성화된) 오브젝트들을 담아둘 부모 Transform입니다.
        /// </summary>
        protected Transform? _recycledItemContainer;

        /// <summary>
        /// 현재 활성화되어 사용 중인 아이템을 저장하는 딕셔너리입니다. (Key: 아이템 고유 키, Value: 아이템 인스턴스)
        /// </summary>
        protected Dictionary<string, T> _activeItems = new Dictionary<string, T>();

        /// <summary>
        /// 재활용을 위해 비활성화된 아이템 리스트입니다.
        /// </summary>
        protected List<T> _recycledItems = new List<T>();

        /// <summary>
        /// 현재 활성화된 아이템들의 딕셔너리를 읽기 전용으로 가져옵니다.
        /// </summary>
        public IReadOnlyDictionary<string, T> ActiveItems => _activeItems;

        /// <summary>
        /// 활성화된 아이템들의 부모 컨테이너를 가져옵니다.
        /// </summary>
        public Transform ActiveItemContainer { get { return _activeItemContainer; } }

        /// <summary>
        /// 재활용 아이템들의 부모 컨테이너를 가져옵니다.
        /// </summary>
        public Transform? RecycledItemContainer { get { return _recycledItemContainer; } }

        /// <summary>
        /// GameObject 프리팹을 사용하여 풀을 초기화합니다.
        /// </summary>
        /// <param name="originalPrefab">풀링할 오브젝트의 원본 프리팹입니다.</param>
        /// <param name="activeItemContainer">활성화된 오브젝트가 위치할 부모 Transform입니다.</param>
        /// <param name="recycledItemContainer">비활성화된 오브젝트가 위치할 부모 Transform입니다. 지정하지 않으면 activeItemContainer가 사용됩니다.</param>
        public MonoBehaviourPool(GameObject originalPrefab, Transform activeItemContainer, Transform recycledItemContainer = null)
        {
            _originalPrefab = originalPrefab;
            _activeItemContainer = activeItemContainer;
            _recycledItemContainer = recycledItemContainer;

            if (recycledItemContainer == null) _recycledItemContainer = _activeItemContainer;
        }

        /// <summary>
        /// Resources 폴더 내의 프리팹 경로를 사용하여 풀을 초기화합니다.
        /// </summary>
        /// <param name="prefabsPath">Resources 폴더 기준의 프리팹 경로입니다.</param>
        /// <param name="activeItemContainer">활성화된 오브젝트가 위치할 부모 Transform입니다.</param>
        /// <param name="recycledItemContainer">비활성화된 오브젝트가 위치할 부모 Transform입니다. 지정하지 않으면 activeItemContainer가 사용됩니다.</param>
        public MonoBehaviourPool(string prefabsPath, Transform activeItemContainer, Transform recycledItemContainer)
        {
            _prefabsPath = prefabsPath;
            _originalPrefab = Resources.Load<GameObject>(prefabsPath);
            _activeItemContainer = activeItemContainer;
            _recycledItemContainer = recycledItemContainer;
            if (recycledItemContainer == null) _recycledItemContainer = _activeItemContainer;
        }

        /// <summary>
        /// 풀에서 아이템을 가져와 지정된 키와 연결합니다.
        /// </summary>
        /// <param name="key">아이템을 식별할 고유 키입니다.</param>
        /// <param name="autoSetParent">true일 경우, 아이템의 부모를 자동으로 ActiveItemContainer로 설정합니다.</param>
        /// <param name="parent">autoSetParent가 true일 때, 아이템의 부모를 지정된 Transform으로 설정합니다.</param>
        /// <returns>활성화된 아이템의 T 컴포넌트입니다. 키가 이미 존재하면 null을 반환합니다.</returns>
        public T? GetItem(string key, bool autoSetParent = true, Transform? parent = null)
        {
            if (_activeItems.ContainsKey(key))
            {
                return _activeItems[key];
            }

            T? item = null;
            if (_recycledItems.Count > 0)
            {
                item = _recycledItems[0];
                _recycledItems.RemoveAt(0);
            }
            else
            {
                GameObject go = UnityEngine.Object.Instantiate(_originalPrefab);
                item = go.GetComponent<T>();
            }

            item.gameObject.SetActive(true);
            if (autoSetParent)
            {
                if (parent != null)
                {
                    item.transform.SetParent(parent, false);
                }
                else if (_activeItemContainer != null)
                {
                    item.transform.SetParent(_activeItemContainer, false);
                }
            }

            _activeItems.Add(key, item);
            return item;
        }

        /// <summary>
        /// 키를 사용하여 활성화된 아이템을 풀에 반환합니다.
        /// </summary>
        /// <param name="key">반환할 아이템의 고유 키입니다.</param>
        /// <param name="clearParent">true일 경우, 아이템의 부모를 RecycledItemContainer로 설정합니다.</param>
        public void ReturnItem(string key, bool clearParent = false)
        {
            if (!_activeItems.TryGetValue(key, out T item))
            {
                return; // 키에 해당하는 아이템이 없으면 반환
            }

            _activeItems.Remove(key);
            _recycledItems.Add(item);

            if (clearParent)
            {
                if (item.gameObject.activeInHierarchy && _recycledItemContainer != null)
                {
                    item.transform.SetParent(_recycledItemContainer, false);
                }
            }
            item.gameObject.SetActive(false);
        }

        /// <summary>
        /// 키를 사용하여 활성화된 아이템을 찾습니다.
        /// </summary>
        /// <param name="key">찾을 아이템의 고유 키입니다.</param>
        /// <returns>키에 해당하는 아이템. 없으면 null을 반환합니다.</returns>
        public T? FindActiveItem(string key)
        {
            _activeItems.TryGetValue(key, out T item);
            return item;
        }

        /// <summary>
        /// 현재 활성화된 모든 아이템을 풀에 반환합니다.
        /// </summary>
        public void ReturnAll()
        {
            // ToList()를 사용하여 키 컬렉션의 복사본을 만들어 순회 중 변경 문제를 방지합니다.
            foreach (var key in _activeItems.Keys.ToList())
            {
                ReturnItem(key);
            }
        }

        /// <summary>
        /// 재활용 중인 모든 아이템을 파괴하여 메모리에서 완전히 제거합니다.
        /// </summary>
        public void ClearRecycledItems()
        {
            if (_recycledItems == null)
                return;

            foreach (var item in _recycledItems)
            {
                if (item != null)
                    UnityEngine.Object.Destroy(item.gameObject);
            }
            _recycledItems.Clear();
        }
    }
}